Package google.ads.datamanager.v1

Indice

IngestionService

Servizio per l'invio dei dati del pubblico alle destinazioni supportate.

IngestAudienceMembers

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

Carica un elenco di risorse AudienceMember nel Destination fornito.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

Carica un elenco di risorse Event dal Destination fornito.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

Rimuove un elenco di risorse AudienceMember dal Destination fornito.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

AdIdentifiers

Identificatori e altre informazioni utilizzate per mettere in corrispondenza l'evento di conversione con altre attività online (ad esempio clic sugli annunci).

Campi
session_attributes

string

(Facoltativo) Attributi sessione per l'attribuzione e la modellazione 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.

landing_page_device_info

DeviceInfo

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

AddressInfo

Informazioni sull'indirizzo dell'utente.

Campi
given_name

string

Obbligatorio. Nome (di battesimo) dell'utente, tutto in minuscolo, senza punteggiatura, senza spazi iniziali o finali e sottoposto ad hashing come SHA-256.

family_name

string

Obbligatorio. Cognome dell'utente, tutto in minuscolo, senza punteggiatura, senza spazi iniziali o finali e sottoposto ad hashing come SHA-256.

region_code

string

Obbligatorio. Il codice regione di due lettere nel formato ISO-3166-1 alpha-2 dell'indirizzo dell'utente.

postal_code

string

Obbligatorio. Il codice postale dell'indirizzo dell'utente.

AudienceMember

Il membro del pubblico su cui eseguire l'operazione.

Campi
consent

Consent

(Facoltativo) L'impostazione del consenso per l'utente.

Campo unione data. Il tipo di dati identificativi su cui operare. data può essere solo uno dei seguenti:
user_data

UserData

Dati forniti dall'utente che lo identificano.

pair_data

PairData

ID Publisher Advertiser Identity Reconciliation (PAIR).

mobile_data

MobileData

Dati che identificano i dispositivi mobili dell'utente.

CartData

I dati del carrello associati all'evento.

Campi
merchant_id

string

(Facoltativo) L'ID Merchant Center associato agli articoli.

merchant_feed_label

string

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

merchant_feed_language_code

string

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

transaction_discount

double

(Facoltativo) La somma di tutti gli sconti associati alla transazione.

items[]

Item

(Facoltativo) L'elenco degli articoli associati all'evento.

Impostazioni per il consenso ai sensi del Digital Markets Act (DMA) per l'utente.

Campi
ad_user_data

ConsentStatus

(Facoltativo) Indica se l'utente acconsente all'utilizzo dei dati utente per la pubblicità.

ad_personalization

ConsentStatus

(Facoltativo) Indica se l'utente acconsente alla personalizzazione degli annunci.

ConsentStatus

Indica se l'utente ha concesso, negato o non ha specificato il consenso.

Enum
CONSENT_STATUS_UNSPECIFIED Non specificato.
CONSENT_GRANTED Concesso.
CONSENT_DENIED Rifiutato.

CustomVariable

Variabile personalizzata per le conversioni degli annunci.

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.

destination_references[]

string

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

CustomerType

Tipo di cliente associato all'evento.

Enum
CUSTOMER_TYPE_UNSPECIFIED CustomerType non specificato. Non deve mai essere utilizzato.
NEW Il cliente non ha mai acquistato dall'inserzionista.
RETURNING Il cliente torna all'inserzionista.
REENGAGED Il cliente ha interagito di nuovo con l'inserzionista.

CustomerValueBucket

Il valore del cliente valutato dall'inserzionista.

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

Destinazione

Il prodotto Google a cui invii i dati. Ad esempio, un account Google Ads.

Campi
reference

string

(Facoltativo) ID per questa risorsa Destination, univoco all'interno della richiesta. Utilizza questo valore per fare riferimento a Destination in IngestEventsRequest.

login_account

ProductAccount

(Facoltativo) L'account utilizzato per effettuare questa chiamata API. Per aggiungere o rimuovere dati da operating_account, questo login_account deve disporre dell'accesso in scrittura a operating_account. Ad esempio, un account amministratore di operating_account o un account con un collegamento stabilito a operating_account.

linked_account

ProductAccount

