Guias

API do Plano de Controle do Conversions API Gateway para várias contas: referência

Objetos

Tenant

CampoDescrição

id
String

Identificador único da conta.

name
String

Nome da conta.

status
Número inteiro

O status da conta pode ter 3 valores que indicam o estado:


ValorDescrição

0

Ativo

1

Configuração pendente

2

Desativado

canPartnerManage
Booleano

Esta sinalização indica se um parceiro pode gerenciar a conta.

users
Usuário

Lista de usuários na conta.

availableRoles
Função

Funções disponíveis para a conta.

canEditTenantSettingsInUI
Booleano

Esta sinalização indica se o usuário pode modificar configurações da conta, como Pixels, domínios e assim por diante.

canViewTenantInUI
Booleano

Esta sinalização indica se o usuário pode realmente visualizar os detalhes da conta na interface.

canEditTenantUsersInUI
Booleano

Esta sinalização indica se um usuário pode adicionar/remover pessoas na lista de usuários da conta ou alterar as respectivas permissões.

tenantUsage
TenantUsage

Informações de uso do locatário.

User

CampoDescrição

id
String

Identificador único do usuário.

email
String

Endereço de email do usuário.

status
Número inteiro

O status do usuário pode ter 3 valores que indicam o estado:


ValorDescrição

0

Desativado

1

Ativado

2

Pendente

roles
Função

Lista de funções do usuário.

tenants
Locatário

Contas às quais o usuário pertence.

isSelf
Booleano

Indica se a pessoa conectada representa o mesmo usuário (sempre "Falso" com a API).

canBeDeleted
Booleano

Indica que o usuário é o único administrador de uma/mais contas, portanto não pode ser excluído.

userExpiry
String

Data de validade do usuário temporário, no formato de sequência de datas "aaaa-mm-dd".


Role

CampoDescrição

name
String

Nome completo da função.


As funções podem ser destinadas a usuários de agência (parceiros) ou usuários de anunciantes (contas).


O nome da função tem o seguinte formato:

Para parceiros: agency-[ROLE-ACTION]


Para anunciantes: advertiser-[ROLE-ACTION]-[tenantId]


[ROLE-ACTION]: descreve a responsabilidade da função. Pode conter um destes 3 valores:

  1. admin
  2. user
  3. view

[tenantId]: a identificação da conta que tem funções sendo atribuídas aos usuários.

displayName
String

É a [ROLE-ACTION] da função.

tenantName
String

Nome do locatário ou da conta.

UserType

ValorDescrição

AGENCY

Para parceiros/hosts.

ADVERTISER

Para locatários/contas.

SignalConfig

CampoDescrição

id
ID

Identificador único do formato SignalConfig:<pixel id>.

connectionId
String

A identificação do Pixel.

connectionStatus
ConnectionStatus

O status de conexão do Pixel.

domains
String

Lista de domínios.

dataSetType
String

Tipo de string do conjunto de dados:

  • PIXEL
  • PRIVATE_COMPUTE
  • INDEPENDENT_PIXEL
  • ADVERTISER_HOSTED_SDK
  • EMPTY
  • UNKNOWN

ConnectionStatus

CampoDescrição

id
ID

Identificador único da conexão do Pixel ConnectionStatus:<pixel id>.

connected
Booleano

Indica se a identificação do Pixel e o token de acesso estão presentes.

active
Booleano

Indica se o Pixel está ativo ou não.

eventBridgeActive
Booleano

Indica se o evento Bridge está ativo para o Pixel.

publishingEnabled
Booleano

Indica se os eventos podem ser publicados.

accessKey
String

Chave de acesso para o evento Bridge.

apiErrorCode
String

Último código de erro sobre a publicação na API de Conversões da Meta. O valor terá o formato <error code>.<error subcode>. (Referência)

pixelID
String

Identificador único do Pixel.

pixelName
String

Nome do Pixel.

accessTokenAvailable
Booleano

Indica se o token de acesso para publicar na API de Conversões está presente.

totalEventsPublished
Float

Total de eventos publicados.

lastPublished
Float

Registro de data e hora do último evento publicado.

totalEventsReceived
Float

Total de eventos recebidos.

lastReceived
Float

Registro de data e hora do último evento recebido.

IngressDomain

CampoDescrição

id
ID

ID único para a entrada.

tenantName
String

Nome da conta.

ingress
String

Domínio do anunciante.

cnameResolveSuccess
Booleano

O CName do domínio do anunciante é verificado.

EventFilter

CampoDescrição

eventName
String

Nome do evento.

pixelId
String

O Pixel ao qual o filtro se aplica. Será nulo se o filtro for aplicado a todos os Pixels.

filterState
EventFilterState

Estado do filtro de evento.

EventFilterState

Valor

PUBLISH

DROP

MIXED

DomainFilter

CampoDescrição

eventName
String

Nome do domínio.

pixelId
String

O Pixel ao qual o filtro se aplica. Será nulo se o filtro for aplicado a todos os Pixels.

filterState
DomainFilterState

Estado do filtro de evento.

DomainFilterState

Valor

PUBLISH

DROP

MIXED

EventTrafficSummary

CampoDescrição

id
ID

Identificador para EventTrafficSummary – sempre EventTrafficSummary:incoming

eventNamesCount
Número inteiro

Contagem dos nomes de eventos recebidos.

eventsCount
Número inteiro

Total de eventos recebidos.

ConversionsApiPublishSummary

CampoDescrição

id
ID

Identificador para ConversionsApiPublishSummary – sempre ConversionsApiPublishSummary:global

eventNamesCount
Número inteiro

Contagem dos nomes de eventos enviados.

eventsCount
Número inteiro

Total de eventos enviados.

publishSuccessRate
Float

Taxa de sucesso relativa à publicação de eventos.

EventActivity

CampoDescrição

id
ID

Identificador para EventActivity do formato – EventActivity:<event name>

name
String

Nome do evento.

receivedCount
Número inteiro

Total de eventos recebidos.

publishedCount
Número inteiro

Total de eventos publicados.

lastUpdated
String

Horário da última atualização.

DomainActivity

CampoDescrição

id
ID

Identificador único para DomainActivity do formato – DomainActivity:<domain name>

domainName
String

Nome do domínio.

receivedCount
Número inteiro

Total de eventos recebidos.

publishedCount
Número inteiro

Total de eventos publicados.

TenantUsage

CampoDescrição

totalPixels
Número inteiro

Total de Pixels na conta.

totalActivePixels
Número inteiro

Total de Pixels ativos na conta.

totalInactivePixels
Número inteiro

Total de Pixels inativos na conta.

tenantUsageByTraffic
TenantUsageByTraffic

Uso do locatário por tráfego.

pixelIds
String

Lista de identificações de Pixels associadas.

TenantUsageByTraffic

CampoDescrição

totalEventsReceived
Duração

Total de eventos recebidos para um locatário durante um período específico.

totalPixelsWithTraffic
Número inteiro

Número total de Pixels com tráfego durante um período específico.

publishError
Booleano

Erro ao publicar na API de Conversões durante um período específico.

durationInHours
Número inteiro

A duração do período.

lastUpdatedAt
String

Última atualização.

Veja também