Method: events.ingest

Faz upload de uma lista de recursos Event do Destination fornecido.

Solicitação HTTP

POST https://datamanager.googleapis.com/v1/events:ingest

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  }
}
Campos
destinations[]

object (Destination)

Obrigatório. A lista de destinos para onde os eventos serão enviados.
events[]

object (Event)

Obrigatório. A lista de eventos a serem enviados aos destinos especificados. No máximo 2.000 recursos Event podem ser enviados em uma única solicitação.
consent

object (Consent)

Opcional. Consentimento no nível da solicitação para aplicar a todos os usuários na solicitação. O consentimento no nível do usuário substitui o consentimento no nível da solicitação e pode ser especificado em cada Event.
validateOnly

boolean

Opcional. Para fins de teste. Se for true, a solicitação será validada, mas não executada. Somente erros são retornados, não resultados.
encoding

enum (Encoding)

Opcional. Precisa ser fornecido para uploads de UserData. O tipo de codificação dos identificadores de usuário. Para identificadores de usuário com hash, esse é o tipo de codificação da string com hash. Para identificadores de usuário com hash criptografados, esse é o tipo de codificação da string criptografada externa, mas não necessariamente da string com hash interna, o que significa que a string com hash interna pode ser codificada de uma maneira diferente da string criptografada externa. Para uploads que não são de UserData, esse campo é ignorado.
encryptionInfo

object (EncryptionInfo)

Opcional. Informações de criptografia para uploads do UserData. Se não for definido, as informações de identificação pessoal enviadas serão consideradas com hash, mas não criptografadas. Para uploads que não são de UserData, esse campo é ignorado.

Corpo da resposta

Resposta do IngestEventsRequest.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "requestId": string,
  "fieldWarnings": [
    {
      object (FieldWarning)
    }
  ]
}
Campos
requestId

string

O ID gerado automaticamente da solicitação.
fieldWarnings[]

object (FieldWarning)

Avisos detalhados no nível da linha com caminhos de campo.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/datamanager

Evento

Um evento que representa uma interação do usuário com o site ou app de um anunciante.

Representação JSON 
{
  "destinationReferences": [
    string
  ],
  "transactionId": string,
  "eventTimestamp": string,
  "lastUpdatedTimestamp": string,
  "userData": {
    object (UserData)
  },
  "consent": {
    object (Consent)
  },
  "adIdentifiers": {
    object (AdIdentifiers)
  },
  "currency": string,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  },
  "eventName": string,
  "clientId": string,
  "userId": string,
  "additionalEventParameters": [
    {
      object (EventParameter)
    }
  ],
  "thirdPartyUserData": {
    object (UserData)
  },
  "eventLocation": {
    object (EventLocation)
  },
  "appInstanceId": string,
  "callInfo": {
    object (CallInfo)
  },
  "conversionValue": number,
  "conversionCount": number
}
Campos
destinationReferences[]

string

Opcional. String de referência usada para determinar o destino. Se estiver vazio, o evento será enviado para todos os destinations na solicitação.
transactionId

string

Opcional. O identificador exclusivo do evento. Obrigatório para eventos enviados como uma fonte de dados adicional para conversões da tag do Google.
eventTimestamp

string (Timestamp format)

Obrigatório. Hora em que o evento ocorreu

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
lastUpdatedTimestamp

string (Timestamp format)

Opcional. A última vez que o evento foi atualizado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
userData

object (UserData)

Opcional. Dados fornecidos pelo usuário que representam o usuário associado ao evento.
consent

object (Consent)

Opcional. Informações sobre se o usuário associado forneceu diferentes tipos de consentimento.
adIdentifiers

object (AdIdentifiers)

Opcional. Identificadores e outras informações usadas para associar o evento de conversão a outras atividades on-line (como cliques em anúncios).
currency

string

Opcional. O código da moeda associado a todos os valores monetários desse evento.
eventSource

enum (EventSource)

Opcional. Sinal de onde o evento aconteceu (Web, app, na loja etc.).
eventDeviceInfo

object (DeviceInfo)

Opcional. Informações coletadas sobre o dispositivo usado (se houver) quando o evento ocorreu.
cartData

object (CartData)

Opcional. Informações sobre a transação e os itens associados ao evento.
customVariables[]

object (CustomVariable)

Opcional. Informações adicionais de par de chave-valor para enviar aos contêineres de conversão (ação de conversão ou atividade do FL).
experimentalFields[]

object (ExperimentalField)

