Method: customers.uploadClickConversions

Processa as conversões de clique fornecidas.

Lista de erros gerados: AuthenticationError AuthorizationError ConversionUploadError HeaderError InternalError PartialFailureError QuotaError RequestError

Solicitação HTTP

POST https://googleads.googleapis.com/v16/customers/{customerId}:uploadClickConversions

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

Parâmetros de caminho

Parâmetros
customerId

string

Obrigatório. O ID do cliente que está realizando o upload.

Corpo da solicitação

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

Representação JSON 
{
  "conversions": [
    {
      object (ClickConversion)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "debugEnabled": boolean,
  "jobId": integer
}
Campos
conversions[]

object (ClickConversion)

Obrigatório. As conversões que estão sendo enviadas.
partialFailure

boolean

Obrigatório. Se verdadeiro, as operações bem-sucedidas serão executadas e as operações inválidas retornarão erros. Se for falso, todas as operações serão realizadas em uma transação apenas se todas forem válidas. Ele sempre deve ser definido como verdadeiro. Consulte https://developers.google.com/google-ads/api/docs/best-practices/partial-failures para mais informações sobre falhas parciais.
validateOnly

boolean

Se verdadeiro, a solicitação é validada, mas não executada. Somente erros são retornados, não resultados.
debugEnabled

boolean

Se o valor for "true", a API vai realizar todas as verificações de upload e retornar erros, caso algum seja encontrado. Se for falso, ele vai executar apenas a validação básica de entrada, pular as verificações de upload subsequentes e retornar sucesso, mesmo que nenhum clique seja encontrado para o userIdentifiers fornecido.

Essa configuração afeta apenas as conversões otimizadas para uploads de leads que usam userIdentifiers em vez de GCLID, GBRAID ou WBRAID. Ao fazer o upload de conversões otimizadas para leads, envie todos os eventos de conversão para a API, incluindo aqueles que não são das campanhas do Google Ads. O upload de um evento que não é de uma campanha do Google Ads vai resultar em um erro CLICK_NOT_FOUND se o campo estiver definido como true. Como esses erros são esperados nesses eventos, defina o campo como false para confirmar se os uploads estão formatados corretamente, mas ignore CLICK_NOT_FOUND erros de todas as conversões que não são de uma campanha do Google Ads. Assim, você pode se concentrar apenas nos erros que pode resolver.

O padrão é false
jobId

integer

Opcional. Entrada opcional para definir o ID do job. Precisa ser um número não negativo menor que 2^31, se fornecido. Se este campo não for fornecido, a API gerará um ID de trabalho no intervalo [2^31, (2^63)-1]. A API vai retornar o valor dessa solicitação no campo jobId do UploadClickConversionsResponse.

Corpo da resposta

Mensagem de resposta para ConversionUploadService.UploadClickConversions.

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

Representação JSON 
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (ClickConversionResult)
    }
  ],
  "jobId": string
}
Campos
partialFailureError

object (Status)

Erros relacionados a falhas de conversão no modo de falha parcial. Retornado quando todos os erros ocorrem nas conversões. Se ocorrer algum erro fora das conversões (por exemplo, erros de autenticação), vamos retornar um erro no nível da RPC. Consulte https://developers.google.com/google-ads/api/docs/best-practices/partial-failures para mais informações sobre falhas parciais.
results[]

object (ClickConversionResult)

Retornado para conversões processadas. O Proto vai estar vazio nas linhas que receberam um erro. Os resultados não são retornados quando validateOnly é verdadeiro.
jobId

string (int64 format)

ID da tarefa para o lote de upload.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

ClickConversion

Uma conversão de clique.

