adjust-icon

S2S 第三方分享

通过 Adjust,您可以管理如何与第三方分享数据来用于统计目的。这能让用户在数据处理方面拥有更多选择。在这里,您可以找到如何通过服务器到服务器 (S2S) 的方式启用 (或重新启用) 和禁用第三方数据分享的指南。

终端

API 终端请求地址为:

终端
https://s2s.adjust.com/third_party_sharing

使用 POST 请求与 API 进行交互。您还可以在 URL 中或作为表单数据 (form data) 发送终端参数。

必要参数

参数名称
gps_adid, idfa设备 ID 字符串。需要至少提供一个设备 ID。本 API 支持的设备 ID 类型与其他 Adjust S2S API 相同。
s2s始终为 1
app_token应用识别码
sharingenabledisable,分别代表允许或阻止第三方数据共享。
partner_sharing_settings更新合作伙伴设置。
granular_third_party_sharing_options针对合作伙伴的精细第三方数据分享选项。

全局设置

all 参数是一种灵活的快捷方式,可用于简化合作伙伴分享设置:

  • all 作为 合作伙伴名称 ,表示该设置适用于所有合作伙伴。
  • all 作为 活动名称 (例如安装或会话),表示该设置适用于所有活动类型。
  • 您可以同时使用两者,应用或限制 所有合作伙伴的全部活动

使用此功能,快速禁用 (或启用) 数据分享,然后针对特定合作伙伴或活动类型,有选择地重新启用或禁用数据分享。

更新合作伙伴分享设置

要更新个别合作伙伴的第三方共享设置,您需要以 partner_sharing_settings 参数的形式传递更新后的设置。第三方共享设置必须以 URL 编码的表单对象形式进行传递。您可以传递多个对象,一次性更改多个设置。

您必须在每个合作伙伴分享设置表单中传递以下密钥:

参数名称
partnerName要更新其共享设置的合作伙伴 ID 或名称。下载可用合作伙伴的完整列表
key您希望停止或开始与合作伙伴分享的数据。
value启用 (true) 或禁用 (false) 与合作伙伴分享指定数据。

您可以使用key来指定要禁用或重新启用的指标。如果您想启用/禁用所有指标的分享,可以使用all键。可用指标的完整列表如下:

  • ad_revenue
  • all
  • update
  • att_update
  • 事件
  • 安装
  • 再归因
  • reattribution_reinstall
  • 重装
  • rejected_install
  • rejected_reattribution
  • sdk_click
  • sdk_info
  • 会话
  • subscription
  • 卸载

指标组

当您针对合作伙伴的指标设置 false 值时,Adjust 将停止与该合作伙伴分享该指标,以及指标组中的所有子级指标。这些嵌套组包括:

  • 会话
    • 安装

      • rejected_install
    • 重装

    • 再归因

    • rejected_reattribution

    • reattribution_reinstall

此处:

  • 如果禁用 session 分享,那么它的所有子级指标也将被禁用。
  • 如果您禁用 session 共享,但启用了 reattribution 共享,那么除 reattribution 外的所有对应子级指标都将被禁用。
  • 如果您禁用 session 共享,但启用了 install 共享,那么除 install 外的所有 session 子级指标都将被禁用。install 的子级指标将保持启用状态。
  • 如果您启用 session 共享,但禁用了 install 共享,那么除 install 外的所有 session 子级指标都将被启用。install 的子级指标将保持禁用状态。

使用案例

下面是几个常见的使用案例。这些示例针对 S2S 使用 Android SDK 和 curl。iOS 实施遵循相同的逻辑,使用特定于平台的语法。

禁用合作伙伴 A 以外的所有合作伙伴活动数据分享

Adjust 只会与合作伙伴 A 分享所有数据。

请求
curl -G \
--data-urlencode 's2s=1' \
--data-urlencode 'app_token=36wbd8gmlvsw' \
--data-urlencode 'idfa=105C1794-7CF8-43A3-9C3F-B0DCEA2D29A9' \
--data-urlencode 'partner_sharing_settings={"all":{"all":false},"PartnerA":{"all":true}}' \
https://s2s.adjust.com/third_party_sharing

禁用除会话活动外的所有数据分享

Adjust 将停止分享所有合作伙伴数据, 会话 及其相关事件 (如安装或再归因) 除外。