Opcional. Uma lista de pares de chave-valor para campos experimentais que podem ser promovidos para fazer parte da API.
userProperties

object (UserProperties)

Opcional. Informações avaliadas pelo anunciante sobre o usuário no momento em que o evento ocorreu.
eventName

string

Opcional. O nome do evento. Obrigatório para eventos do GA4.
clientId

string

Opcional. Um identificador exclusivo da instância de usuário de um cliente da Web para esse fluxo da Web do GA4.
userId

string

Opcional. Um identificador exclusivo de um usuário, conforme definido pelo anunciante.
additionalEventParameters[]

object (EventParameter)

Opcional. Um bucket de parâmetros de evento a serem incluídos no evento que ainda não foram especificados usando outros campos estruturados.
thirdPartyUserData

object (UserData)

Opcional. O mesmo tipo de dados fornecido em userData, mas explicitamente sinalizado como sendo de propriedade de terceiros, e não dados próprios do anunciante.
eventLocation

object (EventLocation)

Opcional. Informações coletadas sobre o local do usuário quando o evento ocorreu.
appInstanceId

string

Opcional. Um identificador exclusivo da instância de usuário de um cliente de app para esse fluxo de app do GA4.
callInfo

object (CallInfo)

Opcional. Informações coletadas sobre a chamada (se houver) que levou a esse evento.
conversionValue

number

Opcional. O valor da conversão associado ao evento, para conversões com base no valor.
conversionCount

number

Opcional. A quantidade de conversões associada ao evento, para conversões baseadas em contagem.

AdIdentifiers

Identificadores e outras informações usadas para associar o evento de conversão a outras atividades on-line (como cliques em anúncios).

Representação JSON 
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": string,
  "dclid": string,
  "impressionId": string,
  "matchId": string,
  "encryptedUserIds": [
    {
      object (EncryptedUserId)
    }
  ],
  "ppid": string,
  "visitorPpid": string,
  "leadId": string
}
Campos
sessionAttributes

string

Opcional. Atributos de sessão para atribuição e estimativa de eventos.
gclid

string

Opcional. O ID de clique do Google (gclid) associado a esse evento.
gbraid

string

Opcional. O identificador de cliques associados a eventos de app e feitos em dispositivos iOS 14 (ou mais recente).
wbraid

string

Opcional. O identificador de cliques associados a eventos na Web e feitos em dispositivos iOS 14 (ou mais recente).
landingPageDeviceInfo

object (DeviceInfo)

Opcional. Informações coletadas sobre o dispositivo usado (se houver) no momento do acesso ao site do anunciante após a interação com o anúncio.
mobileDeviceId

string

Opcional. O identificador para anunciantes em dispositivos móveis. Pode ser o IDFA no iOS, o AdID no Android ou os identificadores de outras plataformas para anunciantes.
dclid

string

Opcional. O ID de clique de display associado a esse evento.
impressionId

string

Opcional. O ID da impressão associado a este evento.
matchId

string

Opcional. O campo de ID correspondente usado para mesclar esse evento com um anterior.
encryptedUserIds[]

object (EncryptedUserId)

Opcional. Qualquer número de IDs do usuário criptografados.
ppid

string

Opcional. Um identificador exclusivo para um usuário autenticado (conectado), conforme definido pelo editor.
visitorPpid

string

Opcional. Um identificador exclusivo para um usuário não autenticado (que não fez login), conforme definido pelo publisher.
leadId

string

Opcional. ID gerado pelo Google quando o usuário envia um formulário de lead.

EncryptedUserId

Um identificador de usuário emitido para ser usado na atribuição. Todos os campos são obrigatórios se essa opção for usada.

Representação JSON 
{
  "encryptedId": string,
  "entityType": enum (EncryptionEntityType),
  "entityId": string,
  "source": enum (EncryptionSource)
}
Campos
encryptedId

string

Obrigatório. O ID criptografado alfanumérico.
entityType

enum (EncryptionEntityType)

Obrigatório. O tipo de entidade de criptografia. Ela precisa corresponder à configuração de criptografia para veiculação de anúncios ou Transferência de dados.
entityId

string (int64 format)

Obrigatório. O ID da entidade de criptografia. Ela precisa corresponder à configuração de criptografia para veiculação de anúncios ou Transferência de dados.
source

enum (EncryptionSource)

Obrigatório. Descreve se o cookie criptografado foi recebido da veiculação de anúncios (a macro %m) ou da Transferência de dados.

EncryptionEntityType

