adjust-icon

应用设置终端

使用 /app/{app_token}/settings 终端调取详细的应用设置。该终端提供应用配置的综合信息,包括事件、合作伙伴、归因设置等。

获取应用设置

调取特定应用的详细设置信息。您可以请求所有设置,或按特定部分过滤。

API 协议

终端: https://automate.adjust.com/app-automation/app/{app_token}/settings

方法: GET

响应: 应用设置响应

参数

参数数据类型位置必要参数描述
app_tokenStringPathAdjust 应用识别码,
sectionsArray[String]查询过滤器到特定部分。如果未提供,则返回全部。

可用部分

该终端支持应用设置响应中列出的所有部分。

示例

获取所有应用设置

请求 - cURL
curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings' \
--header 'Authorization: Bearer {your-adjust-api-token}'
响应
{
"app_info": {
"id": 12345,
"name": "My App",
"app_token": "abc123xyz",
"default_platform": "android",
"stores": {
"google_play": { "store_id": "com.example.myapp" }
}
},
"events": [
{
"name": "purchase",
"unique": false,
"archived": false,
"token": "abc1de",
"app_token": "abc123xyz"
},
{
"name": "registration",
"unique": true,
"archived": false,
"token": "fgh2ij",
"app_token": "abc123xyz"
}
],
"partners": [
{
"name": "facebook",
"revenue_forwarding": true,
"session_forwarding": false,
"parameter_forwarding": true,
"events_linking": { "purchase": "fb_purchase" }
}
],
"attribution_settings": {
"click_device_matching": { "window": 604800, "enabled": true },
"click_fingerprinting": { "window": 86400, "enabled": true },
"impression_device_matching": { "window": 86400, "enabled": true }
}
}

仅获取特定部分

请求 - cURL
curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings?sections=events&sections=partners' \
--header 'Authorization: Bearer {your-adjust-api-token}'
响应
{
"events": [
{
"name": "purchase",
"unique": false,
"archived": false,
"token": "abc1de",
"app_token": "abc123xyz"
}
],
"partners": [
{
"name": "facebook",
"revenue_forwarding": true,
"session_forwarding": false,
"events_linking": {}
}
]
}

获取 SDK 密钥 (包括 v3)

请求 - cURL
curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings?sections=combined_secrets' \
--header 'Authorization: Bearer {your-adjust-api-token}'
响应
{
"combined_secrets": {
"enforce_install_signing": true,
"secrets": [
{
"id": 1001,
"name": "Production Secret",
"active": true,
"value": ["secret1", "secret2", "info1", "info2"],
"internal_version": 2,
"version": 2,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
{
"id": 2001,
"platform": "android",
"label": "Android SDK Secret",
"active": true,
"algorithm": "adj1",
"internal_version": 2,
"version": 3,
"created_at": "2024-06-01T12:00:00Z",
"updated_at": "2024-06-01T12:00:00Z"
}
]
}
}

以 CSV 格式获取设置

以 CSV 格式导出应用设置。当前支持事件导出。

API 协议

终端: https://automate.adjust.com/app-automation/settings/csv

方法: GET

响应 :CSV 文件内容

参数

参数数据类型位置必要参数描述
sectionString查询要导出的部分。当前仅支持 events
app_tokensString查询要包含在导出中的应用识别码列表,用逗号隔开。

示例

请求 - cURL
curl --location 'https://automate.adjust.com/app-automation/settings/csv?section=events&app_tokens=abc123xyz,def456uvw' \
--header 'Authorization: Bearer {your-adjust-api-token}'
响应 (CSV 格式)
app_token,event_name,event_token,unique,archived
abc123xyz,purchase,abc1de,false,false
abc123xyz,registration,fgh2ij,true,false
def456uvw,purchase,klm3no,false,false
def456uvw,level_complete,pqr4st,false,false

数据模型

应用设置响应

所有字段均为可选,只有在请求对应部分时才会被包含。

参数数据类型描述
app_infoObject基本应用信息。
attribution_privacy_modelString归因隐私模型 (仅限 iOS)。
attribution_settingsObject归因窗口配置。
callbacksArray[Object]服务器回传配置。
csv_upload_settingsObject云储存上传设置。
eventsArray[Object]事件定义。
external_data_forwardingObject数据转发设置。
fraud_prevention_settingsObject防作弊配置
partnersArray[Object]合作伙伴模块配置。
purchase_verificationObject收入验证设置。
signatureObject包括 Android 指纹在内的签名设置。
sdk_secretsObject旧版 SDK 密钥配置。
combined_secretsObject所有 SDK 密钥 (旧版 + v3)。
skad_networkObjectSKAdNetwork v3 设置。
skad_network_v4ObjectSKAdNetwork v4 设置。
preview_link_settingsObject社交分享预览设置。
s2sObjectS2S 安全设置。
trackersArray[Object]跟踪链接设置。

事件设置

参数数据类型描述
name*String事件名称。
unique*Boolean事件是否对于每个用户唯一。
archived*Boolean链接是否已被归档。
token*StringSDK 集成事件识别码。
app_token*String该事件所属的应用识别码。

合作伙伴设置

参数数据类型描述
name*String合作伙伴名称/slug。
revenue_forwardingBoolean是否转发收入数据。
session_forwardingBoolean是否转发会话数据。
parameter_forwardingBoolean是否转发合作伙伴参数。
cost_forwardingBoolean是否转发成本数据。
attributed_onlyBoolean是否仅转发已归因数据。
uninstall_forwardingBoolean是否转发卸载数据。
ad_revenue_forwardingBoolean是否转发广告收入。
channel_setupObject合作伙伴特定配置。
events_linkingObject该合作伙伴的事件名称映射。

组合密钥响应

参数数据类型描述
enforce_install_signing*Boolean是否拒绝签名不符合要求的安装。
secrets*Array[Object]所有 SDK 密钥列表,包括旧版密钥。

旧版密钥

参数数据类型描述
id*Integer密钥 ID。
nameString密钥名称/标签。
active*Boolean密钥是否已激活。
value*Array[String]密钥值。
internal_version*IntegerSDK 签名库版本。
version*IntegerSDK 密钥版本 (1 或 2)。
created_at*String创建时的 ISO 日期时间。
updated_at*String上次更新的 ISO 日期时间。

SDK 密钥 ID

参数数据类型描述
id*Integer密钥 ID。
platform*String定向平台 (androidios)。
label*String密钥标签。
active*Boolean密钥是否已激活。
algorithm*String签名算法。
internal_version*IntegerSDK 签名库版本。
version*IntegerSDK 密钥版本 (3 或更高)。
created_at*String创建时的 ISO 日期时间。
updated_at*String上次更新的 ISO 日期时间。