请求
curl -G \
--data-urlencode 's2s=1' \
--data-urlencode 'app_token=36wbd8gmlvsw' \
--data-urlencode 'idfa=105C1794-7CF8-43A3-9C3F-B0DCEA2D29A9' \
--data-urlencode 'partner_sharing_settings={"all":{"all":false,"session":true}}' \
https://s2s.adjust.com/third_party_sharing

仅允许将会话活动发送给合作伙伴 A

针对合作伙伴 A 禁用所有合作伙伴数据分享, 会话 及其相关事件 (如安装或再归因) 除外。

请求
curl -G \
--data-urlencode 's2s=1' \
--data-urlencode 'app_token=36wbd8gmlvsw' \
--data-urlencode 'idfa=105C1794-7CF8-43A3-9C3F-B0DCEA2D29A9' \
--data-urlencode 'partner_sharing_settings={"all":{"all":false},"PartnerA":{"session":true}}' \
https://s2s.adjust.com/third_party_sharing

仅禁用动态回传

禁用通过动态创建回传进行的分享,但不会影响正常的合作伙伴集成。

请求
curl -G \
--data-urlencode 's2s=1' \
--data-urlencode 'app_token=36wbd8gmlvsw' \
--data-urlencode 'idfa=105C1794-7CF8-43A3-9C3F-B0DCEA2D29A9' \
--data-urlencode 'partner_sharing_settings={"dynamic_callbacks":{"all":false}}' \
https://s2s.adjust.com/third_party_sharing

错误处理

third_party_sharing endpoint 使用 HTTP 响应状态代码来传达每个请求的状态。返回的状态代码如下:

200

请求的所有部分均有效且已应用。

响应
{
"status": "OK"
}

202

请求的某些部分无效,例如合作伙伴 ID 不存在、共享选项格式不正确等。有效的部分将被应用,终端将返回请求中问题的详细信息。

响应
{
“error”: "Third party sharing failed (<error_message>)"
}

400

请求格式不正确,或未包含必需参数,或包含无效数据。

响应
{
"error": "Third party sharing failed (App not found)"
}

符合欧盟的《数字市场法案》(Digital Markets Act,简称 DMA),Google Ads 和 Google Marketing Platform 需要获得明确的用户许可,才能接收 Adjust 向其 API 发送的归因请求。

如果用户更改了许可权限,您可以使用 Adjust 的重启/禁用第三方分享 API 来与我们分享此信息。请在您的请求中发送以下参数:

密钥描述
eea
  • 1 = 用户位于 EEA 且 DMA 适用
  • 0 = 用户不位于 EEA 且 DMA 不适用
eea 参数可以告知 Google 用户是否位于 EEA,即包含 DMA 在内的欧洲法律法规是否适用于该用户和转化,参数类型为布尔值。
ad_personalization
  • 1 = 用户已授权
  • 0 = 用户未授权
针对 Google Ads 。ad_personalization 参数指明用户在安装应用后是否同意通过 Google Ads 接收个性化广告,即 Google 是否有权对用户进行再营销。
ad_user_data
  • 1 = 用户已授权
  • 0 = 用户未授权
ad_user_data 参数可告知 Google 用户是否同意分享个人数据用于监测目的。该许可适用于广告主在 Google Ads 和 Google Marketing Platform 用户界面中指定的所有核心平台服务 (CPS)。
npa
  • 1 = 用户已授权
  • 0 = 用户未授权
针对 Google Marketing Platform 。npa 参数指示用户在安装应用后是否同意通过 Google Marketing Platform 接收个性化广告,即 Google 是否有权对用户进行再营销。

请注意,如果您正在使用 Google Ads,则需要发送 ad_personalization 参数;如果您正在使用 Google Marketing Platform,则需要发送 npa 参数。

示例

请求
curl -X POST \
'https://s2s.adjust.com/third_party_sharing?s2s=1&sharing=enable&app_token=abc123abc123&gps_adid=10820328-872d-43a2-9786-0ccc748335d9' \
-H 'Content-Type: application/json' \
-d '{
"granular_third_party_sharing_options": {
"google_dma": {
"ad_personalization": "1",
"eea": "1",
"ad_user_data": "1",
"npa": "0"
}