Method: customers.uploadConversionAdjustments

Processa os ajustes de conversão fornecidos.

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

Solicitação HTTP

POST https://googleads.googleapis.com/v14/customers/{customerId}:uploadConversionAdjustments

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á executando o upload.

Corpo da solicitação

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

Representação JSON 
{
  "conversionAdjustments": [
    {
      object (ConversionAdjustment)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean
}
Campos
conversionAdjustments[]

object (ConversionAdjustment)

Obrigatório. Os ajustes de conversão que estão sendo enviados.
partialFailure

boolean

Obrigatório. Se verdadeiro, as operações bem-sucedidas serão realizadas 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. Sempre deve ser definido como verdadeiro. Consulte https://developers.google.com/google-ads/api/docs/best-practices/partial-failures (link em inglês) 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.

Corpo da resposta

Mensagem de resposta para ConversionAdjustmentUploadService.UploadConversionAdjustments.

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

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

object (Status)

Erros relacionados a falhas de ajuste de conversão no modo de falha parcial. Retornado quando todos os erros ocorrem nos ajustes. Se ocorrer algum erro fora dos ajustes (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 (link em inglês) para mais informações sobre falhas parciais.
results[]

object (ConversionAdjustmentResult)

Retornado para ajustes de conversão processados. 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.

ConversionAdjustment

Um ajuste de conversão.

Representação JSON 
{
  "gclidDateTimePair": {
    object (GclidDateTimePair)
  },
  "adjustmentType": enum (ConversionAdjustmentType),
  "restatementValue": {
    object (RestatementValue)
  },
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "orderId": string,
  "conversionAction": string,
  "adjustmentDateTime": string,
  "userAgent": string
}
Campos
gclidDateTimePair

object (GclidDateTimePair)

Para ajustes, identifica de forma exclusiva uma conversão que foi informada sem um código do pedido especificado. Se o AdjustType for ENHANCEMENT, o valor é opcional, mas pode ser definido além do orderId.
adjustmentType

enum (ConversionAdjustmentType)

O tipo de ajuste.
restatementValue

object (RestatementValue)

Informações necessárias para reiterar o valor da conversão. Obrigatório para redefinições. Não deve ser fornecido para retrações. Um erro vai ser retornado se for fornecido para um cancelamento. OBSERVAÇÃO: se você quiser fazer upload de uma segunda redefinição com um valor ajustado diferente, ela precisa ter um horário de ocorrência do ajuste novo e mais recente. Caso contrário, ela vai ser tratada como uma cópia da reformulação anterior e ignorada.
userIdentifiers[]

object (UserIdentifier)

Os identificadores do usuário para melhorar a conversão original. O ConversionAdjustmentUploadService aceita somente identificadores de usuários nas melhorias. O número máximo de identificadores de usuários para cada melhoria é cinco.
orderId

string

O ID do pedido da conversão a ser ajustada. Se a conversão foi registrada com um ID do pedido especificado, ele precisa ser usado como o identificador aqui. O código do pedido é obrigatório para melhorias.
conversionAction

string

Nome do recurso da ação de conversão associada a esse ajuste de conversão. Observação: embora esse nome de recurso consista em um ID de cliente e um ID de ação de conversão, a validação vai ignorar o ID do cliente e usar o ID da ação de conversão como o único identificador da ação de conversão.
adjustmentDateTime

string

A data e a hora em que o ajuste ocorreu. Precisa ser posterior à conversionDateTime. É 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".
userAgent

string

O user agent para melhorar a conversão original. Isso pode ser encontrado no cabeçalho da solicitação HTTP do usuário quando ele realiza a conversão na página da Web. Exemplo: "Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X)". O user agent só pode ser especificado em melhorias com identificadores de usuário. Ela precisa corresponder ao user agent da solicitação que enviou a conversão original para que a conversão e o aprimoramento sejam atribuídos ao mesmo dispositivo ou como entre dispositivos.

GclidDateTimePair

Identifica de forma exclusiva uma conversão que foi informada sem um código do pedido especificado.

Representação JSON 
{
  "gclid": string,
  "conversionDateTime": string
}
Campos
gclid

string

ID de clique do Google (gclid) associado à conversão original desse ajuste.
conversionDateTime

string

A data e a hora em que ocorreu a conversão original desse ajuste. É 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".

ConversionAdjustmentType

As diferentes ações que os anunciantes podem realizar para ajustar as conversões que já informaram. As retiradas negam uma conversão. As redefinições mudam o valor de uma conversão.

Enums
UNSPECIFIED Não especificado.
UNKNOWN Representa o valor desconhecido nesta versão.
RETRACTION Nega uma conversão para que o valor total e a contagem sejam zero.
RESTATEMENT Altera o valor de uma conversão.
ENHANCEMENT Complementa uma conversão existente com os identificadores de usuário e o user agent fornecidos, que podem ser usados pelo Google para aprimorar a contagem de conversões.

RestatementValue

Contém informações necessárias para reiterar o valor de uma conversão.

Representação JSON 
{
  "adjustedValue": number,
  "currencyCode": string
}
Campos
adjustedValue

number

O valor da conversão reafirmado. Esse é o valor da conversão após a redefinição. Por exemplo, para mudar o valor de uma conversão de 100 para 70, um valor ajustado de 70 precisa ser informado. OBSERVAÇÃO: se você quiser fazer upload de uma segunda redefinição com um valor ajustado diferente, ela precisa ter um horário de ocorrência do ajuste novo e mais recente. Caso contrário, ela vai ser tratada como uma cópia da reformulação anterior e ignorada.
currencyCode

string

Moeda do valor reformulado. Se ela não for informada, a moeda padrão da ação de conversão será usada. Caso ela não seja definida, a moeda da conta será usada. Código de moeda ISO 4217 com três caracteres, por exemplo, USD ou EUR.

ConversionAdjustmentResult

Informações que identificam um ConversionAdjustment processado.

Representação JSON 
{
  "gclidDateTimePair": {
    object (GclidDateTimePair)
  },
  "orderId": string,
  "adjustmentType": enum (ConversionAdjustmentType),
  "conversionAction": string,
  "adjustmentDateTime": string
}
Campos
gclidDateTimePair

object (GclidDateTimePair)

O GCLID e a data e hora da conversão.
orderId

string

O ID do pedido da conversão a ser ajustada.
adjustmentType

enum (ConversionAdjustmentType)

O tipo de ajuste.
conversionAction

string

Nome do recurso da ação de conversão associada a esse ajuste de conversão.
adjustmentDateTime

string

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