Method: events.ingest

Carica un elenco di risorse Event dal Destination fornito.

Richiesta HTTP

POST https://datamanager.googleapis.com/v1/events:ingest

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  }
}
Campi
destinations[]

object (Destination)

Obbligatorio. L'elenco delle destinazioni a cui inviare gli eventi.
events[]

object (Event)

Obbligatorio. L'elenco di eventi da inviare alle destinazioni specificate. In una singola richiesta è possibile inviare al massimo 2000 risorse Event.
consent

object (Consent)

Facoltativo. Consenso a livello di richiesta da applicare a tutti gli utenti nella richiesta. Il consenso a livello di utente sostituisce il consenso a livello di richiesta e può essere specificato in ogni Event.
validateOnly

boolean

Facoltativo. A scopo di test. Se true, la richiesta viene convalidata, ma non eseguita. Vengono restituiti solo gli errori, non i risultati.
encoding

enum (Encoding)

Facoltativo. Deve essere fornito per i caricamenti di UserData. Il tipo di codifica degli identificatori dell'utente. Per gli identificatori dell'utente con hashing, questo è il tipo di codifica della stringa con hashing. Per gli identificatori dell'utente con hash crittografati, questo è il tipo di codifica della stringa crittografata esterna, ma non necessariamente della stringa con hash interna, il che significa che la stringa con hash interna potrebbe essere codificata in modo diverso rispetto alla stringa crittografata esterna. Per i caricamenti non UserData, questo campo viene ignorato.
encryptionInfo

object (EncryptionInfo)

Facoltativo. Informazioni sulla crittografia per i caricamenti di UserData. Se non viene impostato, si presume che le informazioni identitarie caricate siano sottoposte ad hashing, ma non crittografate. Per i caricamenti non UserData, questo campo viene ignorato.

Corpo della risposta

Risposta di IngestEventsRequest.

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

Rappresentazione JSON 
{
  "requestId": string,
  "fieldWarnings": [
    {
      object (FieldWarning)
    }
  ]
}
Campi
requestId

string

L'ID della richiesta generato automaticamente.
fieldWarnings[]

object (FieldWarning)

Avvisi dettagliati a livello di riga con percorsi dei campi.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Evento

Un evento che rappresenta un'interazione dell'utente con il sito web o l'app di un inserzionista.

Rappresentazione JSON 
{
  "destinationReferences": [
    string
  ],
  "transactionId": string,
  "eventTimestamp": string,
  "lastUpdatedTimestamp": string,
  "userData": {
    object (UserData)
  },
  "consent": {
    object (Consent)
  },
  "adIdentifiers": {
    object (AdIdentifiers)
  },
  "currency": string,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  },
  "eventName": string,
  "clientId": string,
  "userId": string,
  "additionalEventParameters": [
    {
      object (EventParameter)
    }
  ],
  "thirdPartyUserData": {
    object (UserData)
  },
  "eventLocation": {
    object (EventLocation)
  },
  "appInstanceId": string,
  "callInfo": {
    object (CallInfo)
  },
  "conversionValue": number,
  "conversionCount": number
}
Campi
destinationReferences[]

string

Facoltativo. Stringa di riferimento utilizzata per determinare la destinazione. Se vuoto, l'evento verrà inviato a tutti i destinations nella richiesta.
transactionId

string

Facoltativo. L'identificatore univoco di questo evento. Obbligatorio per gli eventi inviati come origine dati aggiuntiva per le conversioni dei tag.
eventTimestamp

string (Timestamp format)

Obbligatorio. L'ora in cui si è verificato l'evento.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
lastUpdatedTimestamp

string (Timestamp format)

Facoltativo. L'ultima volta che l'evento è stato aggiornato.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
userData

object (UserData)

Facoltativo. Elementi dei dati forniti dagli utenti che rappresentano l'utente a cui è associato l'evento.
consent

object (Consent)

