- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- ConversionAdjustment
- GclidDateTimePair
- ConversionAdjustmentType
- RestatementValue (em inglês)
- ConversionAdjustmentResult
- Faça um teste
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/v16/customers/{customerId}:uploadConversionAdjustments
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
customerId |
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 |
---|
{
"conversionAdjustments": [
{
object ( |
Campos | |
---|---|
conversionAdjustments[] |
Obrigatório. Os ajustes de conversão que estão sendo enviados. |
partialFailure |
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 |
Se verdadeiro, a solicitação é validada, mas não executada. Somente erros são retornados, não resultados. |
jobId |
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 |
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 ( |
Campos | |
---|---|
partialFailureError |
Erros relacionados a falhas no 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 para mais informações sobre falhas parciais. |
results[] |
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 |
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 ( |
Campos | |
---|---|
gclidDateTimePair |
Para ajustes, identifica de forma exclusiva uma conversão que foi informada sem um ID do pedido especificado. Se o ajusteType for ENHANCEMENT, esse valor será opcional, mas poderá ser definido além do "orderId". |
adjustmentType |
O tipo de ajuste. |
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 será retornado se for informado para o cancelamento. OBSERVAÇÃO: se você quiser fazer upload de uma segunda redefinição com um valor ajustado diferente, ela precisará ter um horário de ocorrência de ajuste novo e mais recente. Caso contrário, ela será tratada como uma cópia da reformulação anterior e ignorada. |
userIdentifiers[] |
Os identificadores de usuário para aprimorar a conversão original. O ConversionAdjustmentUploadService aceita apenas identificadores de usuários em melhorias. O número máximo de identificadores de usuários para cada melhoria é cinco. |
orderId |
O código do pedido da conversão a ser ajustada. Se a conversão tiver sido informada com um código de pedido especificado, ele precisará ser usado como o identificador aqui. O código do pedido é obrigatório para melhorias. |
conversionAction |
Nome do recurso da ação de conversão associada a esse ajuste de 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. |
adjustmentDateTime |
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 |
O user agent para aprimorar a conversão original. Isso pode ser encontrado no cabeçalho da solicitação HTTP dos usuários quando eles fazem a conversão na página da Web. Exemplo, "Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 como Mac OS X)". O user agent só pode ser especificado em melhorias com identificadores de usuários. Precisa corresponder ao user agent da solicitação que enviou a conversão original para que a conversão e as melhorias sejam atribuídas ao mesmo dispositivo ou como entre dispositivos. |
GclidDateTimePair
Identifica de forma exclusiva uma conversão que foi informada sem um código de pedido especificado.
Representação JSON |
---|
{ "gclid": string, "conversionDateTime": string } |
Campos | |
---|---|
gclid |
ID de clique do Google (gclid) associado à conversão original para esse ajuste. |
conversionDateTime |
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 eles 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 um 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 atual com identificadores de usuário e 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 |
O valor da conversão reafirmado. Esse é o valor da conversão após a redefinição. Por exemplo, para alterar o valor de uma conversão de 100 para 70, um valor ajustado de 70 deve ser informado. OBSERVAÇÃO: se você quiser fazer upload de uma segunda redefinição com um valor ajustado diferente, ela precisará ter um horário de ocorrência de ajuste novo e mais recente. Caso contrário, ela será tratada como uma cópia da reformulação anterior e ignorada. |
currencyCode |
A moeda do valor reformulado. Se não for informado, a moeda padrão da ação de conversão vai ser usada. Se ela não for definida, será usada a moeda da conta. Código ISO 4217 de três caracteres da moeda, por exemplo, USD ou EUR. |
ConversionAdjustmentResult
Informações que identificam um ConversionAdjustment processado com sucesso.
Representação JSON |
---|
{ "gclidDateTimePair": { object ( |
Campos | |
---|---|
gclidDateTimePair |
O GCLID e a data/hora da conversão. |
orderId |
O código do pedido da conversão a ser ajustada. |
adjustmentType |
O tipo de ajuste. |
conversionAction |
Nome do recurso da ação de conversão associada a esse ajuste de conversão. |
adjustmentDateTime |
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". |