Method: customers.uploadClickConversions

Elabora le conversioni dei clic specificate.

Elenco degli errori generati: AuthenticationError AuthorizationError ConversionUploadError HeaderError InternalError PartialFailureError QuotaError RequestError

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
customerId

string

obbligatorio. L'ID del cliente che esegue il caricamento.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "conversions": [
    {
      object (ClickConversion)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "debugEnabled": boolean,
  "jobId": integer
}
Campi
conversions[]

object (ClickConversion)

obbligatorio. Le conversioni che vengono caricate.

partialFailure

boolean

obbligatorio. Se il valore è true, le operazioni andate a buon fine vengono eseguite e le operazioni non valide restituiranno errori. Se il valore è false, tutte le operazioni verranno eseguite in una sola transazione se e solo se sono tutte valide. Deve essere sempre impostato su true. Vedi https://developers.google.com/google-ads/api/docs/best-practices/partial-failures per saperne di più sull'errore parziale.

validateOnly

boolean

Se il valore è true, la richiesta viene convalidata ma non eseguita. Vengono restituiti solo gli errori, non i risultati.

debugEnabled

boolean

Se il valore è true, l'API eseguirà tutti i controlli di caricamento e restituirà errori se ne vengono rilevati. Se il valore è false, verrà eseguita solo la convalida dell'input di base, il caricamento verrà ignorato i controlli di caricamento successivi e verrà restituito l'esito positivo anche se non è stato trovato alcun clic per l'elemento userIdentifiers fornito.

Questa impostazione influisce solo sulle conversioni avanzate per i caricamenti di lead che utilizzano userIdentifiers anziché GCLID, GBRAID o WBRAID. Quando carichi le conversioni avanzate per i lead, devi caricare nell'API tutti gli eventi di conversione, inclusi quelli che potrebbero non provenire dalle campagne Google Ads. Il caricamento di un evento che non appartiene a una campagna Google Ads genererà un errore CLICK_NOT_FOUND se questo campo viene impostato su true. Poiché questi errori sono previsti per questi eventi, imposta questo campo su false in modo da poter confermare che i caricamenti siano formattati correttamente, ma ignorare gli errori CLICK_NOT_FOUND relativi a tutte le conversioni che non provengono da una campagna Google Ads. In questo modo, potrai concentrarti solo sugli errori che puoi risolvere.

Il valore predefinito è false.

jobId

integer

Campo facoltativo. Input facoltativo per impostare l'ID job. Deve essere un numero non negativo inferiore a 2^31, se fornito. Se questo campo non viene fornito, l'API genererà un ID job compreso nell'intervallo [2^31, (2^63)-1]. L'API restituirà il valore per questa richiesta nel campo jobId di UploadClickConversionsResponse.

Corpo della risposta

Messaggio di risposta per ConversionUploadService.UploadClickConversions.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (ClickConversionResult)
    }
  ],
  "jobId": string
}
Campi
partialFailureError

object (Status)

Errori relativi agli errori di conversione in modalità di errore parziale. Restituito quando si verificano tutti gli errori all'interno delle conversioni. Se si verificano errori che non riguardano le conversioni, ad esempio errori di autenticazione, viene restituito un errore a livello di RPC. Vedi https://developers.google.com/google-ads/api/docs/best-practices/partial-failures per saperne di più sull'errore parziale.

results[]

object (ClickConversionResult)

Restituito per le conversioni elaborate correttamente. Il protocollo sarà vuoto per le righe che hanno ricevuto un errore. I risultati non vengono restituiti quando validationOnly è true.

jobId

string (int64 format)

ID job per il batch di caricamento.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la pagina Panoramica di OAuth 2.0.

ClickConversion

Una conversione di clic.

Rappresentazione 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
}
Campi
gbraid

string

L'identificatore dei clic per i clic associati alle conversioni di app e provenienti da dispositivi iOS che iniziano con iOS14.

wbraid

string

L'identificatore dei clic per i clic associati alle conversioni web e provenienti da dispositivi iOS che iniziano con iOS14.

externalAttributionData

object (ExternalAttributionData)

Dati aggiuntivi sulle conversioni attribuite esternamente. Questo campo è obbligatorio per le conversioni con un'azione di conversione attribuita esternamente, ma non deve essere impostato diversamente.

customVariables[]

object (CustomVariable)

Le variabili personalizzate associate a questa conversione.

cartData

object (CartData)

I dati del carrello associati a questa conversione.

userIdentifiers[]

object (UserIdentifier)