Facoltativo. Informazioni sul fatto che l'utente associato abbia fornito o meno diversi tipi di consenso.
adIdentifiers

object (AdIdentifiers)

Facoltativo. Identificatori e altre informazioni utilizzati per abbinare l'evento di conversione ad altre attività online (ad esempio i clic sugli annunci).
currency

string

Facoltativo. Il codice valuta associato a tutti i valori monetari all'interno di questo evento.
eventSource

enum (EventSource)

Facoltativo. Indicatore del luogo in cui si è verificato l'evento (web, app, in negozio e così via).
eventDeviceInfo

object (DeviceInfo)

Facoltativo. Informazioni raccolte sul dispositivo utilizzato (se presente) al momento dell'evento.
cartData

object (CartData)

Facoltativo. Informazioni sulla transazione e sugli articoli associati all'evento.
customVariables[]

object (CustomVariable)

Facoltativo. Informazioni aggiuntive sulla coppia chiave-valore da inviare ai contenitori di conversione (azione di conversione o attività FL).
experimentalFields[]

object (ExperimentalField)

Facoltativo. Un elenco di coppie chiave/valore per i campi sperimentali che potrebbero essere promossi per far parte dell'API.
userProperties

object (UserProperties)

Facoltativo. Informazioni sull'utente valutate dall'inserzionista al momento dell'evento.
eventName

string

Facoltativo. Il nome dell'evento. Obbligatorio per gli eventi GA4.
clientId

string

Facoltativo. Un identificatore univoco per l'istanza utente di un client web per questo stream web GA4.
userId

string

Facoltativo. Un identificatore univoco per un utente, come definito dall'inserzionista.
additionalEventParameters[]

object (EventParameter)

Facoltativo. Un bucket di parametri evento da includere nell'evento che non sono già stati specificati utilizzando altri campi strutturati.
thirdPartyUserData

object (UserData)

Facoltativo. Lo stesso tipo di dati forniti in userData, ma contrassegnati esplicitamente come forniti in quanto di proprietà di una terza parte e non come dati proprietari dell'inserzionista.
eventLocation

object (EventLocation)

Facoltativo. Informazioni raccolte sulla posizione dell'utente quando si è verificato questo evento.
appInstanceId

string

Facoltativo. Un identificatore univoco per l'istanza utente di un client dell'app per questo stream di app GA4.
callInfo

object (CallInfo)

Facoltativo. Informazioni raccolte sulla chiamata (se pertinente) che ha generato questo evento.
conversionValue

number

Facoltativo. Il valore di conversione associato all'evento, per le conversioni basate sul valore.
conversionCount

number

Facoltativo. La quantità di conversioni associata all'evento, per le conversioni basate sul conteggio.

AdIdentifiers

Identificatori e altre informazioni utilizzati per abbinare l'evento di conversione ad altre attività online (ad esempio i clic sugli annunci).

Rappresentazione JSON 
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": string,
  "dclid": string,
  "impressionId": string,
  "matchId": string,
  "encryptedUserIds": [
    {
      object (EncryptedUserId)
    }
  ],
  "ppid": string,
  "visitorPpid": string,
  "leadId": string
}
Campi
sessionAttributes

string

Facoltativo. Attributi della sessione per l'attribuzione e la definizione del modello degli eventi.
gclid

string

Facoltativo. L'ID clic Google (gclid) associato a questo evento.
gbraid

string

Facoltativo. L'identificatore dei clic associati agli eventi app e provenienti da dispositivi iOS a partire da iOS 14.
wbraid

string

Facoltativo. L'identificatore dei clic associati agli eventi web e provenienti da dispositivi iOS a partire da iOS 14.
landingPageDeviceInfo

object (DeviceInfo)

Facoltativo. Informazioni raccolte sul dispositivo utilizzato (se presente) al momento dell'atterraggio sul sito dell'inserzionista dopo l'interazione con l'annuncio.
mobileDeviceId

string

