利用時間の上限の通知を設定する

ここに表示されているのは Apigee Edge のドキュメントです。
Go to the Apigee X のドキュメントに移動します。 info

はじめに

Monetization Limits Check ポリシーを使用して収益化の上限を適用する で説明されているように、収益化関連の上限を設定できます。また、上限に近づいた場合や上限に達した場合に、デベロッパー や組織内のユーザーにアラートを通知する自動通知を設定することもできます。

カスタム上限と暗黙的な上限の両方に対して自動通知を設定できます。たとえば、システムは前払いデベロッパーに対して、前払い 残高という暗黙的な上限を設定します。前払い残高に近づいた場合やプリペイド残高に達した場合にデベロッパーに通知されるように、自動通知を設定できます。

ツールボックス

上限に対する自動通知は、管理 UI または収益化 API を使用して設定できます。 UI を使用する場合は、[Notifications] ページで自動通知を設定します。

API を使用する場合は、収益化によって提供される通知 テンプレートを編集して、上限に対する自動通知を設定します。次に、編集したテンプレートによって提供される 通知を送信する条件を指定します。

UI を使用して上限通知を設定する

  1. [Add Limit] ページの [Notifications] セクションで [Add] をクリックします。[Notification] セクションが開きます。

  2. 通知のレベルを選択します。これは、上限基準の絶対数または 割合に基づくしきい値です。次のいずれかを選択します。
    • プルダウン メニューから、以上記号（?）または以下記号（?）。
    • 整数（小数点以下なし）。絶対値（数値を示す）または 割合（割合を示す）。割合の上限の場合は、必ず上限を > に設定してください。これは、デベロッパーがその割合レベルに達したとき、またはその割合レベルを超えたときに通知が送信されることを意味します。

    たとえば、費用の上限を $100 に設定し、通知を 90% 以上に設定した場合、上限の 90%（$90）に達したとき、または超えたときに通知が送信されます。

  3. [Send Email] フィールドで、1 人以上のデベロッパーを選択するか、組織内の 1 人以上のユーザーを選択します。影響を受けるデベロッパーまたはユーザーに通知が送信されます。

    メールの受信者: デベロッパーへの通知を送信できるのは、デベロッパーの上限条件を [Any] に設定した場合、または特定のデベロッパーでデベロッパーの上限条件を設定した場合のみです。[Any] を選択すると、メールアドレスのリストに [Selected developer (Any)] が表示されます。これは、収益化によって影響を受けるすべての デベロッパーに通知が送信されることを意味します。特定のデベロッパーを選択すると、メールアドレスのリストに [Selected developer ({developer_id})] が表示されます（ {developer_id} は選択したデベロッパーの ID です）。収益化 によって、その特定のデベロッパーにのみ通知が送信されます。

    デベロッパーの上限条件として [Any] または特定のデベロッパーを選択しなかった場合、デベロッパーの上限条件として [Any] または特定のデベロッパーを選択しなかった場合、 [Send Email] フィールドに [Selected developer (Any)] は表示されません。ただし、通知する組織のユーザーを選択できます 。

    組織のユーザーのメールアドレスを追加するには、[Admin] タブで [Organization Users] を選択します。

    メールテンプレート: [Send Email] フィールドで [Selected developer (Any)] または組織内のユーザーのメールアドレス（またはその両方）を選択すると、メールテンプレートが表示されます。テンプレートに表示される内容は、次の条件によって異なります。

    • 通知のレベル。
    • 上限が実行停止の上限かどうか。
    • メールが組織のユーザー、デベロッパー、またはその両方宛てかどうか。

    たとえば、次のすべてに該当する場合、

    • [Halt execution] チェックボックスがオンになっている。
    • 通知のレベルが 100% または上限と同じ金額である。
    • メールは組織のユーザーのみ宛てである。

    テンプレートは次のようになります。

    デベロッパーの会社名が「XYZ company」、トランザクション数の上限が「X Package」という API パッケージと「Y Product」という 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

    メールが [Selected developer (Any)] 宛ての場合、テンプレートは次のようになります。

    どちらのテンプレートでも、デベロッパー名（該当する場合）、 パッケージ名（該当する場合）、プロダクト名（該当する場合）などの関連する変数が解決されます。テンプレートの左側にある [Edit] をクリックして、要件に合わせてメッセージを編集できます。

    上限が [Any] または特定のアプリケーションと [Any] または特定のユーザーの場合、アプリケーションとユーザーの変数をテンプレートに追加する必要があります。手順は次のとおりです。

    • テンプレートの左側にある [Edit] をクリックします。
    • ${user.name} user, depending on whether the limit is for application and/or user. を追加します。

    [Any] または特定のアプリケーション用に編集されたテンプレートを以下に示します。

    [Halt execution] がオンになっていない場合、または通知レベルが 100% 以上の場合は、選択したデベロッパーのテンプレートは次のようになります。

    繰り返しになりますが、上限が [Any]（または特定の）アプリケーション、または [Any]（または特定の） ユーザーの場合は、テンプレートを編集し、上限がアプリケーション、 ユーザー、またはその両方であるかに応じて、${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. 必要に応じて、追加のレベルの通知を追加します。追加のレベルごとに、[Add] をクリックします。 これにより、 ページの [Notifications] セクションに [Level]、[Send email]、[Email template] 領域が追加されます。通知には最大 6 つのレベルを追加できます。たとえば、通知を > 70%、80%、90%、100% に設定すると、これらの レベルに達するたびに通知が送信されます。
  5. すべての通知を追加したら、[Save]（後で通知を保存して公開する）、[Save and Publish]（今すぐ公開する）、[Cancel]（キャンセルする）のいずれかをクリックします。

API を使用して上限通知を設定する

収益化には、上限通知や、新しいプロダクトの提供についてデベロッパーに通知するアドホック通知など、さまざまな種類の通知のテキストを提供するテンプレートが用意されています。これらのテンプレートは、ニーズに合わせてカスタマイズできます。 上限の自動通知を設定するには、まず適切なテンプレートを編集します。次に、編集したテンプレートによって提供される通知を送信する条件を指定します。詳細については、通知テンプレートを使用して 通知を設定するをご覧ください。

次のステップ

新しいプロダクト、T&C の新しいバージョン、新しい料金プランなどのイベントをデベロッパーに通知できるように、自動通知を設定する方法について説明します。通知テンプレートを使用して通知を設定するをご覧ください。