O tipo de entidade de criptografia.

Tipos enumerados
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED Tipo de entidade de criptografia não especificado.
CAMPAIGN_MANAGER_ACCOUNT Conta do Campaign Manager 360.
CAMPAIGN_MANAGER_ADVERTISER anunciante do Campaign Manager 360.
DISPLAY_VIDEO_PARTNER Parceiro do Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Anunciante do Display & Video 360.
GOOGLE_ADS_CUSTOMER Cliente do Google Ads.
GOOGLE_AD_MANAGER_NETWORK_CODE Código de rede do Google Ad Manager.

EncryptionSource

A origem da criptografia.

Tipos enumerados
ENCRYPTION_SOURCE_UNSPECIFIED Origem de criptografia não especificada.
AD_SERVING Origem da criptografia de veiculação de anúncios.
DATA_TRANSFER Origem da criptografia de transferência de dados.

EventSource

A origem do evento.

Tipos enumerados
EVENT_SOURCE_UNSPECIFIED EventSource não especificado. Nunca deve ser usado.
WEB O evento foi gerado em um navegador da Web.
APP O evento foi gerado por um app.
IN_STORE O evento foi gerado por uma transação na loja física.
PHONE O evento foi gerado por uma ligação.
MESSAGE O evento foi gerado com base em uma mensagem.
OTHER O evento foi gerado de outras fontes.

CartData

Os dados do carrinho associados ao evento.

Representação JSON 
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ],
  "couponCodes": [
    string
  ]
}
Campos
merchantId

string

Opcional. O ID do Merchant Center associado aos itens.
merchantFeedLabel

string

Opcional. O rótulo do feed do Merchant Center associado ao feed dos itens.
merchantFeedLanguageCode

string

Opcional. O código de idioma ISO 639-1 associado ao feed do Merchant Center em que seus itens são enviados.
transactionDiscount

number

Opcional. A soma de todos os descontos associados à transação.
items[]

object (Item)

Opcional. A lista de itens associados ao evento.
couponCodes[]

string

Opcional. A lista de códigos do cupom que foram aplicados ao carrinho. Os códigos de cupom no nível do carrinho e do item são independentes.

Se o evento for para um destino do Google Analytics, forneça apenas um código do cupom. O Google Analytics ignora os códigos de cupom adicionais.

Item

Representa um item no carrinho associado ao evento.

Representação JSON 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number,
  "itemId": string,
  "additionalItemParameters": [
    {
      object (ItemParameter)
    }
  ],
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "customVariables": [
    {
      object (ItemCustomVariable)
    }
  ],
  "conversionValue": number
}
Campos
merchantProductId

string

Opcional. O ID do produto na conta do Merchant Center.
quantity

string (int64 format)

Opcional. O número desse item associado ao evento.
unitPrice

number

Opcional. O preço unitário, sem considerar tributos, frete e descontos no nível da transação.
itemId

string

Opcional. Um identificador exclusivo para referenciar o item.
additionalItemParameters[]

object (ItemParameter)

Opcional. Um bucket de parâmetros de evento relacionados a um item a serem incluídos no evento que ainda não foram especificados usando outros campos estruturados.
merchantId

string

Opcional. O ID do Merchant Center associado ao item. Para ações promocionais na loja, isso vai substituir o valor definido no nível do carrinho. Este campo é ignorado para outros eventos.
merchantFeedLabel

string

Opcional. O rótulo do feed do Merchant Center. Se os países ainda estiverem sendo usados, o código de país de duas letras no formato ISO-3166-1 alfa-2 poderá ser usado. Para ações promocionais na loja, isso vai substituir o valor definido no nível do carrinho. Este campo é ignorado para outros eventos.
merchantFeedLanguageCode

string

Opcional. O código de idioma ISO 639-1 associado ao feed do Merchant Center em que seus itens são enviados.
customVariables[]

object (ItemCustomVariable)

Opcional. Informações adicionais de par de chave-valor para enviar aos contêineres de conversão (ação de conversão ou atividade do Floodlight) ao acompanhar conversões por item.
conversionValue

number

Opcional. O valor de conversão associado a esse item no evento, para casos em que o valor de conversão é diferente para cada item.

ItemParameter

Um bucket de parâmetros de evento relacionados a um item a serem incluídos no evento que ainda não foram especificados usando outros campos estruturados.

Representação JSON 
{
  "parameterName": string,
  "value": string
}
Campos
parameterName

string

Obrigatório. O nome do parâmetro a ser usado.
value