Facoltativo. L'identificatore mobile per gli inserzionisti. Si tratta dell'IDFA su iOS, dell'ID pubblicità su Android o degli identificatori per gli inserzionisti di altre piattaforme.
dclid

string

Facoltativo. L'ID clic display associato a questo evento.
impressionId

string

Facoltativo. L'ID impressione associato a questo evento.
matchId

string

Facoltativo. Il campo ID corrispondenza utilizzato per unire questo evento a un evento precedente.
encryptedUserIds[]

object (EncryptedUserId)

Facoltativo. Qualsiasi numero di ID utente criptati.
ppid

string

Facoltativo. Un identificatore univoco per un utente autenticato (che ha eseguito l'accesso), come definito dal publisher.
visitorPpid

string

Facoltativo. Un identificatore univoco per un utente non autenticato (utente che non ha eseguito l'accesso), come definito dal publisher.
leadId

string

Facoltativo. ID generato da Google emesso quando l'utente invia un modulo per i lead.

EncryptedUserId

Un identificatore dell'utente emesso per essere utilizzato per l'attribuzione. Tutti i campi sono obbligatori se viene utilizzato questo attributo.

Rappresentazione JSON 
{
  "encryptedId": string,
  "entityType": enum (EncryptionEntityType),
  "entityId": string,
  "source": enum (EncryptionSource)
}
Campi
encryptedId

string

Obbligatorio. L'ID criptato alfanumerico.
entityType

enum (EncryptionEntityType)

Obbligatorio. Il tipo di entità di crittografia. Deve corrispondere alla configurazione della crittografia per la pubblicazione di annunci o Data Transfer.
entityId

string (int64 format)

Obbligatorio. L'ID entità di crittografia. Deve corrispondere alla configurazione della crittografia per la pubblicazione di annunci o Data Transfer.
source

enum (EncryptionSource)

Obbligatorio. Indica se il cookie criptato è stato ricevuto dalla pubblicazione di annunci (la macro %m) o da Data Transfer.

EncryptionEntityType

Il tipo di entità di crittografia.

Enum
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED Tipo di entità di crittografia non specificato.
CAMPAIGN_MANAGER_ACCOUNT Account Campaign Manager 360.
CAMPAIGN_MANAGER_ADVERTISER Inserzionista Campaign Manager 360.
DISPLAY_VIDEO_PARTNER Partner Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Inserzionista Display & Video 360.
GOOGLE_ADS_CUSTOMER Cliente Google Ads.
GOOGLE_AD_MANAGER_NETWORK_CODE Codice di rete Google Ad Manager.

EncryptionSource

L'origine della crittografia.

Enum
ENCRYPTION_SOURCE_UNSPECIFIED Origine della crittografia non specificata.
AD_SERVING Origine della crittografia per la pubblicazione di annunci.
DATA_TRANSFER Origine della crittografia del trasferimento di dati.

EventSource

L'origine dell'evento.

Enum
EVENT_SOURCE_UNSPECIFIED EventSource non specificato. Non deve mai essere utilizzato.
WEB L'evento è stato generato da un browser web.
APP L'evento è stato generato da un'app.
IN_STORE L'evento è stato generato da una transazione in negozio.
PHONE L'evento è stato generato da una telefonata.
MESSAGE L'evento è stato generato da un messaggio.
OTHER L'evento è stato generato da altre origini.

CartData

I dati del carrello associati all'evento.

Rappresentazione JSON 
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ],
  "couponCodes": [
    string
  ]
}
Campi
merchantId

string

Facoltativo. L'ID Merchant Center associato agli articoli.
merchantFeedLabel

string

Facoltativo. L'etichetta del feed di Merchant Center associata al feed degli articoli.
merchantFeedLanguageCode

string

Facoltativo. Il codice lingua ISO 639-1 associato al feed di Merchant Center degli articoli in cui vengono caricati i tuoi articoli.
transactionDiscount

number

Facoltativo. La somma di tutti gli sconti associati alla transazione.
items[]

object (Item)