Representação JSON 
{
  "gbraid": string,
  "wbraid": string,
  "externalAttributionData": {
    object (ExternalAttributionData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "cartData": {
    object (CartData)
  },
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "conversionEnvironment": enum (ConversionEnvironment),
  "consent": {
    object (Consent)
  },
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string,
  "conversionValue": number,
  "currencyCode": string,
  "orderId": string
}
Campos
gbraid

string

É o identificador de cliques associados a conversões de app e originados de dispositivos iOS a partir do iOS 14.
wbraid

string

É o identificador de cliques associados a conversões na Web e originados de dispositivos iOS a partir do iOS 14.
externalAttributionData

object (ExternalAttributionData)

Dados adicionais sobre conversões atribuídas externamente. Esse campo é obrigatório para conversões com uma ação de conversão atribuída externamente, mas não pode ser definido de outra forma.
customVariables[]

object (CustomVariable)

As variáveis personalizadas associadas a essa conversão.
cartData

object (CartData)

Dados do carrinho associados a essa conversão.
userIdentifiers[]

object (UserIdentifier)

Os identificadores de usuário associados a esta conversão. Somente hashedEmail e hashedPhoneNumber são compatíveis com uploads de conversão. O número máximo de identificadores de usuários para cada conversão é cinco.
conversionEnvironment

enum (ConversionEnvironment)

O ambiente em que a conversão foi registrada, por exemplo, app ou Web.
consent

object (Consent)

A configuração de consentimento do evento.
gclid

string

O ID de clique do Google (gclid) associado a essa conversão.
conversionAction

string

Nome do recurso da ação de conversão associada a esta conversão. Observação: embora esse nome de recurso seja composto por um ID de cliente e um ID de ação de conversão, a validação vai ignorar o ID de cliente e usar o ID da ação de conversão como o único identificador da ação de conversão.
conversionDateTime

string

A data e a hora em que a conversão ocorreu. Precisa ser depois do horário do clique. É necessário especificar o fuso horário. O formato é "aaaa-mm-dd hh:mm:ss+|-hh:mm", por exemplo, "2019-01-01 12:32:45-08:00".
conversionValue

number

O valor da conversão para o anunciante.
currencyCode

string

Moeda associada ao valor da conversão. Código ISO 4217 de três caracteres para a moeda. Por exemplo: USD, EUR.
orderId

string

O código do pedido associado à conversão. Um código do pedido só pode ser usado para uma conversão por ação de conversão.

ExternalAttributionData

Contém mais informações sobre conversões atribuídas externamente.

Representação JSON 
{
  "externalAttributionCredit": number,
  "externalAttributionModel": string
}
Campos
externalAttributionCredit

number

Representa a fração da conversão atribuída ao clique do Google Ads.
externalAttributionModel

string

Especifica o nome do modelo de atribuição.

CartData

Contém informações adicionais sobre os dados do carrinho.

Representação JSON 
{
  "merchantId": string,
  "feedCountryCode": string,
  "feedLanguageCode": string,
  "localTransactionCost": number,
  "items": [
    {
      object (Item)
    }
  ]
}
Campos
merchantId

string (int64 format)

O ID no Merchant Center com que os itens são enviados.
feedCountryCode

string

O código do país associado ao feed em que os itens são enviados.
feedLanguageCode

string

O código do idioma associado ao feed em que os itens são enviados.
localTransactionCost

number

Soma de todos os descontos no nível da transação, como frete grátis e descontos de cupons para todo o carrinho. O código da moeda é o mesmo da mensagem ClickConversion.
items[]

object (Item)

Dados dos itens comprados.

Item

Contém dados dos itens comprados.

Representação JSON 
{
  "productId": string,
  "quantity": integer,
  "unitPrice": number
}
Campos
productId

string

ID da compra do item. Precisa ser igual ao identificador de produto do Merchant Center.
quantity

integer

Quantidade de itens vendidos.
unitPrice

number

Preço unitário, excluindo tributos, frete e todos os descontos no nível da transação. O código da moeda é o mesmo da mensagem ClickConversion.

ConversionEnvironment

Ambiente de conversão da conversão enviada.

Enums
UNSPECIFIED Não especificado.
UNKNOWN Usado apenas para valor de retorno. Representa um valor desconhecido nesta versão.
APP A conversão foi registrada em um app.
WEB A conversão foi registrada em um site.

ClickConversionResult

Identificação das informações de um ClickConversion processado.

Representação JSON 
{
  "gbraid": string,
  "wbraid": string,
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string
}
Campos
gbraid

string

É o identificador de cliques associados a conversões de app e originados de dispositivos iOS a partir do iOS 14.
wbraid

string

É o identificador de cliques associados a conversões na Web e originados de dispositivos iOS a partir do iOS 14.
userIdentifiers[]

object (UserIdentifier)

Os identificadores de usuário associados a esta conversão. Somente hashedEmail e hashedPhoneNumber são compatíveis com uploads de conversão. O número máximo de identificadores de usuários para cada conversão é cinco.
gclid

string

O ID de clique do Google (gclid) associado a essa conversão.
conversionAction

string

Nome do recurso da ação de conversão associada a esta conversão.
conversionDateTime

string

A data e a hora em que a conversão ocorreu. O formato é "aaaa-mm-dd hh:mm:ss+|-hh:mm", por exemplo, "2019-01-01 12:32:45-08:00".