Adobe Target Bulk Profile Update API

Adobe Target Bulk Profile Update API では、Web サイトへの複数の訪問者のユーザープロファイルをバッチファイルで一括更新できます。

Bulk Profile Update API を使用すると、多くのユーザーが任意の外部ソースから Target 信できるように、プロファイルパラメーターの形式で詳細な訪問者プロファイルデータを簡単に送信できます。 外部ソースには顧客関係管理(CRM)システムや販売時点(POS)システムを含めますが、これらのシステムは通常、web ページでは使用できません。

バージョン
URL の例
機能
v1
http://CLIENTCODE.tt.omtrdc.net/m2/CLIENTCODE/profile/batchUpdate
プロファイルの一括更新のみをサポートします。
v2
http://CLIENTCODE.tt.omtrdc.net/m2/CLIENTCODE/v2/profile/batchUpdate
  • 見つからない場合はプロファイルを作成
  • 行ごとのステータスの更新。
NOTE
Bulk Profile Update API のバージョン 2 (v2)は現在のバージョンです。 ただし、Target はバージョン 1 (v1)を引き続きサポートします。

Bulk Profile Update API の利点

  • プロファイル属性の数に上限がありません。
  • サイトを介して送信されたプロファイル属性は、API を使用して更新できます。その逆も可能です。

注意事項

  • バッチファイルの容量は 50 MB 未満にする必要があります。また、1 回にアップロードできる行数は 50 万行までです。
  • 更新は通常 1 時間以内に行われますが、反映されるまでに 24 時間かかる場合があります。
  • 後続のバッチで 24 時間にわたってアップロードできるアップロード行数に制限はありません。 ただし、他のプロセスを効率的に実行するために、営業時間中は取り込みプロセスが調整される場合があります。
  • 同じ thirdPartyIds の間に mbox 呼び出しを含まない v2 バッチ更新呼び出しが連続して発生すると、最初のバッチ更新呼び出しで更新されたプロパティが上書きされます。
  • Adobe では、バッチプロファイルデータの 100% が Target に転送されて保持され、ターゲティングで使用できることを保証しません。 現在の設計では、わずかな割合のデータ(大規模な生産バッチの 0.1% 以下)は、オンボードまたは保持されない可能性があります。

バッチファイル

プロファイルデータを一括更新するには、バッチファイルを作成します。 バッチファイルは、次のサンプルファイルと同様に、コンマで区切られた値を持つテキストファイルです。

\ batch=pcId,param1,param2,param3,param4\ 123,value1\ 124,value1,value4\ 125,value2\ 126,value1,value2,value3,value4\

NOTE
batch= パラメーターは必須であり、ファイルの先頭で指定する必要があります。

このファイルは、Target サーバーへのPOST呼び出しで参照し、ファイルを処理します。 バッチファイルを作成する場合は、次の点を考慮してください。

  • ファイルの最初の行では、列ヘッダーを指定する必要があります。
  • 最初のヘッダーは、pcId または thirdPartyId にする必要があります。 Marketing Cloud visitor ID はサポートされていません。 pcId は、Target で生成された visitorID です。 thirdPartyId は、クライアントアプリケーションによって指定された ID で、mbox3rdPartyId として mbox 呼び出しを通じて Target に渡されます。 ここでは、thirdPartyId と呼ぶ必要があります。
  • セキュリティ上の理由から、バッチファイルで指定するパラメーターと値は、UTF-8 を使用して URL エンコードする必要があります。 パラメーターと値は、HTTP リクエストを通じて処理するために他のエッジノードに転送できます。
  • パラメーターは、paramName の形式のみにする必要があります。 パラメーターは、profile.paramName のように Target に表示されます。
  • Bulk Profile Update API v2 を使用している場合は、各 pcId に対してすべてのパラメーター値を指定する必要はありません。 プロファイルは、Target に見つからない pcId または mbox3rdPartyId に対して作成されます。 v1 を使用している場合、pcId または mbox3rdPartyIds が見つからないプロファイルは作成されません。
  • バッチファイルの容量は 50 MB 未満にする必要があります。また、合計行数は 500,000 を超えないようにする必要があります。 この制限により、サーバーに大量のリクエストが送られないようにすることができます。
  • 複数のファイルを送信できます。 ただし、1 日に送信するすべてのファイルの行の合計は、各クライアントで 100 万行を超えないようにしてください。
  • アップロードする属性の数に制限はありません。 ただし、システムデータを含むプロファイルの全体のサイズは、2000 KB を超えないようにしてください。 Adobe では、プロファイル属性に使用するストレージは 1,000 KB 未満にすることをお勧めします。
  • パラメーターと値は、大文字と小文字を区別します。

HTTP POSTリクエスト

Target エッジサーバーに HTTPPOSTリクエストを送信して、ファイルを処理します。 curl コマンドを使用した batch.txt ファイルの HTTPPOSTリクエストの例を次に示します。

\ curl -X POST --data-binary @BATCH.TXT http\://CLIENTCODE.tt.omtrdc.net/m2/CLIENTCODE/v2/profile/batchUpdate\

要素の説明:

BATCH.TXT はファイル名です。 CLIENTCODE は、Target のクライアントコードです。

クライアントコードがわからない場合は、Target ユーザーインターフェイスで Administration/Implementation をクリックします。 クライアントコードは Account Details セクションに表示されます。

応答をInspect

プロファイル API は、「batchStatus」の下にあるリンクと共に、処理対象のバッチの送信ステータスを、特定のバッチジョブの全体的なステータスを表示する別の URL に返します。

API 応答の例

次のコードは、Profiles API 応答の例です。

<response>
    <success>true</success>
    <batchStatus>http://mboxedge45.tt.omtrdc.net/m2/demo/profile/batchStatus?batchId=demo-1701473848678-13029383</batchStatus>
    <message>Batch submitted for processing</message>
</response>

エラーが発生した場合、応答には success=false とエラーの詳細メッセージが含まれます。

デフォルトのバッチステータス応答

上記の batchStatus URL リンクがクリックされた場合、デフォルトの応答が成功すると、次のようになります。

<response><batchId>demo4-1701473848678-13029383</batchId><status>complete</status><batchSize>1</batchSize></response>

ステータスフィールドに想定される値は次のとおりです。

ステータス
詳細
complete
プロファイルバッチ更新リクエストが正常に完了しました。
incomplete
プロファイルバッチ更新リクエストは現在も処理中で、完了していません。
stuck
プロファイルバッチ更新リクエストが停止し、完了できませんでした。

詳細なバッチステータス URL 応答

上記の batchStatus の URL にパラメーター showDetails=true を渡すことで、より詳細な応答を取得できます。

次に例を示します。

http://mboxedge45.tt.omtrdc.net/m2/demo/profile/batchStatus?batchId=demo-1701473848678-13029383&showDetails=true

詳細な応答

<response>
    <batchId>demo4-1701473848678-13029383</batchId>
    <status>complete</status>
    <batchSize>1</batchSize>
    <consumedCount>1</consumedCount>
    <successfulUpdates>1</successfulUpdates>
    <profilesNotFound>0</profilesNotFound>
    <failedUpdates>0</failedUpdates>
</response>
recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3