시간 제한 알림 설정

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동 정보

소개

수익 창출 한도 확인 정책을 사용하여 수익 창출 제한 시행에 설명된 대로 수익 창출 관련 한도를 설정할 수 있습니다. 한도에 가까워지거나 도달하면 조직의 개발자나 사용자에게 알림을 보내도록 자동 알림을 설정할 수도 있습니다.

맞춤 제한과 암시적 제한에 대해 자동 알림을 설정할 수 있습니다. 예를 들어 시스템은 선불 개발자의 암시적 한도, 즉 선불 잔액을 설정합니다. 자동 알림을 설정하면 개발자에게 선불 금액에 근접하거나 한도에 도달했을 때 알림을 받을 수 있습니다.

도구 상자

관리 UI 또는 수익 창출 API를 사용하여 한도에 대한 자동 알림을 설정할 수 있습니다. UI를 사용하는 경우 알림 페이지에서 자동 알림을 설정합니다.

API를 사용하는 경우 수익 창출에서 제공하는 알림 템플릿을 수정하여 한도에 대한 자동 알림을 설정합니다. 그런 다음 수정된 템플릿에서 제공하는 알림을 전송하는 조건을 지정합니다.

UI를 사용하여 제한 알림 설정

  1. 제한 추가 페이지의 알림 섹션에서 추가를 클릭합니다. 그러면 알림 섹션이 열립니다.

  2. 알림 수준을 선택합니다. 절댓값 또는 한도 기준의 백분율을 기반으로 하는 기준점입니다. 다음 중 하나를 선택합니다.
    • 드롭다운 메뉴에 있는 보다 크거나 같음 (?) 또는 작거나 같음 (?)입니다.
    • 정수입니다 (소수점 이하 자릿수). 절대 (숫자 값을 나타내려면) 또는 백분율로 백분율 값을 나타냅니다. 비율 제한의 경우 항상 제한을 >로 설정해야 합니다. 즉, 개발자가 해당 비율 수준에 도달하거나 이를 초과할 때 알림이 전송됩니다.

    예를 들어 지출 한도를 $100로 설정하고 알림을 90% 이상으로 설정하면 한도의 90%($90)에 도달하거나 이를 초과하면 알림이 전송됩니다.

  3. 이메일 보내기 필드에서 한 명 이상의 개발자를 선택하거나 조직 내 한 명 이상의 사용자를 선택합니다. 영향을 받는 개발자나 사용자에게 알림이 전송됩니다.

    이메일 수신자: 개발자 한도 조건을 '모두'로 설정하거나 특정 개발자에게 개발자 제한 조건을 설정한 경우에만 개발자에게 알림을 보낼 수 있습니다. '모두'를 선택하면 이메일 주소 목록에 '선택한 개발자 (모두)'가 표시됩니다. 즉, 수익 창출에서 영향을 받는 모든 개발자에게 알림을 전송합니다. 특정 개발자를 선택한 경우 이메일 주소 목록에 '선택된 개발자({developer_id})'가 표시됩니다. 여기서 {developer_id}는 선택한 개발자의 ID입니다. 수익 창출에서는 해당 개발자에게만 알림을 보냅니다.

    개발자 제한 조건을 '모두' 또는 특정 개발자로 선택하지 않았다면 이메일 보내기 필드에 '선택한 개발자 (모두)'가 표시되지 않습니다. 그러나 알림을 보낼 조직의 사용자를 선택할 수 있습니다.

    관리 탭에서 조직 사용자를 선택하여 조직 사용자의 이메일 주소를 추가할 수 있습니다.

    이메일 템플릿: 이메일 보내기 필드에서 '선택된 개발자 (모든)' 또는 조직 내 사용자의 이메일 주소 (또는 둘 다)를 선택하면 이메일 템플릿이 표시됩니다. 템플릿에 표시되는 내용은 다음에 따라 다릅니다.

    • 알림 수준입니다.
    • 해당 제한이 실행 중지 제한인지 여부입니다.
    • 조직 사용자, 개발자 또는 둘 다용 이메일인지 여부

    예를 들어 다음 사항이 모두 해당되는 경우

    • 실행 중지 체크박스가 선택되어 있습니다.
    • 알림 수준은 100% 또는 한도와 동일합니다.
    • 조직 사용자만 사용할 수 있는 이메일입니다.

    템플릿은 다음과 같이 표시됩니다.

    개발자의 회사 이름이 'XYZ 회사'이고 이름이 'X 패키지'인 API 패키지와 'Y 제품'이라는 API 제품의 거래량 한도가 50으로 설정되었으며, 만료일은 2013년 9월 30일이라고 가정해 보겠습니다. 전송되는 이메일 메시지는 다음과 같습니다.

    Developer XYZ company has exceeded their transaction volume limit of 50 transactions for X package, Y product. Their API calls will be blocked till 2013-09-30

    '선택한 개발자 (모두)'에게 이메일이 전송된 경우 템플릿은 다음과 같이 표시됩니다.

    두 템플릿 모두 개발자 이름 (해당하는 경우), 패키지 이름 (해당하는 경우), 제품 이름 (해당하는 경우)과 같은 관련 변수를 결정합니다. 템플릿 왼쪽에 있는 '수정'을 클릭하여 요구사항을 충족하도록 메시지를 수정할 수 있습니다.

    한도가 '모두' 또는 특정 애플리케이션과 '모두' 또는 특정 사용자에 적용되는 경우 애플리케이션 및 사용자의 변수도 템플릿에 추가해야 합니다. 방법은 다음과 같습니다.

    • 템플릿 왼쪽에 있는 '수정'을 클릭합니다.
    • ${user.name} user, depending on whether the limit is for application and/or user. 추가

    다음은 '모두' 또는 특정 애플리케이션에 맞게 수정된 템플릿입니다.

    실행 중지가 선택되지 않았거나 알림 수준이 100% 이상인 경우 선택한 개발자의 템플릿은 다음과 같이 표시됩니다.

    역시 제한이 '모든' (또는 특정) 애플리케이션이나 '모든' (또는 특정) 사용자에 대한 것이면 제한이 애플리케이션에 대한 것인지, 사용자 또는 둘 다에 대한 것인지에 따라 템플릿을 수정한 다음 ${application.name} 애플리케이션 또는 ${user.name} 사용자를 추가해야 합니다.

    템플릿 변수: 이메일 템플릿의 메시지를 수정할 때 다음 변수를 포함할 수 있습니다.

    변수 설명
    ${developer.name}

    개발자 이름입니다.
    ${developer.legalName}

    개발자 회사 이름입니다.
    ${ratePlan.monetizationPackage.displayName}

    API 패키지의 이름입니다.
    ${application.name}

    앱의 이름입니다.
    ${USER}

    사용자의 이름입니다.
    ${USAGE}

    현재 사용량 (총 수익 또는 청구 금액 또는 볼륨)
    ${PERCENT}

    현재 사용량에서 도달한 한도의 비율입니다.
    ${QUOTA_TYPE}

    한도 유형 (거래량, 지출 한도 또는 수수료 노출)입니다.
    ${QUOTA_UNIT}

    한도의 기본 단위: 통화 (지출 한도) 또는 호출 (거래 한도)
    ${QUOTA_LIMIT}

    한도 금액입니다.
    ${EXPIRY_DATE}

    한도가 만료되거나 재설정되는 날짜 또는 시간입니다.

    예를 들어 애플리케이션에서 어떤 패키지든 거래량의 일정 비율에 도달했을 때 알림을 받으려면 템플릿을 다음과 같이 수정하면 됩니다.

    ${developer.legalName} has reached a total volume of ${USAGE} on ${ratePlan.monetizationPackage.displayName}. This is ${PERCENT} of the daily/weekly/monthly (state period of limit as appropriate) transaction volume limit of ${QUOTA_LIMIT}.
  4. 필요에 따라 추가 등급에 대한 알림을 추가합니다. 각 추가 수준에 대해 '추가'를 클릭합니다. 그러면 레벨, 이메일 보내기, 이메일 템플릿 영역이 페이지의 알림 섹션에 추가됩니다. 알림에 최대 6개 수준을 추가할 수 있습니다. 예를 들어 알림을 70%, 80%, 90%, 100% 이상으로 설정하면 이러한 각 수준에 도달할 때 알림이 전송됩니다.
  5. 모든 알림을 추가한 후 저장 (알림을 저장하고 나중에 게시하려면 저장), 저장 및 게시 (지금 게시) 또는 취소 (취소)를 클릭합니다.

API를 사용하여 제한 알림 설정

수익 창출은 한도 알림뿐만 아니라 개발자에게 신제품의 사용 가능 여부를 알리는 등의 임시 알림을 포함하여 다양한 유형의 알림에 텍스트를 제공하는 템플릿 모음을 제공합니다. 필요에 맞게 이러한 템플릿을 맞춤설정할 수 있습니다. 자동 제한 알림을 설정하려면 먼저 적절한 템플릿을 수정하세요. 그런 다음 수정된 템플릿에서 제공하는 알림을 전송하는 조건을 지정합니다. 자세한 내용은 알림 템플릿을 사용하여 알림 설정을 참고하세요.

다음 단계

개발자에게 신제품, 새 버전의 이용약관, 새 요금제 등의 이벤트를 알릴 수 있도록 자동 알림을 설정하는 방법을 알아봅니다. 알림 템플릿을 사용하여 알림 설정을 참고하세요.