RequestWhatsappConversionApi - 请求Whatsapp Conversion api

更新时间:
复制 MD 格式

请求Whatsapp Conversion api

接口说明

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cams:RequestWhatsappConversionApi

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

PageId

string

Meta 的 PageId

1939848838

CustSpaceId

string

客户的 SpaceId/实例 ID。

929399382

RequestData

array<object>

请求数据

array<object>

请求数据

DataProcessingOptionsState

integer

在某些情况下为必要项。(查看下方备注以了解详情。) 您希望与此数据处理选项相关联的州/省。当前可接受值为 1000(代表加利福尼亚州),或者 0(请求我们为此事件进行地理定位)。

26

UserData

object

包含客户信息数据的映射。

any

data

{"currency":"USD", "value": 1}

EventName

string

  • 标准事件或自定义事件的名称。此字段用于删除由网站(通过 Meta Pixel 像素代码)或应用(通过 SDK 或应用事件 API)以及转化 API 发送的重复事件。event_id 参数也用于删除重复事件。

  • 对于相同的客户操作,浏览器事件或应用事件的 event 应与服务器事件的 event_name 相符。如果我们在 48 小时内发送的事件之间找到匹配项,则只考虑第一个事件。如果几乎同一时间收到服务器和浏览器/应用事件(即彼此相差 5 分钟以内),则将优先考虑浏览器/应用事件。详细了解删除重复的 Pixel 像素代码事件和服务器事件。

Purchase

OptOut

boolean

表示不应将此事件用于广告投放优化的标记。设置为 true 时,该事件仅可用作归因条件。

true

AppData

object

应用事件必要参数

这些参数用于将应用数据和设备信息分享给转化 API。

any

data

{}

EventTime

integer

Unix 时间戳(以秒为单位),表示事件的实际发生时间。指定时间可能早于您将事件发送至 Facebook 的时间。其目的在于实现批处理和服务器性能优化。您必须以格林威治标准时间 (GMT) 时区格式发送该日期。

1709201870

ExtInfo

object

应用事件必要参数

扩展设备信息,例如屏幕的宽度和高度。此参数是一个数组,各个值之间使用逗号分隔。使用 extinfo 时,所有值均为必要项,并且必须按照以下索引顺序排列。如果缺少某个值,则需使用空字符串作为占位符填充。

any

data

{}

CustomData

object

包含事件其他企业数据的映射。

any

data

{}

EventId

string

此编号可以是广告主选定的任何唯一字符串。参数 event_name 和 event_id 用于删除由网站(通过 Meta Pixel 像素代码)或应用(通过 SDK 或应用事件 API)以及转化 API 发送的重复事件。请注意,虽然我们将 event_id 标记为可选项,但是建议您在删除重复事件时采用此参数。

20029399299

DataProcessingOptions

array

您希望为特定事件启用的处理选项。对于受限数据使用,当前可接受值为 LDU。您可以发送一个空数组来明确指定,不得使用“受限数据使用”限制来处理此事件。

string

data

[]

MessagingChannel

string

来源,固定为: whatsapp

whatsapp

ActionSource

string

您可通过此字段指定转化发生的位置。了解事件发生的位置有助于确保将广告投放至正确的受众。使用转化 API,即表示您同意:就您所知 action_source 参数准确无误。

您可在 action_source 字段中发送的值如下:

  • email — 转化通过邮件发生。

  • website — 转化在网站上完成。

  • app — 转化在移动应用上完成。

  • phone_call — 转化通过电话完成。

  • chat — 转化通过消息应用、短信或在线消息功能完成。

  • physical_store — 转化在实体店面对面完成。

  • system_generated — 转化自动发生,例如将订阅续费设置为每月自动支付。

  • other — 转化通过本文未列出的其他方式完成。

注意:所有操作来源值都支持广告成效衡量和自定义受众创建功能。所有操作来源(除 physical_store 外)都支持广告优化功能。

business_messaging

DataProcessingOptionsCountry

integer

如果您在 data_processing_options 下发送 LDU,则为必要项。 您希望与此数据处理选项相关联的国家/地区。当前可接受值为 1(代表美国),或者 0(请求我们为此事件进行地理定位)。

100

EventSourceUrl

string

事件发生的浏览器网址。此网址必须以 http:// 或 https:// 开头,并且应与已认证的网域相匹配。

http://alibaba.com

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

访问被拒绝详细信息。

None

Message

string

错误提示信息。

example

RequestId

string

请求 ID。

example

Code

string

请求状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码,请参见错误码列表

OK

Success

boolean

是否调用成功:

  • true:调用成功。

  • false:调用失败。

true

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "Message": "example",
  "RequestId": "example",
  "Code": "OK",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情