CTWA
广告转换事件
请求接口
GET
https://api.innopaas.com/api/whatsapp/v3/ads/conversion/event
请求参数
objectId
String
是
事件对象 ID例如用户 ID 或广告 ID。
events
List
是
事件列表
--eventId
String
否
事件ID* 此编号可以是广告主选定的任何唯一字符串。参数 event_name 和 event_id 用于删除由网站（通过 Meta Pixel 像素代码）或应用（通过 SDK 或应用事件 API）以及转化 API 发送的重复事件。请注意，虽然我们将 event_id 标记为非必要项，但是建议您在删除重复事件时采用此参数。 * 删除重复事件时，浏览器事件或应用事件的 eventID 必须与对应服务器事件的 event_id 相匹配。详细了解处理重复的 Pixel 像素代码事件和转化 API 事件。 * 订单号或交易编号是 event_id 可用的两个标识符。例如，如果顾客在您的网站购物两次，订单号分别为 123 和 456，则每次转化 API 调用都需要在 event_id 中添加相应的订单号。这样，我们就可以将这两次购物事件正确区分为不同订单。两次相应的浏览器 Pixel 像素代码购物事件也需要在 eventID 参数中发送相同的订单号，以便我们了解实际上只发生了两次事件，而不是四次独立购物。 * 如果事件不具备固有编号数字，可以使用随机数字（前提是在浏览器和服务器事件之间也发送此随机数字）。
--eventName
String
是
标准事件或自定义事件的名称。此字段用于由网站（通过 Meta Pixel 像素代码）或应用（通过 SDK 或应用事件 API）以及转化 API 发送的重复事件。event_id 参数也用于删除重复事件。对于相同的客户操作，浏览器事件或应用事件的 event 应与服务器事件的 event_name 相符。如果我们在 48 小时内发送的事件之间找到匹配项，则只考虑第一个事件。如果几乎同一时间收到服务器和浏览器/应用事件（即彼此相差 5 分钟以内），则将优先考虑浏览器/应用事件。详细了解删除重复的 Pixel 像素代码事件和服务器事件。
--eventTime
Long
是
**Unix 时间戳（以秒为单位）**表示事件的实际发生时间。指定时间可能早于您将事件发送至 Facebook 的时间。其目的在于实现批处理和服务器性能优化。您必须以格林威治标准时间 (GMT) 时区格式发送该日期。event_time 最长可比您将事件发送至 Facebook 的时间早 7 天。如果 data 中的任何 event_time 早于 7 天前，我们会为整个请求返回错误，而且不会处理任何事件
--actionSource
String
是
来源您可通过此字段指定转化发生的位置。了解事件发生的位置有助于确保将广告投放至正确的受众。使用转化 API，即表示您同意：就您所知 action_source 参数准确无误。*您可在 action_source 字段中发送的值如下：* email — 转化通过邮件发生。* website — 转化在网站上完成。* app — 转化在移动应用上完成。* phone_call — 转化通过电话完成。* chat — 转化通过消息应用、短信或在线消息功能完成。* physical_store — 转化在实体店面对面完成。* system_generated — 转化自动发生，例如将订阅续费设置为每月自动支付。* business_messaging — 转化是通过 Messenger、Instagram 或 WhatsApp 的直达广告产生的。* other — 转化通过本文未列出的其他方式完成。* 注意：所有操作来源值都支持广告成效衡量和自定义受众创建功能。所有操作来源都支持广告优化功能
--userData
Map
是
用户数据包含客户信息数据的映射。请参阅客户信息参数，了解有关选项。请参阅高级匹配，了解通过 Meta Pixel 像素代码发送的数据的可用比较选项。Key值:* em：邮箱 — 需要进行哈希处理* ph：手机号 — 需要进行哈希处理* fn：名字 — 需要进行哈希处理* ln：姓氏 — 需要进行哈希处理* ge：性别 — 需要进行哈希处理* db：出生日期 — 需要进行哈希处理* ct：城市 — 需要进行哈希处理* st：州/省 — 需要进行哈希处理* zp：邮编 — 需要进行哈希处理* country：国家/地区 — 需要进行哈希处理* external_id：外部编号 — 推荐进行哈希处理* client_ip_address：客户端 IP 地址 — 无需进行哈希处理* client_user_agent：客户端用户代理 — 无需进行哈希处理* fbc：点击编号 — 无需进行哈希处理* fbp：浏览器编号 — 无需进行哈希处理* subscription_id：订阅编号 — 无需进行哈希处理* fb_login_id：Facebook 登录编号 — 无需进行哈希处理* lead_id：潜在客户编号 — 无需进行哈希处理* anon_id：安装编号 — 无需进行哈希处理（注意：此参数仅用于应用事件）* madid：移动广告客户编号 — 无需进行哈希处理（注意：此参数仅用于应用事件）* page_id：公共主页编号 — 无需进行哈希处理* page_scoped_user_id：公共主页范围用户编号 — 无需进行哈希处理* ctwa_clid：WhatsApp 直达广告编号 — 无需进行哈希处理* ig_account_id：Instagram 账户编号 — 无需进行哈希处理* ig_sid：Instagram 直达广告编号 — 无需进行哈希处理
--customData
否
自定义数据* 包含事件其他企业数据的映射。详情请参阅自定义数据参数。Key值:* 标准字段 * availability * body_style * checkin_date * city * condition_of_vehicle * content_ids * content_type * contents * country * currency * delivery_category * departing_arrival_date * departing_departure_date * destination_airport * destination_ids * dma_code * drivetrain * exterior_color * fuel_type * hotel_score * interior_color * lead_event_source * lease_end_date * lease_start_date * listing_type * make * mileage.unit * mileage.value * model * neighborhood * net_revenue * num_adults * num_children * num_infants * num_items * order_id * origin_airport * postal_code * predicted_ltv * preferred_baths_range * preferred_beds_range * preferred_neighborhoods * preferred_num_stops * preferred_price_range * preferred_star_ratings * price * product_catalog_id * property_type * region * returning_arrival_date * returning_departure_date * search_string * state_of_vehicle * suggested_destinations * suggested_home_listings * suggested_hotels * suggested_jobs * suggested_local_service_businesses * suggested_location_based_items * suggested_vehicles * transmission * travel_class * travel_end * travel_start * trim * user_bucket * value * vin * year
--eventSourceUrl
String
否
事件来源URL* 事件发生的浏览器网址。该网址应与已认证的网域一致。 * 注意：event_source_url 是使用转化 API 分享网站事件的必要项。
--optOut
否
是否注销表示不应将此事件用于广告投放优化的标记。设置为 true 时，该事件仅可用作归因条件。
--dataProcessingOptions
List
否
数据处理选项您希望为特定事件启用的处理选项。对于“限制数据使用”，当前可接受的值为 LDU。您可以发送一个空数组来明确指定，不得使用“受限数据使用”限制来处理此事件。详细了解数据处理选项。请参阅转化 API 实现示例。
--dataProcessingOptionsCountry
Integer
否
数据处理选项国家/地区您希望为特定事件启用的处理选项国家/地区。对于“限制数据使用”，当前可接受的值为 LDU。您可以发送一个空数组来明确指定，不得使用“受限数据使用”限制来处理此事件。详细了解数据处理选项。请参阅转化 API 实现示例。
--dataProcessingOptionsState
Integer
否
数据处理选项状态在某些情况下为必要项。（查看下方备注以了解详情。） 您希望与此数据处理选项相关联的州/省。当前可接受值为 1000（代表加利福尼亚州），或者 0（请求我们为此事件进行地理定位）。 请注意： *如果您设置国家/地区，则必须同时设置州/省。否则，我们会将我们的地理位置逻辑应用于整个事件。 * 如果您在 data_processing_options 下发送 LDU 而不提供 IP 地址，则此字段为必要项。
--referrerUrl
String
否
触发转化 API 或 Meta Pixel 像素代码事件的页面所发现的 HTTP 来源网址标头。这通常是浏览器中的前一页。
--appData
Object
否
应用数据* 这些参数用于将应用数据和设备信息分享给转化 API。 * extinfo 是 app_data 的子参数。
-- -- advertiserTrackingEnabled
Boolean
否
使用此字段在 iOS 14.5+ 设备上指定 ATT 权限。设置为0为禁用或1为启用。
-- -- applicationTrackingEnabled
Boolean
否
应用程序事件需要一个人可以选择在应用程序级别启用广告跟踪。您的SDK应该允许应用程序开发人员将选择退出设置放入其应用程序中。使用此字段来指定人员的选择。禁用时使用：0，启用时使用：1。`
-- -- extinfo
List
否
应用程序事件需要* 扩展的设备信息，如屏幕宽度和高度。此参数是一个数组，值用逗号分隔。使用extinfo时，所有值都是必需的，并且必须按照以下索引的顺序。如果缺少一个值，请用空字符串作为占位符填充。 * 笔记： * version必须是安卓的a2 * version必须是iOS版i2 索引的顺序：* 0、字符串 必填、extinfo版，示例：i2 * 1、字符串 必填、应用程序包名称、示例：com.facebook.sdk.samples.hellofacebook * 2、字符串 短版本（整或字符串） 示例：1.0 * 3、字符串 长版本 示例：1.0 long * 4、字符串 必填 操作系统版本 示例：13.4.1 * 5、字符串 设备型号名称 示例：iPhone5,1 * 6、字符串 区域 示例：En_US * 7、字符串 时区缩写 示例：PDT * 8、字符串 载体 示例：AT&T * 9、字符串 屏幕宽度 示例：320 * 10、 字符串 屏幕高度 示例：568 * 11、字符串 屏幕密度 示例：2 * 12、字符串 中央处理器核心 示例：2 * 13、字符串 外部存储大小（GB） 示例：13 * 14、字符串 GB外部存储的可用空间 示例：8 * 15、字符串 设备时区 示例：USA/New York/
-- -- campaignIds
String
否
第三方安装推荐器，目前仅适用于安卓。
-- -- installReferrer
String
否
第三方安装推荐器，目前仅适用于安卓
-- -- installerPackage
String
否
由Android SDK内部使用
-- -- urlSchemes
List
否
由iOS和Android SDK内部使用。
-- --vendorId
String
否
供应商ID
-- --windowsAttributionId
String
否
用于Windows 10的归因令牌。
请求示例
响应示例
最后更新于