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

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント
詳細

はじめに

収益化関連の制限を設定できます。詳細については、収益化 制限チェックポリシーをご覧ください。自動通知を設定してデベロッパーに 警告を通知することもできます 上限に近づいているか達したユーザー全員に通知します。

カスタム制限や暗黙的な制限に対して自動通知を設定できます。対象 たとえば、前払いのデベロッパーに対して、 できます。自動通知を設定すると、通知を受け取ったデベロッパーに通知が届きます 前払い残高に近づいているか、発生した場合。

ツールボックス

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

API を使用する場合は、通知を編集することで、制限の自動通知を設定します。 収益化サービスが提供するテンプレートです次に、メッセージを送信する条件を 通知が送信されます。

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

  1. [制限を追加] ページの [通知] セクションで [追加] をクリックします。[通知] タブが開きます 。

  2. 通知のレベルを選択します。これは、絶対数または 割った数値です選択: <ph type="x-smartling-placeholder">
      </ph>
    • 出力値に含まれる「?」または「?」は、 選択します
    • 整数(小数点なし)。絶対(数値を示す)または パーセント値を示すパーセンテージ。パーセンテージ制限については、常に 制限は > です。つまり、デベロッパーが到達または 超えないようにすることです

    たとえば、費用の上限を 100 ドルに設定し、通知を 上限の 90%($90)に達したときに通知が送信されます。 超えています。

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

    メール受信者: デベロッパーに通知を送信できるのは、 デベロッパーの制限の条件として [すべて]デベロッパーの制限の条件を特定の 開発者です。[すべて] を選択した場合は、[選択したデベロッパー(すべて)] と表示されます。リストにある 入力します。つまり、収益化の影響を受けるすべてのユーザーに通知が送信されます。 開発できます。特定のデベロッパーを選択した場合は、[Selected developer] に ({developer_id})&quot;メールアドレスのリスト( {developer_id} は、選択したデベロッパーの ID です)。収益化 その特定のデベロッパーにのみ通知が送信されます。

    [デベロッパーの上限] の条件として [すべて] を選択していない場合特定のデベロッパーや [Selected developer (Any)] と[メールを送信] フィールドに入力します。ただし、 組織のどのユーザーに通知するかを選択します。

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

    メール テンプレート: [メールを送信] で選択すると、メール テンプレートが表示されます。 フィールド [Selected developer (Any)]またはメールアドレスを入力します。 テンプレートに表示される内容は、以下によって異なります。

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

    たとえば、次のすべてが当てはまるとします。

    • [実行を中止] チェックボックスがオンになっている。
    • 通知レベルは、100% または上限と同じ量です。
    • このメールは組織のユーザー専用です。

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

    デベロッパーの会社名が「XYZ 社」であると仮定すると、 「X Package」という名前の API パッケージに対して上限が 50 に設定されているAPI プロダクト「Y Product」 有効期限は 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)] に送られている場合、テンプレートは次のように表示されます。

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

    上限が [すべて] の場合:特定のアプリと「Any」を特定のユーザーに アプリケーションとユーザーの変数をテンプレートに追加する必要があります。これは次のようにして実行できます。 次のようになります。

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

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

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

    上限が [すべて]の場合(または特定の)アプリケーション、または「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. 必要に応じて通知を追加します。追加するレベルごとに [追加] をクリックします。 これにより、[通知] セクションに [Level]、[Send email]、[Email template] の領域が追加されます。 できます。通知のレベルは 6 つまで追加できます。たとえば、 次のユーザーとして通知 >70%、80%、90%、100% に切り替わると、これらのそれぞれが できます。
  5. すべての通知を追加したら、[保存] をクリックします(通知を保存して公開するには、 [後で公開]、[保存して公開](今すぐ公開)、[キャンセル](キャンセル)のいずれかを選択します。

API を使用した上限通知の設定

Monetization が提供する一連のテンプレートでは、収益化のさまざまなタイプのテキストが提供されています。 通知や、アラート、通知などのアドホック通知を含む 新製品のリリース状況をお知らせします。これらのテンプレートは、組織のニーズや 選択できます。自動制限通知を設定するには、まず適切なテンプレートを編集します。その後 編集したテンプレートによって提供される通知を送信する条件を指定します。 詳しくは、 通知テンプレート

次のステップ

自動通知を設定して、次のようなイベントについてデベロッパーに警告できるようにする方法をご覧ください。 新しいプロダクト、利用規約の新しいバージョン、新しい料金プランを以下を使用して通知を設定する: 通知テンプレート