Method: customers.uploadClickConversions

Procesa las conversiones por clic determinadas.

Lista de errores arrojados: AuthenticationError AuthorizationError ConversionUploadError HeaderError InternalError PartialFailureError QuotaError RequestError

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
customerId

string

Obligatorio. El ID del cliente que realiza la carga.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "conversions": [
    {
      object (ClickConversion)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "debugEnabled": boolean,
  "jobId": integer
}
Campos
conversions[]

object (ClickConversion)

Obligatorio. Las conversiones que se suben
partialFailure

boolean

Obligatorio. Si es verdadero, se llevarán a cabo operaciones exitosas y las operaciones no válidas mostrarán errores. Si es falso, todas las operaciones se llevarán a cabo en una transacción solo si todas son válidas. Esto siempre se debe establecer como true. Consulta https://developers.google.com/google-ads/api/docs/best-practices/partial-failures para obtener más información sobre las fallas parciales.
validateOnly

boolean

Si es verdadero, la solicitud se valida, pero no se ejecuta. Solo se muestran errores, no resultados.
debugEnabled

boolean

Si es verdadero, la API realizará todas las verificaciones de carga y mostrará errores si se encuentran. Si es falso, solo realizará una validación de entrada básica, omitirá las verificaciones de carga posteriores y mostrará el resultado correcto incluso si no se encontró ningún clic para el userIdentifiers proporcionado.

Este parámetro de configuración solo afecta las conversiones avanzadas de cargas de clientes potenciales que utilizan userIdentifiers en lugar de GCLID, GBRAID o WBRAID. Cuando subas conversiones avanzadas de clientes potenciales, debes subir todos los eventos de conversión a la API, incluidos aquellos que no provengan de campañas de Google Ads. Si subes un evento que no provenga de una campaña de Google Ads, se mostrará un error CLICK_NOT_FOUND si este campo se establece como true. Dado que se esperan estos errores para estos eventos, establece este campo en false para confirmar que tus cargas tienen el formato correcto, pero ignorar los errores CLICK_NOT_FOUND de todas las conversiones que no provienen de una campaña de Google Ads. Esto te permitirá enfocarte solo en los errores que puedes corregir.

El valor predeterminado es falso.
jobId

integer

Opcional. Entrada opcional para establecer el ID de trabajo. Debe ser un número no negativo menor que 2^31 si se proporciona. Si no se proporciona este campo, la API generará un ID de trabajo en el rango [2^31, (2^63)-1]. La API mostrará el valor de esta solicitud en el campo jobId de UploadClickConversionsResponse.

Cuerpo de la respuesta

Mensaje de respuesta para ConversionUploadService.UploadClickConversions.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (ClickConversionResult)
    }
  ],
  "jobId": string
}
Campos
partialFailureError

object (Status)

Errores relacionados con fallas de conversión en el modo de falla parcial. Se muestra cuando se producen todos los errores en las conversiones. Si se produce algún error fuera de las conversiones (por ejemplo, errores de autenticación), se mostrará un error de nivel de RPC. Consulta https://developers.google.com/google-ads/api/docs/best-practices/partial-failures para obtener más información sobre las fallas parciales.
results[]

object (ClickConversionResult)

Se muestra para las conversiones que se procesaron correctamente. El protocolo estará vacío para las filas que recibieron un error. No se muestran los resultados cuando validateOnly es verdadero.
jobId

string (int64 format)

ID de trabajo para el lote de carga.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

ClickConversion

Una conversión por clic.

Representación 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

Es el identificador de clics para los clics asociados con conversiones de aplicación y que se originan en dispositivos iOS a partir de iOS14.
wbraid

string

Es el identificador de clics para los clics asociados con conversiones web y que se originan en dispositivos iOS a partir de iOS14.
externalAttributionData

object (ExternalAttributionData)

Datos adicionales sobre las conversiones atribuidas externamente. Este campo es obligatorio para las conversiones con una acción de conversión atribuida externamente, pero no se debe establecer de otra manera.
customVariables[]

object (CustomVariable)

Son las variables personalizadas asociadas con esta conversión.
cartData

object (CartData)

Los datos del carrito asociados con esta conversión.
userIdentifiers[]

object (UserIdentifier)

Son los identificadores de usuario asociados con esta conversión. Solo se admiten hashedEmail y hashedPhoneNumber para las cargas de conversiones. La cantidad máxima de identificadores de usuario para cada conversión es 5.
conversionEnvironment