string

Obrigatório. A representação de string do valor do parâmetro a ser definido.

ItemCustomVariable

Variável personalizada no nível do item para conversões do anúncio.

Representação JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Campos
variable

string

Opcional. O nome da variável personalizada a ser definida. Se a variável não for encontrada para o destino fornecido, ela será ignorada.
value

string

Opcional. O valor a ser armazenado para a variável personalizada.
destinationReferences[]

string

Opcional. String de referência usada para determinar para qual dos Event.destination_references a variável personalizada deve ser enviada. Se estiver vazio, o Event.destination_references será usado.

CustomVariable

Variável personalizada para conversões do anúncio.

Representação JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Campos
variable

string

Opcional. O nome da variável personalizada a ser definida. Se a variável não for encontrada para o destino fornecido, ela será ignorada.
value

string

Opcional. O valor a ser armazenado para a variável personalizada.
destinationReferences[]

string

Opcional. String de referência usada para determinar para qual dos Event.destination_references a variável personalizada deve ser enviada. Se estiver vazio, o Event.destination_references será usado.

ExperimentalField

Campo experimental que representa campos não oficiais.

Representação JSON 
{
  "field": string,
  "value": string
}
Campos
field

string

Opcional. O nome do campo a ser usado.
value

string

Opcional. O valor do campo a ser definido.

UserProperties

Informações avaliadas pelo anunciante sobre o usuário no momento em que o evento ocorreu. Acesse https://support.google.com/google-ads/answer/14007601 para mais detalhes.

Representação JSON 
{
  "customerType": enum (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket),
  "additionalUserProperties": [
    {
      object (UserProperty)
    }
  ]
}
Campos
customerType

enum (CustomerType)

Opcional. Tipo de cliente associado ao evento.
customerValueBucket

enum (CustomerValueBucket)

Opcional. O valor do cliente avaliado pelo anunciante.
additionalUserProperties[]

object (UserProperty)

Opcional. Um bucket de outras propriedades do usuário associadas a esse evento.

CustomerType

Tipo de cliente associado ao evento.

Tipos enumerados
CUSTOMER_TYPE_UNSPECIFIED CustomerType não especificado. Nunca deve ser usado.
NEW O cliente é novo para o anunciante.
RETURNING O cliente está voltando para o anunciante.
REENGAGED O cliente voltou a interagir com o anunciante.

CustomerValueBucket

O valor do cliente avaliado pelo anunciante.

Tipos enumerados
CUSTOMER_VALUE_BUCKET_UNSPECIFIED CustomerValueBucket não especificado. Nunca deve ser usado.
LOW O cliente é de baixo valor.
MEDIUM O cliente é de valor médio.
HIGH O cliente é de alto valor.

UserProperty

Um bucket de outras propriedades do usuário associadas a esse evento.

Representação JSON 
{
  "propertyName": string,
  "value": string
}
Campos
propertyName

string

Obrigatório. O nome da propriedade do usuário que será usada.
value

string

Obrigatório. A representação de string do valor da propriedade do usuário a ser usada.

EventParameter

Parâmetro de evento para eventos do GA4.

Representação JSON 
{
  "parameterName": string,
  "value": string
}
Campos
parameterName

string

Obrigatório. O nome do parâmetro a ser usado.
value

string

Obrigatório. A representação de string do valor do parâmetro a ser definido.

EventLocation

O local onde o evento ocorreu.

Representação JSON 
{
  "storeId": string,
  "city": string,
  "subdivisionCode": string,
  "regionCode": string,
  "subcontinentCode": string,
  "continentCode": string
}
Campos
storeId

string

Opcional. Obrigatório para vendas na loja. O identificador que representa uma loja física onde o evento ocorreu.
city

string

Opcional. O nome da cidade em que o evento ocorreu.
subdivisionCode

string

Opcional. O código de subdivisão ISO 3166-2 em que o evento ocorreu.
regionCode

string

Opcional. O código de região CLDR de duas letras do endereço do usuário.
subcontinentCode

string

Opcional. O código do subcontinente no formato UN M49 em que o evento ocorreu.
continentCode

string

Opcional. O código do continente no formato UN M49 em que o evento ocorreu.

CallInfo

Informações coletadas sobre a chamada (se houver) que levou a esse evento.

Representação JSON 
{
  "startTimestamp": string
}
Campos
startTimestamp

string (Timestamp format)

Obrigatório. O horário em que a ligação que resultou neste evento começou.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".