(Facoltativo) Un account a cui il login_account dell'utente chiamante ha accesso tramite un collegamento dell'account stabilito. Ad esempio, il login_account di un partner di dati potrebbe avere accesso al linked_account di un cliente. Il partner potrebbe utilizzare questo campo per inviare dati da linked_account a un altro operating_account.

operating_account

ProductAccount

Obbligatorio. L'account a cui inviare i dati o da cui rimuoverli.

product_destination_id

string

Obbligatorio. L'oggetto all'interno dell'account prodotto in cui eseguire l'importazione. Ad esempio, un ID segmento di pubblico Google Ads o un ID segmento di pubblico Display & Video 360.

DeviceInfo

Informazioni sul dispositivo utilizzato (se presente) quando si è verificato l'evento.

Campi
user_agent

string

(Facoltativo) La stringa user agent del dispositivo per il contesto specificato.

ip_address

string

(Facoltativo) L'indirizzo IP del dispositivo per il contesto specificato.

Nota: Google Ads non supporta la corrispondenza degli indirizzi IP per gli utenti finali nello Spazio economico europeo (SEE), nel Regno Unito (UK) o in Svizzera (CH). Aggiungi una logica per escludere in modo condizionale la condivisione degli indirizzi IP degli utenti di queste regioni e assicurati di fornire agli utenti informazioni chiare e complete sui dati raccolti sui tuoi siti, nelle tue app e in altre proprietà e di ottenere il consenso ove richiesto dalla legge o da eventuali norme di Google applicabili. Per ulteriori dettagli, consulta la pagina Informazioni sulle importazioni delle conversioni offline.

Codifica

Il tipo di codifica delle informazioni identificative sottoposte ad hashing.

Enum
ENCODING_UNSPECIFIED Tipo di codifica non specificato. Non deve mai essere utilizzato.
HEX Codifica esadecimale.
BASE64 Codifica Base 64.

EncryptionInfo

Informazioni sulla crittografia per i dati di cui viene eseguito l'inserimento.

Campi
Campo unione wrapped_key. La chiave sottoposta a wrapping utilizzata per criptare i dati. wrapped_key può essere solo uno dei seguenti:
gcp_wrapped_key_info

GcpWrappedKeyInfo

Informazioni sulla chiave di wrapping di Google Cloud.

Evento

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

Campi
destination_references[]

string

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

transaction_id

string

Obbligatorio. L'identificatore univoco di questo evento.

event_timestamp

Timestamp

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

last_updated_timestamp

Timestamp

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

user_data

UserData

(Facoltativo) Parti di dati forniti dall'utente, che rappresentano l'utente a cui è associato l'evento.

consent

Consent

(Facoltativo) Informazioni sul fatto che l'utente associato abbia fornito diversi tipi di consenso.

ad_identifiers

AdIdentifiers

(Facoltativo) Identificatori e altre informazioni utilizzate per mettere in corrispondenza l'evento di conversione con altre attività online (ad esempio clic sugli annunci).

currency

string

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

conversion_value

double

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

event_source

EventSource

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

event_device_info

DeviceInfo

(Facoltativo) Informazioni raccolte sul dispositivo utilizzato (se presente) quando si è verificato l'evento.

cart_data

CartData

(Facoltativo) Informazioni sulla transazione e sugli articoli associati all'evento.

custom_variables[]

CustomVariable

(Facoltativo) Informazioni aggiuntive sulle coppie chiave/valore da inviare ai contenitori di conversione (azione di conversione o attività Floodlight).

experimental_fields[]

ExperimentalField

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

user_properties

UserProperties

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

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 chiamata.
OTHER L'evento è stato generato da altre fonti.

ExperimentalField

Campo sperimentale che rappresenta i campi non ufficiali.

Campi
field

string

(Facoltativo) Il nome del campo da utilizzare.

value

string

(Facoltativo) Il valore del campo da impostare.

GcpWrappedKeyInfo

Informazioni sulla chiave di wrapping di Google Cloud Platform.

Campi
key_type

KeyType

Obbligatorio. Il tipo di algoritmo utilizzato per criptare i dati.

wip_provider

string

Obbligatorio. Il provider di pool Workload Identity richiesto per utilizzare la KEK.

kek_uri

string

Obbligatorio. ID risorsa Cloud Key Management Service della piattaforma Google Cloud.

encrypted_dek

string

Obbligatorio. La chiave di crittografia dei dati criptati con codifica base64.

KeyType

