中文(台灣) 的翻譯尚未完成。
中文(台灣) 更新時間：
Conversions API Gateway for Multiple Accounts Control Plane API: Reference
Objects
Tenant
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Unique identifier of the account | ||||||||
| Name of the account | ||||||||
| Account status can have 3 values indicating its state:
| ||||||||
| This flag indicates whether a partner can manage this account | ||||||||
| List of users in the account | ||||||||
| Available roles for the account | ||||||||
| This flag indicates whether user can modify account settings like Pixels, domains, and so on. | ||||||||
| Ths flag indicates whether the user can actually view the account detail in UI. | ||||||||
| This flag indicates whether a user can add/remove users in account user list, or change their permissions. | ||||||||
| Tenant Usage info. |
User
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Unique identifier of the user | ||||||||
| User’s email address | ||||||||
| User status can have 3 values indicating its state:
| ||||||||
| List of roles of the user | ||||||||
| Accounts to which the user belongs | ||||||||
| This indicates whether the logged in user is the same user (would be always false with api). | ||||||||
| This indicates that the user is the only admin of one/more of the accounts, so it can't be deleted. | ||||||||
| Expiration date for temporary user, in the format of date string “yyyy-mm-dd”. |
Role
| Field | Description |
|---|---|
| Full name of the role. Roles can be for agency (partner) users or advertisers (account) users. Role name follows the following format: For partner: agency-[ROLE-ACTION] For advertisers: advertiser-[ROLE-ACTION]-[tenantId] [ROLE-ACTION] -- This describes the responsibility of the role. It can have one of the 3 values:
[tenantId] - The id of the account whose roles are being assigned to users |
| This is the [ROLE-ACTION] of the role |
| Name of the tenant/account. |
UserType
| Value | Description |
|---|---|
AGENCY | This is for partners/host |
ADVERTISER | This is for tenant/account. |
SignalConfig
| Field | Description |
|---|---|
| Unique identifier of the format |
| The Pixel ID |
| Connection status of the Pixel |
| List of domains. |
| Type string of dataset:
|
ConnectionStatus
| Field | Description |
|---|---|
| Unique identifier of the Pixel connection |
| Indicates whether Pixel ID and access token are present. |
| Indicating whether Pixel is active or not. |
| Indicating whether Event Bridge is active for the Pixel. |
| Indicating whether events can be published. |
| Access Key for Event Bridge |
| Last error code from publishing to Meta Conversions API. Value will be of the format |
| The unique identifier of the Pixel |
| Name of the Pixel |
| Access token to publish to the Conversions API present or not |
| Total events published |
| Timestamp of last event published |
| Total events received |
| Timestamp of last event received |
IngressDomain
| Field | Description |
|---|---|
| Unique ID for the ingress |
| Name of the account |
| Advertiser domain |
| Advertiser domain’s CName is verified |
EventFilter
| Field | Description |
|---|---|
| Name of the event |
| The Pixel that the filter applies to. It is null if the filter is applied to all the Pixels. |
| State of the event filter |
EventFilterState
| Value |
|---|
PUBLISH |
DROP |
MIXED |
DomainFilter
| Field | Description |
|---|---|
| Name of the domain |
| The Pixel that the filter applies to. It is null if the filter is applied to all the Pixels. |
| State of the event filter |
DomainFilterState
| Value |
|---|
PUBLISH |
DROP |
MIXED |
EventTrafficSummary
| Field | Description |
|---|---|
| Identifier for EventTrafficSummary - always EventTrafficSummary:incoming |
| Count of the event names received |
| Total events received |
ConversionsApiPublishSummary
| Field | Description |
|---|---|
| Identifier for ConversionsApiPublishSummary - always ConversionsApiPublishSummary:global |
| Count of the event names sent |
| Total events sent |
| Success rate of publishing events |
EventActivity
| Field | Description |
|---|---|
| Identifier for EventActivity of the format - EventActivity: |
| Event name |
| Total events received |
| Total events published |
| Last updated time |
DomainActivity
| Field | Description |
|---|---|
| Unique identifier for DomainActivity of the format - DomainActivity: |
| Domain name |
| Total events received |
| Total events published |
TenantUsage
| Field | Description |
|---|---|
| Total pixels in the account |
| Total active pixels in the account |
| Total inactive pixels in the account |
| Tenant usage by traffic |
| List of associated pixel ids |
TenantUsageByTraffic
| Field | Description |
|---|---|
| Total events received for a Tenant for a duration |
| Total number of pixels with traffic for a duration |
| Error publishing to CAPI for a duration |
| The duration |
| Last updated at |
See Also
- Conversions API Gateway for Multiple Accounts Control Plane API
- Control Plane API: Reference
- Control Plane API Reference: Account Management
- Control Plane API Reference: User Management
- Control Plane API Reference: Pixel Management
- Control Plane API Reference: Account Data Routing Configuration
- Control Plane API Reference: Account Event Metrics