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

現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報

はじめに

収益化の上限チェックポリシーを使用した収益化の上限の適用の説明に従って、収益化に関連する上限を設定できます。上限に近づくか上限に達したときに、デベロッパーや組織内のユーザーに警告する自動通知を設定することもできます。

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

ツールボックス

管理 UI または Monetization API を使用して、制限の自動通知を設定できます。UI を使用する場合は、[通知] ページで自動通知を設定します。

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

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

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

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

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

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

    メール受信者: デベロッパーの制限条件を [すべて] に設定するか、特定のデベロッパーに対してデベロッパーの制限の条件を設定した場合のみ、デベロッパーに通知を送信できます。[すべて] を選択した場合は、メールアドレスのリストに [選択したデベロッパー（すべて）] と表示されます。つまり、収益化によって影響を受けるデベロッパーに通知が送信されます。特定のデベロッパーを選択した場合は、メールアドレスのリストに「選択したデベロッパー（{developer_id}）」と表示されます（{developer_id} は選択したデベロッパーの ID です）。Monetization は、その特定のデベロッパーにのみ通知を送信します。

    デベロッパーの制限条件として [すべて] を選択していない場合、または特定のデベロッパーを選択していない場合は、[メールを送信] フィールドに [選択したデベロッパー（すべて）] は表示されません。ただし、どの組織のどのユーザーに通知するかは選択できます。

    [管理] タブで [組織ユーザー] を選択すると、組織のユーザーのメールアドレスを追加できます。

    メール テンプレート: [メールを送信] フィールドで [選択したデベロッパー（すべて）]、または組織内のユーザーのメールアドレス（またはその両方）を選択すると、メール テンプレートが表示されます。テンプレートには、以下が表示されます。

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

    たとえば、以下の条件をすべて満たしているとします。

    • [Halt execution] チェックボックスがオンになっている。
    • 通知レベルは、100% または上限と同じ量になります。
    • このメールは組織のユーザーのみを対象としています。

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

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

    メールが [選択したデベロッパー（すべて）] の場合、テンプレートは次のようになります。

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

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

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

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

    [実行を中止] チェックボックスがオフの場合、または通知レベルが 100% 以上の場合、選択したデベロッパーのテンプレートは次のようになります。

    ここでも、上限が「すべて」（または特定の）アプリケーションまたは「すべて」（または特定の）ユーザーに対するものである場合は、上限がアプリケーション、ユーザー、またはその両方かに応じて、テンプレートを編集してから ${application.name} アプリケーションまたは ${user.name} ユーザーを追加する必要があります。

    テンプレート変数: メール テンプレートのメッセージを編集する際に、次の変数を含めることができます。

    変数 Description
    ${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. レベルに応じて、必要に応じて通知を追加します。追加するレベルごとに [追加] をクリックします。 これにより、ページの [Notifications] セクションに、[Level]、[Send email]、[Email template] 領域が追加されます。通知のレベルは 6 つまで追加できます。たとえば、通知を > 70%、80%、90%、100% に設定すると、これらの各レベルに達したときに通知が送信されます。
  5. すべての通知を追加したら、[保存]（通知を保存して後で公開する場合）、[保存して公開]（今すぐ公開する場合）、または [キャンセル]（キャンセルする場合）をクリックします。

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

Monetization には、制限の通知や、新製品の提供状況に関するデベロッパーへのアラートなどのアドホック通知など、さまざまなタイプの通知のテキストを提供する一連のテンプレートが用意されています。これらのテンプレートは、ニーズに応じてカスタマイズできます。上限の自動通知を設定するには、まず適切なテンプレートを編集します。次に、編集したテンプレートによって提供される通知を送信する条件を指定します。詳細については、通知テンプレートを使用して通知を設定するをご覧ください。

次のステップ

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