Il tipo di algoritmo utilizzato per criptare i dati.

Enum
KEY_TYPE_UNSPECIFIED Tipo di chiave non specificato. Non deve mai essere utilizzato.
XCHACHA20_POLY1305 Algoritmo XChaCha20-Poly1305

IngestAudienceMembersRequest

Richiedi di caricare i membri del segmento di pubblico nelle destinazioni fornite. Restituisce un IngestAudienceMembersResponse.

Campi
destinations[]

Destination

Obbligatorio. L'elenco delle destinazioni a cui inviare i membri del segmento di pubblico.

audience_members[]

AudienceMember

Obbligatorio. L'elenco degli utenti da inviare alle destinazioni specificate. In una singola richiesta possono essere inviate al massimo 10.000 risorse AudienceMember.

consent

Consent

(Facoltativo) Consenso a livello di richiesta da applicare a tutti gli utenti della richiesta. Il consenso a livello di utente sostituisce il consenso a livello di richiesta e può essere specificato in ogni AudienceMember.

validate_only

bool

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

encoding

Encoding

(Facoltativo) Obbligatorio per i caricamenti di UserData. Il tipo di codifica degli identificatori utente. Per gli identificatori utente sottoposti ad hashing, questo è il tipo di codifica della stringa sottoposta ad hashing. Per gli identificatori utente sottoposti ad hashing criptato, questo è il tipo di codifica della stringa criptata esterna, ma non necessariamente della stringa sottoposta ad hashing interna, il che significa che la stringa sottoposta ad hashing interna potrebbe essere codificata in modo diverso rispetto alla stringa criptata esterna. Per i caricamenti non UserData, questo campo viene ignorato.

encryption_info

EncryptionInfo

(Facoltativo) Informazioni sulla crittografia per i caricamenti di UserData. Se non viene impostato, si presume che i dati identificativi caricati siano sottoposti ad hashing, ma non criptati. Per i caricamenti non UserData, questo campo viene ignorato.

terms_of_service

TermsOfService

(Facoltativo) I Termini di servizio che l'utente ha accettato/rifiutato.

IngestAudienceMembersResponse

Risposta da IngestAudienceMembersRequest.

Campi
request_id

string

L'ID generato automaticamente della richiesta.

IngestEventsRequest

Richiedi di caricare i membri del segmento di pubblico nelle destinazioni fornite. Restituisce un IngestEventsResponse.

Campi
destinations[]

Destination

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

events[]

Event

Obbligatorio. L'elenco degli eventi da inviare alle destinazioni specificate. In una singola richiesta possono essere inviate al massimo 2000 risorse Event.

consent

Consent

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

validate_only

bool

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

encoding

Encoding

(Facoltativo) Obbligatorio per i caricamenti di UserData. Il tipo di codifica degli identificatori utente. Per gli identificatori utente sottoposti ad hashing, questo è il tipo di codifica della stringa sottoposta ad hashing. Per gli identificatori utente sottoposti ad hashing criptato, questo è il tipo di codifica della stringa criptata esterna, ma non necessariamente della stringa sottoposta ad hashing interna, il che significa che la stringa sottoposta ad hashing interna potrebbe essere codificata in modo diverso rispetto alla stringa criptata esterna. Per i caricamenti non UserData, questo campo viene ignorato.

encryption_info

EncryptionInfo

(Facoltativo) Informazioni sulla crittografia per i caricamenti di UserData. Se non viene impostato, si presume che i dati identificativi caricati siano sottoposti ad hashing, ma non criptati. Per i caricamenti non UserData, questo campo viene ignorato.

IngestEventsResponse

Risposta da IngestEventsRequest.

Campi
request_id

string

L'ID generato automaticamente della richiesta.

Elemento

Rappresenta un articolo nel carrello associato all'evento.

Campi
merchant_product_id

string

(Facoltativo) L'ID prodotto all'interno dell'account Merchant Center.

quantity

int64

(Facoltativo) Il numero di questo elemento associato all'evento.

unit_price

double

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

MobileData

ID mobile per il pubblico. È richiesto almeno un ID dispositivo mobile.

Campi
mobile_ids[]

string

Obbligatorio. L'elenco degli ID dispositivi mobili (ID pubblicità/IDFA). Possono essere forniti al massimo 10 mobileIds in un singolo AudienceMember.

PairData

