多账户专用转化 API 网关控制平面 API：参考文档
对象
Tenant
| 字段 | 描述 | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| 此账户的唯一标识符 | ||||||||
| 此账户的名称 | ||||||||
| 可使用 3 个值来表示账户状态：
| ||||||||
| 此标记表示某个合作伙伴能否管理此账户 | ||||||||
| 此账户的用户名单 | ||||||||
| 此账户的可用身份 | ||||||||
| 此标记表示用户能否修改 Pixel 像素代码、网域等账户设置。 | ||||||||
| 此标记表示用户实际上能否在用户界面中查看账户详情。 | ||||||||
| 此标记表示用户能否在账户用户名单中添加/移除用户或更改其权限。 | ||||||||
| 有关租户使用情况的信息。 |
User
| 字段 | 描述 | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| 此用户的唯一标识符 | ||||||||
| 用户的邮箱 | ||||||||
| 可使用 3 个值来表示用户状态：
| ||||||||
| 用户身份清单 | ||||||||
| 用户所属的账户 | ||||||||
| 表示已登录的用户是否是同一用户（使用 API 时，值将始终为 false）。 | ||||||||
| 表示用户是一个/多个账户的唯一管理员，因此无法删除。 | ||||||||
| 当前用户的默认账户编号。 |
Role
| 字段 | 描述 |
|---|---|
| 身份的全称。 可以是代理商（合作伙伴）用户或广告主（账户）用户的身份。 身份名称遵循以下格式： 合作伙伴：agency-[ROLE-ACTION] 广告主：advertiser-[ROLE-ACTION]-[tenantId] [ROLE-ACTION] — 描述了此身份的职责。可使用以下 3 个值之一：
[tenantId] — 要向用户分配身份的账户的编号 |
| 此身份的 [ROLE-ACTION] |
UserType
| 值 | 描述 |
|---|---|
AGENCY | 适用于合作伙伴/主机 |
ADVERTISER | 适用于租户/账户。 |
SignalConfig
| 字段 | 描述 |
|---|---|
| 格式 |
| Pixel 像素代码编号 |
| Pixel 像素代码的连接状态 |
ConnectionStatus
| 字段 | 描述 |
|---|---|
| Pixel 像素代码连接 |
| 指示 Pixel 像素代码编号和访问口令是否存在。 |
| 指示 Pixel 像素代码是否正在工作。 |
| 指示 Event Bridge 对 Pixel 像素代码是否有效。 |
| 指示事件能否发布。 |
| Event Bridge 的访问密钥 |
| 发布到 Meta 转化 API 过程中的最后一个错误代码。值将采用格式 |
| Pixel 像素代码的唯一标识符 |
| Pixel 像素代码的名称 |
| 指示是否存在发布到转化 API 所需要的访问口令 |
| 已发布事件总数 |
| 上个已发布事件的时间戳 |
| 收到的事件总数 |
| 上个已收到事件的时间戳 |
IngressDomain
| 字段 | 描述 |
|---|---|
| 入口网域的唯一编号 |
| 此账户的名称 |
| 广告主网域 |
| |
| 广告主网域的 CName 已通过认证 |
EnhancementTenantIngressVerifiedResult
| 字段 | 描述 |
|---|---|
| 格式 |
| 表示增强功能的有效域 |
EventFilter
| 字段 | 描述 |
|---|---|
| 事件筛选条件的唯一标识符 |
| 事件的名称 |
| 此筛选条件将应用到的 Pixel 像素代码。如果此筛选条件将应用到所有 Pixel 像素代码，此字段值将为“null”。 |
| 事件筛选条件的状态 |
EventFilterState
| 值 |
|---|
PUBLISH |
DROP |
MIXED |
DomainFilter
| 字段 | 描述 |
|---|---|
| 网域筛选条件的唯一标识符 |
| 网域的名称 |
| 此筛选条件将应用到的 Pixel 像素代码。如果此筛选条件将应用到所有 Pixel 像素代码，此字段值将为“null”。 |
| 事件筛选条件的状态 |
DomainFilterState
| 值 |
|---|
PUBLISH |
DROP |
MIXED |
EventTrafficSummary
| 字段 | 描述 |
|---|---|
| EventTrafficSummary 的标识符 — 始终表示为 EventTrafficSummary:incoming |
| 已收到事件名称的数量 |
| 收到的事件总数 |
ConversionsApiPublishSummary
| 字段 | 描述 |
|---|---|
| ConversionsApiPublishSummary 的标识符 — 始终表示为 ConversionsApiPublishSummary:global |
| 已发送事件名称的数量 |
| 已发送事件总数 |
| 事件发布的成功率 |
EventActivity
| 字段 | 描述 |
|---|---|
| 以下格式 EventActivity 的标识符 — EventActivity: |
| 事件名称 |
| 收到的事件总数 |
| 已发布事件总数 |
| 上次更新时间 |
DomainActivity
| 字段 | 描述 |
|---|---|
| 以下格式 DomainActivity 的标识符 — DomainActivity: |
| 域名 |
| 收到的事件总数 |
| 已发布事件总数 |
TenantUsage
| 字段 | 描述 |
|---|---|
| 此账户的 Pixel 像素代码总数 |
| 此账户的工作中的 Pixel 像素代码总数 |
| 此账户的未工作的 Pixel 像素代码总数 |
| 按流量划分的租户使用情况 |
TenantUsageByTraffic
| 字段 | 描述 |
|---|---|
| 一个租户在一段时间内收到的事件总数 |
| 一段时间内具有流量的 Pixel 像素代码总数 |
| 一段时间内发布到转化 API 时出现的错误 |
| 一段时间内已发布到转化 API 的事件总数 |
| 时长 |
| 上次更新时间 |