Capping API の使用 work

Capping API を使用すると、キャッピング設定を作成、設定および監視できます。

この節では、API の使用方法に関する全体的な情報を示します。API について詳しくは、Adobe Journey Optimizer API ドキュメントを参照してください。

Capping API の説明

設定を作成または更新すると、ペイロードの構文と整合性を保証するチェックが自動的に実行されます。
問題が発生した場合は、設定を修正するのに役立つ警告またはエラーが返されます。

エンドポイントの設定

エンドポイント設定の基本構造は次のとおりです。

{
    "url": "<endpoint URL>",  //wildcards are allowed in the endpoint URL
    "methods": [ "<HTTP method such as GET, POST, >, ...],
    "services": {
        "<service name>": { . //must be "action" or "dataSource"
            "maxHttpConnections": <max connections count to the endpoint (optional)>
            "rating": {
                "maxCallsCount": <max calls to be performed in the period defined by period/timeUnit>,
                "periodInMs": <integer value greater than 0>
            }
        },
        ...
    }
}

例：

`{
  "url": "https://api.example.org/data/2.5/*",
  "methods": [
    "GET"
  ],
  "services": {
    "dataSource": {
      "rating": {
        "maxCallsCount": 500,
        "periodInMs": 1000
      }
    }
  }
}

警告とエラー

canDeploy ​メソッドを呼び出す際、プロセスは設定を検証し、次のいずれかの一意の ID によって識別される検証ステータスを返します。

"ok" or "error"

潜在的なエラーは次のとおりです。

潜在的な警告は次のとおりです。

ERR_ENDPOINTCONFIG_106：キャッピング設定：最大 HTTP 接続数が定義されていません：デフォルトでは制限なし

ユースケース

この節では、Journey Optimizer でキャッピング設定を管理するために実行できる 5 つの主なユースケースを示します。

テストと設定に役立つように、こちらで Postman コレクションを使用できます。

この Postman コレクションは、Adobe I/O コンソールの統合／試す／Postman 用にダウンロード ​を使用して生成された Postman 変数コレクションを共有するようにセットアップされています。これにより、選択した統合値を使用して Postman 環境ファイルが生成されます。

ダウンロードして Postman にアップロードしたら、{JO_HOST}、{BASE_PATH} および {SANDBOX_NAME} の 3 つの変数を追加する必要があります。

以下の節では、ユースケースを実行するための Rest API 呼び出し順序付きリストを見つけます。

ユースケース n°1：新しいキャッピング設定の作成とデプロイ

ユースケース n°2：まだデプロイされていないキャッピング設定の更新とデプロイ

ユースケース n°3：デプロイ済みのキャッピング設定のデプロイ解除と削除

ユースケース n°4：デプロイ済みのキャッピング設定の削除

1 回の API 呼び出しで、 forceDelete パラメーターを使用して、設定をデプロイ解除および削除できます。

ユースケース n°5：既にデプロイされているキャッピング設定の更新