ID PAIR per il segmento di pubblico. È richiesto almeno un ID coppia.

Campi
pair_ids[]

string

Obbligatorio. Dati PII forniti dalla data clean room, sottoposti ad hashing con SHA256 e criptati con una cifratura commutativa EC utilizzando la chiave del publisher per l'elenco utenti PAIR. Possono essere forniti al massimo 10 pairIds in un singolo AudienceMember.

Prodotto

Rappresenta un prodotto Google specifico. Utilizzato per individuare account e destinazioni.

Enum
PRODUCT_UNSPECIFIED Prodotto non specificato. Non deve mai essere utilizzato.
GOOGLE_ADS Google Ads.
DISPLAY_VIDEO_PARTNER Partner Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Inserzionista Display & Video 360.
DATA_PARTNER Partner di dati.

ProductAccount

Rappresenta un account specifico.

Campi
product

Product

Obbligatorio. Il prodotto a cui appartiene l'account. Ad esempio, GOOGLE_ADS.

account_id

string

Obbligatorio. L'ID dell'account. Ad esempio, l'ID account Google Ads.

RemoveAudienceMembersRequest

Richiedi la rimozione degli utenti da un segmento di pubblico nelle destinazioni fornite. Restituisce un valore RemoveAudienceMembersResponse.

Campi
destinations[]

Destination

Obbligatorio. L'elenco delle destinazioni da cui rimuovere gli utenti.

audience_members[]

AudienceMember

Obbligatorio. L'elenco degli utenti da rimuovere.

validate_only

bool

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

encoding

Encoding

(Facoltativo) Obbligatorio per i caricamenti di UserData. Il tipo di codifica degli identificatori utente. Si applica solo alla codifica esterna degli identificatori utente criptati. Per i caricamenti non UserData, questo campo viene ignorato.

encryption_info

EncryptionInfo

(Facoltativo) Informazioni sulla crittografia per i caricamenti di UserData. Se non viene impostato, si presume che i dati identificativi caricati siano sottoposti ad hashing, ma non criptati. Per i caricamenti non UserData, questo campo viene ignorato.

RemoveAudienceMembersResponse

Risposta da RemoveAudienceMembersRequest.

Campi
request_id

string

L'ID generato automaticamente della richiesta.

TermsOfService

I Termini di servizio che l'utente ha accettato/rifiutato.

Campi
customer_match_terms_of_service_status

TermsOfServiceStatus

(Facoltativo) Termini di servizio di Customer Match: https://support.google.com/adspolicy/answer/6299717. Questo deve essere accettato per tutti i caricamenti negli elenchi utenti Customer Match.

TermsOfServiceStatus

Rappresenta la decisione del chiamante di accettare o rifiutare i Termini di servizio.

Enum
TERMS_OF_SERVICE_STATUS_UNSPECIFIED Non specificato.
ACCEPTED Stato che indica che il chiamante ha scelto di accettare i termini di servizio.
REJECTED Stato che indica che il chiamante ha scelto di rifiutare i termini di servizio.

UserData

Dati che identificano l'utente. È richiesto almeno un identificatore.

Campi
user_identifiers[]

UserIdentifier

Obbligatorio. Gli identificatori dell'utente. È possibile fornire più istanze dello stesso tipo di dati (ad esempio, più indirizzi email). Per aumentare la probabilità di una corrispondenza, fornisci il maggior numero possibile di identificatori. Possono essere forniti al massimo 10 userIdentifiers in un singolo AudienceMember o Event.

UserIdentifier

Un unico identificatore per l'utente.

Campi
Campo unione identifier. Deve essere specificato esattamente un valore. identifier può essere solo uno dei seguenti:
email_address

string

Indirizzo email sottoposto ad hashing utilizzando la funzione hash SHA-256 dopo la normalizzazione.

phone_number

string

Numero di telefono sottoposto ad hashing utilizzando la funzione hash SHA-256 dopo la normalizzazione (standard E164).

address

AddressInfo

I componenti noti dell'indirizzo di un utente. Contiene un raggruppamento di identificatori che vengono abbinati contemporaneamente.

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.

Campi
customer_type

CustomerType

(Facoltativo) Tipo di cliente associato all'evento.

customer_value_bucket

CustomerValueBucket

(Facoltativo) Il valore del cliente valutato dall'inserzionista.