enum (ConversionEnvironment)

El entorno en el que se registró esta conversión, por ejemplo, aplicación o web.
consent

object (Consent)

Es la configuración de consentimiento para el evento.
gclid

string

Es el ID de clic de Google (gclid) asociado con esta conversión.
conversionAction

string

Es el nombre del recurso de la acción de conversión asociada con esta conversión. Nota: Si bien este nombre de recurso consiste en un ID de cliente y un ID de acción de conversión, la validación ignorará el ID de cliente y usará el ID de acción de conversión como el único identificador de la acción de conversión.
conversionDateTime

string

Indica la fecha y hora en la que se generó la conversión. Debe ser posterior a la hora del clic. Se debe especificar la zona horaria. El formato es "aaaa-mm-dd hh:mm:ss+|-hh:mm", por ejemplo: "2019-01-01 12:32:45-08:00".
conversionValue

number

Es el valor de la conversión para el anunciante.
currencyCode

string

Es la moneda asociada con el valor de conversión. Este es el código de moneda ISO 4217 de 3 caracteres. Por ejemplo: USD o EUR.
orderId

string

Indica el ID de pedido asociado con la conversión. El ID de pedido solo se puede usar para una conversión por acción de conversión.

ExternalAttributionData

Contiene información adicional sobre las conversiones atribuidas externamente.

Representación JSON 
{
  "externalAttributionCredit": number,
  "externalAttributionModel": string
}
Campos
externalAttributionCredit

number

Representa la fracción de la conversión que se atribuye al clic de Google Ads.
externalAttributionModel

string

Especifica el nombre del modelo de atribución.

CartData

Contiene información adicional sobre los datos del carrito.

Representación JSON 
{
  "merchantId": string,
  "feedCountryCode": string,
  "feedLanguageCode": string,
  "localTransactionCost": number,
  "items": [
    {
      object (Item)
    }
  ]
}
Campos
merchantId

string (int64 format)

El ID de Merchant Center donde se suben los artículos.
feedCountryCode

string

Indica el código de país asociado al feed en el que se suben los artículos.
feedLanguageCode

string

Indica el código de idioma asociado al feed en el que se suben los artículos.
localTransactionCost

number

Es la suma de todos los descuentos a nivel de la transacción, como el envío gratis y los descuentos con cupones para todo el carrito. El código de moneda es el mismo que el del mensaje ClickConversion.
items[]

object (Item)

Son los datos de los artículos comprados.

Elemento

Contiene datos de los artículos comprados.

Representación JSON 
{
  "productId": string,
  "quantity": integer,
  "unitPrice": number
}
Campos
productId

string

Es el ID de compra del artículo. Debe ser igual al identificador de producto de Merchant Center.
quantity

integer

Cantidad de artículos vendidos.
unitPrice

number

Precio unitario sin impuestos, envío ni descuentos a nivel de la transacción. El código de moneda es el mismo que el del mensaje ClickConversion.

ConversionEnvironment

Es el entorno de conversión de la conversión que se subió.

Enumeradores
UNSPECIFIED No se especifica.
UNKNOWN Se usa solo para el valor que se muestra. Representa un valor desconocido en esta versión.
APP La conversión se registró en una aplicación.
WEB La conversión se registró en un sitio web.

ClickConversionResult

Información de identificación de una ClickConversion que se procesó correctamente.

Representación JSON 
{
  "gbraid": string,
  "wbraid": string,
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string
}
Campos
gbraid

string

Es el identificador de clics para los clics asociados con conversiones de aplicación y que se originan en dispositivos iOS a partir de iOS14.
wbraid

string

Es el identificador de clics para los clics asociados con conversiones web y que se originan en dispositivos iOS a partir de iOS14.
userIdentifiers[]

object (UserIdentifier)

Son los identificadores de usuario asociados con esta conversión. Solo se admiten hashedEmail y hashedPhoneNumber para las cargas de conversiones. La cantidad máxima de identificadores de usuario para cada conversión es 5.
gclid

string

Es el ID de clic de Google (gclid) asociado con esta conversión.
conversionAction

string

Es el nombre del recurso de la acción de conversión asociada con esta conversión.
conversionDateTime

string

Indica la fecha y hora en la que se generó la conversión. El formato es "aaaa-mm-dd hh:mm:ss+|-hh:mm", por ejemplo: "2019-01-01 12:32:45-08:00".