Capping API の使用 work
Capping API を使用すると、キャップ設定を作成、設定および監視できます。
この節では、API の使用方法に関する全体的な情報を示します。API について詳しくは、Adobe Journey Optimizer API ドキュメントを参照してください。
Capping API の説明と Postman コレクション description
次の表に、Capping API で使用できるコマンドを示します。リクエストサンプル、パラメーター、応答形式などの情報について詳しくは、Adobe Journey Optimizer API ドキュメントを参照してください。
{uid}/deploy{uid}/undeploy{uid}/canDeploy{uid}{uid}{uid}設定を作成または更新すると、ペイロードの構文と整合性を保証するチェックが自動的に実行されます。
問題が発生した場合は、設定を修正するのに役立つ警告またはエラーが返されます。
また、テスト設定に役立つ Postman コレクションについて詳しくは、こちらを参照してください。
このコレクションは、Adobe I/O コンソールの統合／試す／Postman 用にダウンロード経由で生成された Postman 変数コレクションを共有するように設定されています。これにより、選択した統合値を含む Postman 環境ファイルが生成されます。
ダウンロードして Postman にアップロードしたら、{JO_HOST}、{BASE_PATH} および {SANDBOX_NAME} の 3 つの変数を追加する必要があります。
{JO_HOST}：Journey Optimizerゲートウェイ URL。{BASE_PATH}：API のエントリポイント。{SANDBOX_NAME}：API 操作が行われるサンドボックス名に対応するヘッダー x-sandbox-name（例えば、「prod」）。詳しくは、サンドボックスの概要を参照してください。
エンドポイントの設定
エンドポイント設定の基本構造は次のとおりです。
{
"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>
}
},
...
}
}
maxHttpConnections 値が設定されていない場合は、デプロイ済みの設定にデフォルトの maxHttpConnections = -1 が追加され、Journey Optimizer はデフォルトのシステム値を使用します。例：
{
"url": "https://api.example.org/data/2.5/*",
"methods": [
"GET"
],
"services": {
"dataSource": {
"rating": {
"maxCallsCount": 500,
"periodInMs": 1000
}
}
}
}
警告とエラー
canDeployメソッドを呼び出す際、プロセスは設定を検証し、次のいずれかの一意の ID によって識別される検証ステータスを返します。
"ok" or "error"
潜在的なエラーは次のとおりです。
- ERR_ENDPOINTCONFIG_100：キャップ設定：URL が見つからないか、無効です
- ERR_ENDPOINTCONFIG_101：キャップ設定：不正な URL です
- ERR_ENDPOINTCONFIG_102：キャップ設定：不正な URL です：ホスト内の URL にワイルド文字を使用することはできません:port
- ERR_ENDPOINTCONFIG_103：キャップ設定：HTTP メソッドがありません
- ERR_ENDPOINTCONFIG_104：キャップ設定：呼び出しの評価が定義されていません
- ERR_ENDPOINTCONFIG_107：キャップ設定：無効な最大呼び出し数（maxCallsCount）です
- ERR_ENDPOINTCONFIG_108：キャップ設定：無効な最大呼び出し数（periodInMs）です
- ERR_ENDPOINTCONFIG_111：キャップ設定：エンドポイント設定を作成できません：無効なペイロードです
- ERR_ENDPOINTCONFIG_112：キャップ設定：エンドポイント設定を作成できません：JSON ペイロードが予想されます
- ERR_AUTHORING_ENDPOINTCONFIG_1：無効なサービス名
<!--<given value>-->：「dataSource」または「action」である必要があります
潜在的な警告は次のとおりです。
ERR_ENDPOINTCONFIG_106：キャップ設定：最大 HTTP 接続数が定義されていません：デフォルトではキャップなし
ユースケース
この節では、Journey Optimizer でキャップ設定を管理する主なユースケースと、そのユースケースを実装するために必要な関連 API コマンドについて説明します。
各 API コマンドについて詳しくは、API の説明と Postman コレクションを参照してください。
使用する API 呼び出し：
list- 既存の設定を取得します。create- 新しい設定を作成します。candeploy- 設定をデプロイできるかどうかを確認します。deploy- 設定をデプロイします。
使用する API 呼び出し：
list- 既存の設定を取得します。get- 特定の設定の詳細を取得します。update- 設定を変更します。candeploy- デプロイメントの実施要件を確認します。deploy- 設定をデプロイします。
使用する API 呼び出し：
list- 既存の設定を取得します。undeploy- 設定をデプロイ解除します。delete- 設定を削除します。
1 回の API 呼び出しのみで、forceDelete パラメーターを使用して設定をデプロイ解除および削除できます。
使用する API 呼び出し：
list- 既存の設定を取得します。delete（forceDeleteパラメーターを使用）- デプロイ済みの設定を 1 つの手順で強制的に削除します。
| note note |
|---|
| NOTE |
| 既にデプロイされている設定を更新する場合は、再デプロイが必要です。 |
使用する API 呼び出し：
list- 既存の設定を取得します。get- 特定の設定の詳細を取得します。update- 設定を変更します。undeploy- 変更を適用する前に設定をデプロイ解除します。candeploy- デプロイメントの実施要件を確認します。deploy- 更新された設定をデプロイします。