WhatsApp Conversions API にリクエストを送信します。
操作説明
この API オペレーションの中国固有の 1 ユーザーあたりのクエリ/秒 (QPS) 制限は、1 秒あたり 100 回の呼び出しです。この制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。必要に応じてこの操作を呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cams:RequestWhatsappConversionApi |
none |
*全部资源
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PageId |
string |
必須 |
Meta の PageId。 |
1939848838 |
| CustSpaceId |
string |
必須 |
顧客のスペース ID またはインスタンス ID。 |
929399382 |
| RequestData |
array<object> |
任意 |
リクエストデータ。 |
|
|
array<object> |
任意 |
リクエストデータ。 |
||
| DataProcessingOptionsState |
integer |
任意 |
場合によっては必須です。(詳細については以下の注記を参照してください。) このデータ処理オプションに関連付ける州。現在受け入れられる値は 1000 (カリフォルニア州を表す) または 0 (このイベントのジオロケーションをリクエスト) です。 |
26 |
| UserData |
object |
必須 |
顧客情報データを含むマップ。フォーマットはキーと値のペアです。 |
|
|
any |
任意 |
data |
{"currency":"USD", "value": 1} |
|
| EventName |
string |
必須 |
|
Purchase |
| OptOut |
boolean |
任意 |
このイベントを広告配信の最適化に使用しないことを示すフラグ。true に設定すると、イベントはアトリビューションにのみ使用できます。 |
true |
| AppData |
object |
任意 |
アプリイベントの必須パラメーター。 これらのパラメーターは、アプリデータとデバイス情報を Conversions API と共有するために使用されます。フォーマットはキーと値のペアです。 |
|
|
any |
任意 |
data |
{} |
|
| EventTime |
integer |
必須 |
イベントが実際に発生した時間を示す UNIX タイムスタンプ (秒単位)。指定する時間は、イベントを Facebook に送信する時間より前の場合があります。これはバッチ処理とサーバーパフォーマンスの最適化を目的としています。日付はグリニッジ標準時 (GMT) タイムゾーンフォーマットで送信する必要があります。 |
1709201870 |
| ExtInfo |
object |
任意 |
アプリイベントの必須パラメーター。 画面の幅と高さなどの拡張デバイス情報。このパラメーターはカンマで区切られた値を持つ配列フォーマットです。extinfo を使用する場合、すべての値が必須であり、以下のインデックス順序で配置する必要があります。値が欠落している場合は、空の文字列をプレースホルダーとして使用してください。 |
|
|
any |
任意 |
data |
{} |
|
| CustomData |
object |
任意 |
イベントの追加ビジネスデータを含むマップ。 |
|
|
any |
任意 |
data |
{} |
|
| EventId |
string |
任意 |
この ID は、広告主が選択した任意の一意の文字列です。event_name と event_id パラメーターは、ウェブサイト (Meta Pixel 経由)、アプリ (SDK または App Events API 経由)、および Conversions API から送信されたイベントの重複排除に使用されます。event_id はオプションとしてマークされていますが、重複排除のためにこのパラメーターを使用することを推奨します。 |
20029399299 |
| DataProcessingOptions |
array |
任意 |
特定のイベントに対して有効にする処理オプション。Limited Data Use の場合、現在受け入れられる値は LDU です。空の配列を送信して、イベントを Limited Data Use の制限で処理してはならないことを明示的に指定できます。 |
|
|
string |
任意 |
data。 |
[] |
|
| MessagingChannel |
string |
任意 |
ソース。固定値: whatsapp。 |
|
| ActionSource |
string |
必須 |
コンバージョンが発生した場所を指定します。イベントが発生した場所を把握することで、広告が正しいオーディエンスに配信されるようになります。Conversions API を使用することにより、action_source パラメーターがお客様の知る限り正確であることに同意するものとします。 action_source フィールドで送信できる値は以下のとおりです:
注意: すべての操作ソース値は広告測定とカスタムオーディエンスの作成をサポートしています。physical_store を除くすべての操作ソースは広告の最適化をサポートしています。 |
business_messaging |
| DataProcessingOptionsCountry |
integer |
任意 |
data_processing_options で LDU を送信する場合は必須です。 このデータ処理オプションに関連付ける国。現在受け入れられる値は 1 (米国を表す) または 0 (このイベントのジオロケーションをリクエスト) です。 |
100 |
| EventSourceUrl |
string |
任意 |
イベントが発生したブラウザ URL。URL は http:// または https:// で始まり、検証済みドメインと一致する必要があります。 |
http://alibaba.com |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| AccessDeniedDetail |
string |
アクセス拒否の詳細。 |
无 |
| Message |
string |
エラーメッセージ。 |
示例值 |
| RequestId |
string |
リクエスト ID。 |
示例值示例值示例值 |
| Code |
string |
応答コード。
|
OK |
| Success |
boolean |
呼び出しが成功したかどうかを示します。有効な値:
|
true |
例
成功レスポンス
JSONJSON
{
"AccessDeniedDetail": "无",
"Message": "示例值",
"RequestId": "示例值示例值示例值",
"Code": "OK",
"Success": true
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。