通知テンプレートを使用して通知を設定する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動します。 情報

通知テンプレートとは

Monetization には、さまざまなタイプのイベント通知のサンプル テキストを定義するテンプレートのセットが用意されています。これらのテンプレートは、次のようにカスタマイズできます。

• 新しいプロダクト、T&C の新しいバージョン、新しい料金プランなどをデベロッパーに通知できます。
• 料金プランの改定などのイベントについて、影響を受けるデベロッパーに通知できます。
• デベロッパー関連のイベント（デベロッパーによるアカウントの作成や料金プランの登録など）を API プロバイダに通知できます。
• 特定のイベントについてすべての会社管理者に通知します。

または、Webhook を使用して通知を設定するで説明されているように、HTTP コールバック ハンドラを定義する Webhook を作成し、Webhook をトリガーする条件を構成することもできます。

[Notifications] ページの詳細

次の手順で [通知] ページにアクセスします。

通知の編集

UI を使用して通知を編集するには:

1. [通知] ページにアクセスします。
2. 編集する通知の横にある をクリックして、詳細を開きます。
3. 必要に応じて、[Subject]、[Body]、[Recipient]（利用可能な場合）の各フィールドを編集します。

   通知テンプレート内で指定できる変数については、通知テンプレートで変数を使用するをご覧ください。

   各カテゴリの通知を編集する方法については、以下のセクションを参照してください。

   • [Notify All Developers]（すべてのデベロッパーに通知）に通知を編集する
   • 影響を受けるデベロッパーに通知するための通知の編集
   • API プロバイダに通知するよう通知を編集する
4. 通知を有効にするには、横にあるチェックボックスをオンにします。
5. 通知を追加で編集するには、手順 2 ～ 4 を繰り返します。
6. [保存] をクリックして、すべての変更を保存します。

通知が保存されたことを確認するメッセージが表示されます。保存処理には数分かかることがあります。

通知を編集してすべてのデベロッパーに通知

[Notify All Developers] セクションで選択したイベントタイプの通知は、すべてのデベロッパーに送信されます。

通知は 1 日の終わりに実行されるようにスケジュールされています。通知が送信されると、イベントのチェックボックスは自動的にオフになります。関連するイベントタイプの通知をスケジュールするには、再度選択する必要があります。

次の表に、[Notify All Developers] セクションのイベントタイプに基づく通知を示します。詳細については、UI を使用して通知を編集するをご覧ください。

影響を受けるデベロッパーに通知するよう通知を編集する

[影響を受けるデベロッパーに通知する] セクションで選択した種類のイベントの通知は、その種類のイベントの影響を受けるデベロッパーにのみ送信されます。たとえば、[Revised rate plan] イベントを選択すると、料金プランを承認したデベロッパーにのみ通知が送信されます。

次の表に、[Notify Affected Developers] セクションのイベントタイプに基づく通知を示します。詳細については、UI を使用して通知を編集するをご覧ください。

Notify API Providers への通知を編集する

[Notify API Provider] セクションで選択したイベントタイプの通知は、指定した API プロバイダに送信されます。

次の表に、Notify API プロバイダ セクションのイベントタイプに基づく通知を示します。詳細については、UI を使用して通知を編集するをご覧ください。

通知を有効または無効にする

UI を使用して通知を有効または無効にするには:

1. [通知] ページにアクセスします。
2. 通知を有効または無効にするには、それぞれ横にあるチェックボックスをオンまたはオフにします。
3. [保存] をクリックして、すべての変更を保存します。

保存処理には数分かかることがあります。通知が保存されたことを確認するメッセージが表示されます。

API を使用してテンプレートを使用して通知を設定する

以降のセクションで説明するように、API を使用して通知を設定します。

API を使用して通知テンプレートを管理する

次のセクションで説明するように、API を使用して通知テンプレートを管理します。

• API を使用してすべての通知テンプレートを表示する
• API を使用して通知テンプレートを表示する
• API を使用して通知テンプレートを編集する

API を使用してすべての通知テンプレートを表示する

収益化で提供されるすべての通知テンプレートを一覧表示するには、/mint/organizations/{org_name}/notification-email-templates に GET リクエストを発行します。次に例を示します。

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
  -u email:password

たとえば、次のイベント テンプレートは、新しい API プロダクトの利用可能性をデベロッパーに通知します。

{
    "createdDate" : 1376975394984,
    "htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
    "orgId" : "myorg",
    "source" : "Mail Man Test",
    "subject" : "Notification of new product",
    "updatedDate" : 1376975394984
}

API を使用して通知テンプレートを表示する

/mint/organizations/{org_name}/notification-email-templates/{template_id} に GET リクエストを発行して、通知テンプレートを表示します。ここで、{template_id} はテンプレートの ID です。次に例を示します。

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
  -H "Accept:application/json"  \
  -u email:password

テンプレート内の $ で始まる項目は変数です。詳細については、通知テンプレートでの変数の使用をご覧ください。通知の変数が次の値に評価されるとします。