Facoltativo. L'elenco di articoli associati all'evento.
couponCodes[]

string

Facoltativo. L'elenco dei codici coupon applicati al carrello. I codici coupon a livello di carrello e di articolo sono indipendenti tra loro.

Se l'evento è per una destinazione Google Analytics, fornisci un solo codice coupon. Google Analytics ignora i codici coupon aggiuntivi.

Elemento

Rappresenta un articolo nel carrello associato all'evento.

Rappresentazione JSON 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number,
  "itemId": string,
  "additionalItemParameters": [
    {
      object (ItemParameter)
    }
  ],
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "customVariables": [
    {
      object (ItemCustomVariable)
    }
  ],
  "conversionValue": number
}
Campi
merchantProductId

string

Facoltativo. L'ID prodotto nell'account Merchant Center.
quantity

string (int64 format)

Facoltativo. Il numero di questo articolo associato all'evento.
unitPrice

number

Facoltativo. Il prezzo unitario al netto di tasse, spese di spedizione ed eventuali sconti a livello di transazione.
itemId

string

Facoltativo. Un identificatore univoco per fare riferimento all'elemento.
additionalItemParameters[]

object (ItemParameter)

Facoltativo. Un bucket di parametri evento correlati a un articolo da includere nell'evento che non sono già stati specificati utilizzando altri campi strutturati.
merchantId

string

Facoltativo. L'ID Merchant Center associato all'articolo. Per gli eventi di vendita in negozio, questo valore sostituirà quello impostato a livello di carrello. Questo campo viene ignorato per gli altri eventi.
merchantFeedLabel

string

Facoltativo. L'etichetta del feed di Merchant Center. Se i paesi sono ancora in uso, è possibile utilizzare il codice paese di due lettere nel formato ISO-3166-1 alpha-2. Per gli eventi di vendita in negozio, questo valore sostituirà quello impostato a livello di carrello. Questo campo viene ignorato per gli altri eventi.
merchantFeedLanguageCode

string

Facoltativo. Il codice lingua ISO 639-1 associato al feed di Merchant Center nel quale vengono caricati i tuoi articoli.
customVariables[]

object (ItemCustomVariable)

Facoltativo. Informazioni aggiuntive sulla coppia chiave-valore da inviare ai contenitori di conversione (azione di conversione o attività Floodlight) durante il monitoraggio delle conversioni per articolo.
conversionValue

number

Facoltativo. Il valore di conversione associato a questo elemento all'interno dell'evento, nei casi in cui il valore di conversione è diverso per ogni elemento.

ItemParameter

Un bucket di parametri evento correlati a un articolo da includere nell'evento che non sono già stati specificati utilizzando altri campi strutturati.

Rappresentazione JSON 
{
  "parameterName": string,
  "value": string
}
Campi
parameterName

string

Obbligatorio. Il nome del parametro da utilizzare.
value

string

Obbligatorio. La rappresentazione di stringa del valore del parametro da impostare.

ItemCustomVariable

Variabile personalizzata a livello di articolo per le conversioni degli annunci.

Rappresentazione JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Campi
variable

string

Facoltativo. Il nome della variabile personalizzata da impostare. Se la variabile non viene trovata per la destinazione specificata, verrà ignorata.
value

string

Facoltativo. Il valore da memorizzare per la variabile personalizzata.
destinationReferences[]

string

Facoltativo. Stringa di riferimento utilizzata per determinare a quale Event.destination_references deve essere inviata la variabile personalizzata. Se il campo è vuoto, verrà utilizzato Event.destination_references.

CustomVariable

Variabile personalizzata per le conversioni degli annunci.

Rappresentazione JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Campi
variable

string

Facoltativo. Il nome della variabile personalizzata da impostare. Se la variabile non viene trovata per la destinazione specificata, verrà ignorata.
value

string

Facoltativo. Il valore da memorizzare per la variabile personalizzata.
destinationReferences[]

string

