アドホックアクティベーション API を使用して、オーディエンスをオンデマンドでバッチ保存先にアクティブ化します
概要 overview
アドホックアクティベーション API を使用すると、マーケターは、即時のアクティベーションが必要な状況に対して、すばやく効率的に、プログラムによってオーディエンスを宛先に対してアクティブ化できます。
アドホックアクティベーション API を使用して、完全なファイルを目的のファイル受信システムに書き出します。 アドホックオーディエンスのアクティベーションは、 バッチファイルベースの宛先.
次の図に、24 時間ごとに Platform でおこなわれるセグメント化ジョブを含め、アドホックアクティベーション API を介してオーディエンスをアクティブ化するためのエンドツーエンドのワークフローを示します。
ユースケース use-cases
Flashの売り上げまたはプロモーション
あるオンライン小売業者は、限定的なフラッシュ販売を準備しており、顧客に短い通知で通知したいと考えています。 マーケティングチームは、Experience Platformアドホックアクティベーション API を使用して、オーディエンスをオンデマンドでエクスポートし、プロモーション E メールを顧客ベースにすばやく送信できます。
最新のイベントまたは最新のニュース
ホテルは、翌日の悪天候を期待し、チームは到着したゲストに迅速に知らせたいので、適切な計画を立てることができます。 マーケティングチームは、Experience Platformアドホックアクティベーション API を使用して、オーディエンスをオンデマンドでエクスポートし、ゲストに通知することができます。
統合テスト
IT 管理者は、Experience Platformのアドホックアクティベーション API を使用してオーディエンスをオンデマンドで書き出し、Adobe Experience Platformとのカスタム統合をテストして、すべてが正しく動作していることを確認できます。
ガードレール guardrails
アドホックアクティベーション API を使用する際は、次のガードレールに注意してください。
- 現在、各アドホックアクティベーションジョブは、最大 80 人のオーディエンスをアクティブ化できます。 1 回のジョブで 80 を超えるオーディエンスをアクティブ化しようとすると、ジョブが失敗します。 この動作は、今後のリリースで変更される可能性があります。
- アドホックアクティベーションジョブは、スケジュール済みと並行して実行できません オーディエンスの書き出しジョブ. アドホックアクティベーションジョブを実行する前に、スケジュールされたオーディエンスの書き出しジョブが終了していることを確認します。 詳しくは、 宛先のデータフローの監視 を参照してください。 例えば、アクティベーションデータフローに 処理中 のステータス。終了するのを待ってから、アドホックアクティベーションジョブを実行します。
- オーディエンスごとに複数の同時アドホックアクティベーションジョブを実行しないでください。
セグメント化に関する考慮事項 segmentation-considerations
Adobe Experience Platformは、24 時間に 1 回、スケジュールされたセグメント化ジョブを実行します。 アドホックアクティベーション API は、最新のセグメント化結果に基づいて実行されます。
手順 1:前提条件 prerequisites
Adobe Experience Platform API を呼び出す前に、次の前提条件を満たしていることを確認してください。
- Adobe Experience Platformへのアクセス権を持つ組織アカウントがある。
- Experience Platformアカウントに
developer
およびuser
役割がAdobe Experience Platform API 製品プロファイルで有効になっていること。 お問い合わせ Admin Console 管理者:アカウントに対してこれらのロールを有効にします。 - あなたはAdobe IDを持っている。 Adobe IDをお持ちでない場合は、 Adobe Developer Console 新しいアカウントを作成します。
手順 2:資格情報の収集 credentials
Platform API への呼び出しを実行する前に、認証に関するチュートリアルを完了する必要があります。認証に関するチュートリアルを完了すると、すべての Experience Platform API 呼び出しで使用する、以下のような各必須ヘッダーの値が提供されます。
- Authorization: Bearer
{ACCESS_TOKEN}
- x-api-key:
{API_KEY}
- x-gw-ims-org-id:
{ORG_ID}
Experience Platform のリソースは、特定の仮想サンドボックスに分離することができます。Platform API へのリクエストでは、操作を実行するサンドボックスの名前と ID を指定できます。次に、オプションのパラメーターを示します。
- x-sandbox-name:
{SANDBOX_NAME}
ペイロード(POST、PUT、PATCH)を含むすべてのリクエストには、メディアのタイプを指定する以下のような追加ヘッダーが必要です。
- Content-Type:
application/json
手順 3:Platform UI でのアクティベーションフローの作成 activation-flow
アドホックアクティベーション API を使用してオーディエンスをアクティブ化する前に、まず、選択した宛先に対して、Platform UI でアクティベーションフローを設定する必要があります。
これには、アクティベーションワークフロー、オーディエンスの選択、スケジュールの設定、アクティブ化が含まれます。 UI または API を使用して、アクティベーションフローを作成できます。
手順 4:最新のオーディエンス書き出しジョブ ID を取得する(v2 では不要) segment-export-id
バッチ宛先のアクティベーションフローを設定すると、スケジュールされたセグメント化ジョブは 24 時間ごとに自動的に実行されます。
アドホックアクティベーションジョブを実行する前に、最新のオーディエンス書き出しジョブの ID を取得する必要があります。 この ID は、アドホックアクティベーションジョブリクエストで渡す必要があります。
説明されている手順に従います。 ここ をクリックして、すべてのオーディエンス書き出しジョブのリストを取得します。
応答で、以下のスキーマプロパティを含む最初のレコードを探します。
"schema":{
"name":"_xdm.context.profile"
}
オーディエンス書き出しジョブ ID は、 id
プロパティに含めることができます。
手順 5:アドホックアクティベーションジョブを実行する activation-job
Adobe Experience Platformは、24 時間に 1 回、スケジュールされたセグメント化ジョブを実行します。 アドホックアクティベーション API は、最新のセグメント化結果に基づいて実行されます。
アドホックアクティベーションジョブを実行する前に、オーディエンスに対してスケジュールされたオーディエンスの書き出しジョブが終了していることを確認します。 詳しくは、 宛先のデータフローの監視 を参照してください。 例えば、アクティベーションデータフローに 処理中 のステータス。完了するのを待ってから、アドホックアクティベーションジョブを実行して完全なファイルをエクスポートします。
オーディエンスの書き出しジョブが完了したら、アクティベーションをトリガーできます。
リクエスト request
Accept: application/vnd.adobe.adhoc.activation+json; version=2
リクエストのヘッダーを使用して、アドホックアクティベーション API の v2 を使用する必要があります。curl --location --request POST 'https://platform.adobe.io/data/core/activation/disflowprovider/adhocrun' \
--header 'x-gw-ims-org-id: 5555467B5D8013E50A494220@AdobeOrg' \
--header 'Authorization: Bearer {{token}}' \
--header 'x-sandbox-id: 6ef74723-3ee7-46a4-b747-233ee7a6a41a' \
--header 'x-sandbox-name: {sandbox-id}' \
--header 'Accept: application/vnd.adobe.adhoc.activation+json; version=2' \
--header 'Content-Type: application/json' \
--data-raw '{
"activationInfo":{
"destinationId1":[
"segmentId1",
"segmentId2"
],
"destinationId2":[
"segmentId2",
"segmentId3"
]
}
}'
destinationId1
destinationId2
segmentId1
segmentId2
segmentId3
書き出し ID を含むリクエスト(廃止予定) request-deprecated
curl -X POST https://platform.adobe.io/data/core/activation/disflowprovider/adhocrun \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-d '
{
"activationInfo":{
"destinationId1":[
"segmentId1",
"segmentId2"
],
"destinationId2":[
"segmentId2",
"segmentId3"
]
},
"exportIds":[
"exportId1"
]
}
destinationId1
destinationId2
segmentId1
segmentId2
segmentId3
exportId1
応答 response
正常な応答は、HTTP ステータス 200 を返します。
{
"order":[
{
"segment":"db8961e9-d52f-45bc-b3fb-76d0382a6851",
"order":"ef2dcbd6-36fc-49a3-afed-d7b8e8f724eb",
"statusURL":"https://platform.adobe.io/data/foundation/flowservice/runs/88d6da63-dc97-460e-b781-fc795a7386d9"
}
]
}
segment
order
statusURL
API エラー処理 api-error-handling
Destination SDK API エンドポイントは、一般的な Experience Platform API エラーメッセージの原則に従います。Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。
アドホックアクティベーション API に固有の API エラーコードおよびメッセージ specific-error-messages
アドホックアクティベーション API を使用する場合、この API エンドポイントに固有のエラーメッセージが表示されます。 表を見て、表示される際の対処方法を理解してください。
segment ID
注文 dataflow ID
実行 id を使用 flow run ID
<segment name>
は、このデータフローに含まれていないか、スケジュール範囲外です。