• ${developer.legalName}.XYZ company
• ${developer.name}.DEV1
• ${QUOTA_TYPE}.Transactions
• ${PERCENT}.90%
• ${QUOTA_UNIT}.Calls
• ${QUOTA_LIMIT}.100
• ${ratePlan.monetizationPackage.products.name}.X
• ${EXPIRY_DATE}.2016-09-30

テンプレートで提供される通知メッセージは次のようになります。

    "Dear XYZ company, DEV1
    You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"

API を使用して通知テンプレートを編集する

/nint/organizations/{org_name}/notification-email-templates/{template_id} に PUT リクエストを発行して、通知テンプレートを編集します。リクエスト本文で、テンプレートの変更されたコンテンツを指定します。

通知テンプレートのメッセージをカスタマイズするときに、1 つ以上の変数を含めることができます。詳細については、通知テンプレートで変数を使用するをご覧ください。

たとえば、次のリクエストは、新しい API プロダクト通知の内容を編集します。

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
  -H "Content-Type: application/json" \
  -d '{
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
    "name" : "NewProductNotification",
    "organization": {
    "id": "{org_name}"
    },
    "source" : "Mail Man Test ",
    "subject" : "New Product Available: ${Product.name}"
  }' \
  -u email:password

API を使用して通知の条件とアクションを管理する

以降のセクションで説明するように、API を使用して通知の条件とアクションを管理します。

• API を使用して通知条件とアクションを作成する
• API を使用して通知の条件とアクションを表示する
• API を使用して通知条件とアクションを編集する
• API を使用して通知条件とアクションを削除する

API を使用して通知条件とアクションを作成する

/mint/organizations/{org_name}/notification-conditions に POST リクエストを発行して、自動通知につながる通知条件とアクションを作成します。

リクエストを行う際は、リクエストの本文で、通知をトリガーする条件と、条件が満たされたときに実行するアクション（通知メールの送信など）を指定します。

1 つ以上の属性値を指定して、通知条件の詳細を定義します。属性のリストについては、通知条件の構成プロパティをご覧ください。アクティビティ通知の場合、新商品が公開されたときに条件がトリガーされることがあります。

actions を定義するときは、該当する通知テンプレートを参照します。アクションの一覧については、通知アクションの構成プロパティをご覧ください。

たとえば、次のリクエストでは、属性が NEW_PRODUCT で、属性 PUBLISHED の値が true の場合、ID が 01191bf9-5fdd-45bf-8130-3f024694e63 のテンプレート（DEFAULT_NEW_PRODUCT_TEMPLATE）で通知を送信するように指定しています。

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
  -H "Content-Type:application/json"
  -d '{
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
      "attribute": "PUBLISHED",
      "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
  }' \
  -u email:password

API を使用して通知の条件とアクションを表示する

通知の条件とアクションを表示するには、organizations/{org_name}/notification-conditions/{condition_Id} に GET リクエストを発行します。ここで、{condition_Id} は条件の ID です。ID は、通知条件の作成時に返されます。次に例を示します。

curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -H "Accept:application/json" \
  -u email:password

レスポンスの例を次に示します。

    {
    "actions" : [ {
    "actionAttribute" : "DEV_ID",
    "id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
    "templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
    "value" : "ANY"
    }, {
    "actionAttribute" : "ORG_EMAIL",
    "id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
    "templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
    "value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
    } ],
    "notificationCondition" : [ {
    "attribute" : "Balance",
    "id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
    "organization" : {
    ...
    },
    "value" : "< 0"
    } ]
    }

API を使用して通知の条件とアクションを編集する

通知の条件とアクションを編集するには、organizations/{org_name}/notification-conditions/{condition_Id} に POST リクエストを発行します。ここで、{condition_Id} は条件の ID です。ID は、通知条件の作成時に返されます。リクエストを発行するときに、通知条件またはアクションに対して行う変更をリクエストの本文で指定します。

次に例を示します。

   $ curl -H "Content-Type:application/json" -X POST -d \
    ' {
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
    "attribute": "PUBLISHED",
    "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
    }' \
    "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -u email:password

API を使用して通知条件とアクションを削除する

organizations/{org_name}notification-conditions/{condition_Id} に DELETE リクエストを発行して、通知条件を削除します。次に例を示します。

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4"  \
  -H "Accept:application/json"  \
  -u email:password

通知条件の構成プロパティ

API を使用する場合、通知条件には次の構成プロパティを使用できます。

通知アクションの構成プロパティ

API を使用する場合、通知アクションには次の構成プロパティを使用できます。

通知テンプレートで変数を使用する

通知テンプレートでメッセージを編集するときに、Spring Expression Language（SpEL）を使用して 1 つ以上の変数を含め、Transaction オブジェクトで返された値を表すことができます。

次の表に、最もよく使用される通知テンプレート変数を示します。

返信先メールアドレスをカスタマイズする

収益化では、企業とデベロッパーに送信されるメール通知に使用するデフォルトの noreply@apigee.com アドレスが構成されます。組織のカスタム返信名とアドレスを構成するには、Apigee サポートにお問い合わせください。