Gli identificatori utente associati a questa conversione. Per i caricamenti delle conversioni sono supportati solo hashedEmail e hashedPhoneNumber. Il numero massimo di identificatori utente per ogni conversione è 5.

conversionEnvironment

enum (ConversionEnvironment)

L'ambiente su cui è stata registrata questa conversione, ad esempio App o Web.

consent

object (Consent)

L'impostazione del consenso per l'evento.

gclid

string

L'ID clic Google (gclid) associato a questa conversione.

conversionAction

string

Nome della risorsa dell'azione di conversione associata a questa conversione. Nota: sebbene questo nome risorsa sia composto da un ID cliente e da un ID azione di conversione, la convalida ignorerà l'ID cliente e utilizzerà l'ID azione di conversione come unico identificatore dell'azione di conversione.

conversionDateTime

string

L'ora in cui si è verificata la conversione. Deve essere successiva all'ora del clic. È necessario specificare il fuso orario. Il formato è "aaaa-mm-gg hh:mm:ss+|-hh:mm", ad esempio "2019-01-01 12:32:45-08:00".

conversionValue

number

Il valore della conversione per l'inserzionista.

currencyCode

string

Valuta associata al valore di conversione. Si tratta del codice valuta ISO 4217 di tre caratteri. Ad esempio: USD, EUR.

orderId

string

L'ID ordine associato alla conversione. Un ID ordine può essere utilizzato solo per una conversione per azione di conversione.

ExternalAttributionData

Contiene informazioni aggiuntive sulle conversioni attribuite esternamente.

Rappresentazione JSON
{
  "externalAttributionCredit": number,
  "externalAttributionModel": string
}
Campi
externalAttributionCredit

number

Rappresenta la frazione della conversione attribuita al clic Google Ads.

externalAttributionModel

string

Specifica il nome del modello di attribuzione.

CartData

Contiene informazioni aggiuntive sui dati del carrello.

Rappresentazione JSON
{
  "merchantId": string,
  "feedCountryCode": string,
  "feedLanguageCode": string,
  "localTransactionCost": number,
  "items": [
    {
      object (Item)
    }
  ]
}
Campi
merchantId

string (int64 format)

L'ID Merchant Center nel quale vengono caricati gli articoli.

feedCountryCode

string

Il codice paese associato al feed nel quale vengono caricati gli articoli.

feedLanguageCode

string

Il codice lingua associato al feed nel quale vengono caricati gli articoli.

localTransactionCost

number

Somma di tutti gli sconti a livello di transazione, come la spedizione gratuita e gli sconti coupon per l'intero carrello. Il codice valuta è lo stesso del messaggio ClickConversion.

items[]

object (Item)

Dati degli articoli acquistati.

Articolo

Contiene i dati degli articoli acquistati.

Rappresentazione JSON
{
  "productId": string,
  "quantity": integer,
  "unitPrice": number
}
Campi
productId

string

L'ID acquisto dell'articolo. Deve essere uguale all'ID prodotto di Merchant Center.

quantity

integer

Numero di articoli venduti.

unitPrice

number

Prezzo unitario escluse imposte, spedizione ed eventuali sconti a livello di transazione. Il codice valuta è lo stesso del messaggio ClickConversion.

ConversionEnvironment

Ambiente di conversione della conversione caricata.

Enum
UNSPECIFIED Non specificato.
UNKNOWN Utilizzato solo per il valore restituito. Rappresenta un valore sconosciuto in questa versione.
APP La conversione è stata registrata su un'app.
WEB La conversione è stata registrata su un sito web.

ClickConversionResult

Informazioni che consentono di identificare un valore ClickConversion elaborato correttamente.

Rappresentazione JSON
{
  "gbraid": string,
  "wbraid": string,
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string
}
Campi
gbraid

string

L'identificatore dei clic per i clic associati alle conversioni di app e provenienti da dispositivi iOS che iniziano con iOS14.

wbraid

string

L'identificatore dei clic per i clic associati alle conversioni web e provenienti da dispositivi iOS che iniziano con iOS14.

userIdentifiers[]

object (UserIdentifier)

Gli identificatori utente associati a questa conversione. Per i caricamenti delle conversioni sono supportati solo hashedEmail e hashedPhoneNumber. Il numero massimo di identificatori utente per ogni conversione è 5.

gclid

string

L'ID clic Google (gclid) associato a questa conversione.

conversionAction

string

Nome della risorsa dell'azione di conversione associata a questa conversione.

conversionDateTime

string

L'ora in cui si è verificata la conversione. Il formato è "aaaa-mm-gg hh:mm:ss+|-hh:mm", ad esempio "2019-01-01 12:32:45-08:00".