Facoltativo. Stringa di riferimento utilizzata per determinare a quale Event.destination_references deve essere inviata la variabile personalizzata. Se il campo è vuoto, verrà utilizzato Event.destination_references.

ExperimentalField

Campo sperimentale che rappresenta campi non ufficiali.

Rappresentazione JSON 
{
  "field": string,
  "value": string
}
Campi
field

string

Facoltativo. Il nome del campo da utilizzare.
value

string

Facoltativo. Il valore del campo da impostare.

UserProperties

Informazioni sull'utente valutate dall'inserzionista al momento dell'evento. Per maggiori dettagli, consulta la pagina https://support.google.com/google-ads/answer/14007601.

Rappresentazione JSON 
{
  "customerType": enum (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket),
  "additionalUserProperties": [
    {
      object (UserProperty)
    }
  ]
}
Campi
customerType

enum (CustomerType)

Facoltativo. Tipo di cliente associato all'evento.
customerValueBucket

enum (CustomerValueBucket)

Facoltativo. Il valore del cliente valutato dall'inserzionista.
additionalUserProperties[]

object (UserProperty)

Facoltativo. Un bucket di eventuali proprietà utente aggiuntive per l'utente associato a questo evento.

CustomerType

Tipo di cliente associato all'evento.

Enum
CUSTOMER_TYPE_UNSPECIFIED CustomerType non specificato. Non deve mai essere utilizzato.
NEW Il cliente è nuovo per l'inserzionista.
RETURNING Il cliente sta tornando dall'inserzionista.
REENGAGED Il cliente ha interagito di nuovo con l'inserzionista.

CustomerValueBucket

Il valore del cliente valutato dall'inserzionista.

Enum
CUSTOMER_VALUE_BUCKET_UNSPECIFIED CustomerValueBucket non specificato. Non deve mai essere utilizzato.
LOW Il cliente è di basso valore.
MEDIUM Il cliente è di valore medio.
HIGH Il cliente è di alto valore.

UserProperty

Un bucket di eventuali proprietà utente aggiuntive per l'utente associato a questo evento.

Rappresentazione JSON 
{
  "propertyName": string,
  "value": string
}
Campi
propertyName

string

Obbligatorio. Il nome della proprietà utente da utilizzare.
value

string

Obbligatorio. La rappresentazione stringa del valore della proprietà utente da utilizzare.

EventParameter

Parametro evento per gli eventi GA4.

Rappresentazione JSON 
{
  "parameterName": string,
  "value": string
}
Campi
parameterName

string

Obbligatorio. Il nome del parametro da utilizzare.
value

string

Obbligatorio. La rappresentazione di stringa del valore del parametro da impostare.

EventLocation

La località in cui si è verificato l'evento.

Rappresentazione JSON 
{
  "storeId": string,
  "city": string,
  "subdivisionCode": string,
  "regionCode": string,
  "subcontinentCode": string,
  "continentCode": string
}
Campi
storeId

string

Facoltativo. Obbligatorio per le vendite in negozio. L'identificatore che rappresenta un negozio fisico in cui si è verificato l'evento.
city

string

Facoltativo. Il nome della città in cui si è verificato l'evento.
subdivisionCode

string

Facoltativo. Il codice di sottodivisione ISO 3166-2 in cui si è verificato l'evento.
regionCode

string

Facoltativo. Il codice regione CLDR di due lettere dell'indirizzo dell'utente.
subcontinentCode

string

Facoltativo. Il codice del subcontinente in formato UN M49 in cui si è verificato l'evento.
continentCode

string

Facoltativo. Il codice del continente in formato UN M49 in cui si è verificato l'evento.

CallInfo

Informazioni raccolte sulla chiamata (se pertinente) che ha generato questo evento.

Rappresentazione JSON 
{
  "startTimestamp": string
}
Campi
startTimestamp

string (Timestamp format)

Obbligatorio. L'ora di inizio della telefonata che ha generato questo evento.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".