Package google.ads.datamanager.v1

Index

IngestionService

Service permettant d'envoyer des données d'audience vers des destinations compatibles.

IngestAudienceMembers

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

Importe une liste de ressources AudienceMember dans le Destination fourni.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

Importe une liste de ressources Event à partir du Destination fourni.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

Supprime une liste de ressources AudienceMember du Destination fourni.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

AdIdentifiers

Identifiants et autres informations utilisés pour faire correspondre l'événement de conversion à d'autres activités en ligne (comme les clics sur les annonces).

Champs
session_attributes

string

Facultatif. Attributs de session pour l'attribution et la modélisation des événements.
gclid

string

Facultatif. ID de clic Google (gclid) associé à cet événement.
gbraid

string

Facultatif. Identifiant des clics associés aux événements d'application et provenant d'appareils iOS (à partir d'iOS 14).
wbraid

string

Facultatif. Identifiant des clics associés aux événements Web et provenant d'appareils iOS (à partir d'iOS 14).
landing_page_device_info

DeviceInfo

Facultatif. Informations recueillies sur l'appareil utilisé (le cas échéant) au moment de l'arrivée sur le site de l'annonceur après l'interaction avec l'annonce.

AddressInfo

Informations sur l'adresse de l'utilisateur.

Champs
given_name

string

Obligatoire. Prénom de l'utilisateur, en minuscules, sans ponctuation, sans espace de début ni de fin, et haché au format SHA-256.
family_name

string

Obligatoire. Nom de famille de l'utilisateur, en minuscules, sans ponctuation, sans espace de début ni de fin, et haché au format SHA-256.
region_code

string

Obligatoire. Code de région à deux lettres au format ISO-3166-1 alpha-2 de l'adresse de l'utilisateur.
postal_code

string

Obligatoire. Code postal de l'adresse de l'utilisateur.

AudienceMember

Membre de l'audience sur lequel effectuer l'opération.

Champs
consent

Consent

Facultatif. Paramètre de consentement de l'utilisateur.
Champ d'union data. Type de données d'identification à traiter. data ne peut être qu'un des éléments suivants :
user_data

UserData

Données fournies par l'utilisateur qui l'identifient.
pair_data

PairData

ID Publisher Advertiser Identity Reconciliation (PAIR).
mobile_data

MobileData

Données permettant d'identifier les appareils mobiles de l'utilisateur.

CartData

Données du panier associées à l'événement.

Champs
merchant_id

string

Facultatif. ID Merchant Center associé aux articles.
merchant_feed_label

string

Facultatif. Libellé du flux Merchant Center associé au flux des articles.
merchant_feed_language_code

string

Facultatif. Code de langue ISO 639-1 associé au flux Merchant Center des articles dans lequel vos articles sont importés.
transaction_discount

double

Facultatif. Somme de toutes les remises associées à la transaction.
items[]

Item

Facultatif. Liste des éléments associés à l'événement.

Paramètres de consentement de l'utilisateur pour la loi sur les marchés numériques (DMA, Digital Markets Act).

Champs
ad_user_data

ConsentStatus

Facultatif. Indique si l'utilisateur accepte les données utilisateur publicitaires.
ad_personalization

ConsentStatus

Facultatif. Indique si l'utilisateur accepte la personnalisation des annonces.

ConsentStatus

Indique si l'utilisateur a accordé ou refusé son consentement, ou s'il ne l'a pas spécifié.

Enums
CONSENT_STATUS_UNSPECIFIED Non spécifié.
CONSENT_GRANTED Accordé.
CONSENT_DENIED Refusée.

Variable personnalisée

Variable personnalisée pour les conversions d'annonces.

Champs
variable

string

Facultatif. Nom de la variable personnalisée à définir. Si la variable n'est pas trouvée pour la destination indiquée, elle sera ignorée.
value

string

Facultatif. Valeur à stocker pour la variable personnalisée.
destination_references[]

string

Facultatif. Chaîne de référence utilisée pour déterminer à quel Event.destination_references la variable personnalisée doit être envoyée. Si ce champ est vide, le Event.destination_references sera utilisé.

CustomerType

Type de client associé à l'événement.

Enums
CUSTOMER_TYPE_UNSPECIFIED Type de client non spécifié. Ce type ne doit jamais être utilisé.
NEW Le client est nouveau pour l'annonceur.
RETURNING Le client revient vers l'annonceur.
REENGAGED Le client a de nouveau interagi avec l'annonceur.

CustomerValueBucket

Valeur du client évaluée par l'annonceur.

Enums
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Bucket de valeur client non spécifié. Ce type ne doit jamais être utilisé.
LOW Le client a un faible potentiel.
MEDIUM Le client a un potentiel moyen.
HIGH Le client est à fort potentiel.

Destination

Produit Google vers lequel vous envoyez des données. (par exemple, un compte Google Ads).

Champs
reference

string

Facultatif. ID de cette ressource Destination, unique dans la requête. Permet de faire référence à ce Destination dans IngestEventsRequest.
login_account

ProductAccount

Facultatif. Compte utilisé pour effectuer cet appel d'API. Pour ajouter ou supprimer des données du operating_account, ce login_account doit disposer d'un accès en écriture au operating_account. Par exemple, un compte administrateur de operating_account ou un compte associé à operating_account.
linked_account

ProductAccount

Facultatif. Compte auquel le login_account de l'utilisateur appelant a accès via une association de compte établie. Par exemple, le login_account d'un partenaire de données peut avoir accès au linked_account d'un client. Le partenaire peut utiliser ce champ pour envoyer des données du linked_account à un autre operating_account.
operating_account

ProductAccount

Obligatoire. Compte vers lequel envoyer les données ou depuis lequel les supprimer.
product_destination_id

string

Obligatoire. Objet du compte produit à ingérer. Par exemple, un ID d'audience Google Ads ou Display & Video 360.

DeviceInfo

Informations sur l'appareil utilisé (le cas échéant) au moment de l'événement.

Champs
user_agent

string

Facultatif. Chaîne user-agent de l'appareil pour le contexte donné.
ip_address

string

Facultatif. Adresse IP de l'appareil pour le contexte donné.

Remarque : Google Ads n'est pas compatible avec la mise en correspondance des adresses IP pour les utilisateurs finaux de l'Espace économique européen (EEE), du Royaume-Uni (UK) ou de la Suisse (CH). Ajoutez une logique pour exclure conditionnellement le partage des adresses IP des utilisateurs de ces régions. Assurez-vous également de fournir aux utilisateurs des informations claires et complètes sur les données que vous collectez sur vos sites, applications et autres propriétés, et d'obtenir leur consentement lorsque la loi ou les règles Google applicables l'exigent. Pour en savoir plus, consultez la page À propos de l'importation des conversions hors connexion.

Encodage

Type d'encodage des informations d'identification hachées.

Enums
ENCODING_UNSPECIFIED Type d'encodage non spécifié. Ce type ne doit jamais être utilisé.
HEX Encodage hexadécimal.
BASE64 Encodage Base64.

EncryptionInfo

Informations sur le chiffrement des données ingérées.

Champs
Champ d'union wrapped_key. La clé encapsulée utilisée pour chiffrer les données. La wrapped_key ne peut être qu'un des éléments suivants :
gcp_wrapped_key_info

GcpWrappedKeyInfo

Informations sur la clé encapsulée Google Cloud Platform.

Événement

Événement représentant une interaction utilisateur avec le site Web ou l'application d'un annonceur.

Champs
destination_references[]

string

Facultatif. Chaîne de référence utilisée pour déterminer la destination. Si ce champ est vide, l'événement sera envoyé à tous les destinations de la requête.
transaction_id

string

Obligatoire. Identifiant unique de cet événement.
event_timestamp

Timestamp

Obligatoire. Heure à laquelle l'événement s'est produit.
last_updated_timestamp

Timestamp

Facultatif. Date de la dernière modification de l'événement.
user_data

UserData

Facultatif. Éléments de données fournies par l'utilisateur, représentant l'utilisateur auquel l'événement est associé.
consent

Consent

Facultatif. Informations indiquant si l'utilisateur associé a donné différents types de consentement.
ad_identifiers

AdIdentifiers

Facultatif. Identifiants et autres informations utilisés pour faire correspondre l'événement de conversion à d'autres activités en ligne (comme les clics sur les annonces).
currency

string

Facultatif. Code de devise associé à toutes les valeurs monétaires de cet événement.
conversion_value

double

Facultatif. Valeur de conversion associée à l'événement, pour les conversions basées sur la valeur.
event_source

EventSource

Facultatif. Signal indiquant où l'événement s'est produit (sur le Web, dans une application, en magasin, etc.).
event_device_info

DeviceInfo

Facultatif. Informations recueillies sur l'appareil utilisé (le cas échéant) au moment de l'événement.
cart_data

CartData

Facultatif. Informations sur la transaction et les articles associés à l'événement.
custom_variables[]

CustomVariable

Facultatif. Informations supplémentaires sur les paires clé/valeur à envoyer aux conteneurs de conversion (action de conversion ou activité Floodlight).
experimental_fields[]

ExperimentalField

Facultatif. Liste de paires clé/valeur pour les champs expérimentaux qui pourront éventuellement être promus pour faire partie de l'API.
user_properties

UserProperties

Facultatif. Informations évaluées par l'annonceur sur l'utilisateur au moment de l'événement.

EventSource

Source de l'événement.

Enums
EVENT_SOURCE_UNSPECIFIED EventSource non spécifié. Ce type ne doit jamais être utilisé.
WEB L'événement a été généré à partir d'un navigateur Web.
APP L'événement a été généré à partir d'une application.
IN_STORE L'événement a été généré à partir d'une transaction en magasin.
PHONE L'événement a été généré à partir d'un appel téléphonique.
OTHER L'événement a été généré à partir d'autres sources.

ExperimentalField

Champ expérimental représentant les champs non officiels.

Champs
field

string

Facultatif. Nom du champ à utiliser.
value

string

Facultatif. Valeur à définir pour le champ.

GcpWrappedKeyInfo

Informations sur la clé de chiffrement Google Cloud Platform.

Champs
key_type

KeyType

Obligatoire. Type d'algorithme utilisé pour chiffrer les données.
wip_provider

string

Obligatoire. Fournisseur de pool Workload Identity requis pour utiliser la clé de chiffrement de clé.
kek_uri

string

Obligatoire. ID de ressource Cloud Key Management Service de Google Cloud Platform.
encrypted_dek

string

Obligatoire. Clé de chiffrement des données chiffrées encodée en base64.

KeyType

Type d'algorithme utilisé pour chiffrer les données.

Enums
KEY_TYPE_UNSPECIFIED Type de clé non spécifié. Ce type ne doit jamais être utilisé.
XCHACHA20_POLY1305 Algorithme XChaCha20-Poly1305

IngestAudienceMembersRequest

Demande d'importer des membres d'audience vers les destinations fournies. Renvoie un IngestAudienceMembersResponse.

Champs
destinations[]

Destination

Obligatoire. Liste des destinations vers lesquelles rediriger les membres de l'audience.
audience_members[]

AudienceMember

Obligatoire. Liste des utilisateurs à envoyer vers les destinations spécifiées. Vous ne pouvez pas envoyer plus de 10 000 ressources AudienceMember dans une même requête.
consent

Consent

Facultatif. Consentement au niveau de la demande à appliquer à tous les utilisateurs de la demande. Le consentement au niveau de l'utilisateur remplace celui au niveau de la demande et peut être spécifié dans chaque AudienceMember.
validate_only

bool

Facultatif. À des fins de test. Si la valeur est true, la requête est validée, mais pas exécutée. Seules les erreurs sont renvoyées, et non les résultats.
encoding

Encoding

Facultatif. Obligatoire pour les importations UserData. Type d'encodage des identifiants utilisateur. Pour les identifiants utilisateur hachés, il s'agit du type d'encodage de la chaîne hachée. Pour les identifiants utilisateur hachés chiffrés, il s'agit du type d'encodage de la chaîne chiffrée externe, mais pas nécessairement de la chaîne hachée interne. Cela signifie que la chaîne hachée interne peut être encodée différemment de la chaîne chiffrée externe. Pour les importations autres que UserData, ce champ est ignoré.
encryption_info

EncryptionInfo

Facultatif. Informations sur le chiffrement des importations UserData. Si elle n'est pas définie, les informations d'identification importées sont considérées comme hachées, mais pas chiffrées. Pour les importations autres que UserData, ce champ est ignoré.
terms_of_service

TermsOfService

Facultatif. Conditions d'utilisation que l'utilisateur a acceptées ou refusées.

IngestAudienceMembersResponse

Réponse de IngestAudienceMembersRequest.

Champs
request_id

string

ID généré automatiquement pour la demande.

IngestEventsRequest

Demande d'importer des membres d'audience vers les destinations fournies. Renvoie un IngestEventsResponse.

Champs
destinations[]

Destination

Obligatoire. Liste des destinations auxquelles envoyer les événements.
events[]

Event

Obligatoire. Liste des événements à envoyer aux destinations spécifiées. Vous pouvez envoyer jusqu'à 2 000 ressources Event dans une même requête.
consent

Consent

Facultatif. Consentement au niveau de la demande à appliquer à tous les utilisateurs de la demande. Le consentement au niveau de l'utilisateur remplace celui au niveau de la demande et peut être spécifié dans chaque Event.
validate_only

bool

Facultatif. À des fins de test. Si la valeur est true, la requête est validée, mais pas exécutée. Seules les erreurs sont renvoyées, et non les résultats.
encoding

Encoding

Facultatif. Obligatoire pour les importations UserData. Type d'encodage des identifiants utilisateur. Pour les identifiants utilisateur hachés, il s'agit du type d'encodage de la chaîne hachée. Pour les identifiants utilisateur hachés chiffrés, il s'agit du type d'encodage de la chaîne chiffrée externe, mais pas nécessairement de la chaîne hachée interne. Cela signifie que la chaîne hachée interne peut être encodée différemment de la chaîne chiffrée externe. Pour les importations autres que UserData, ce champ est ignoré.
encryption_info

EncryptionInfo

Facultatif. Informations sur le chiffrement des importations UserData. Si elle n'est pas définie, les informations d'identification importées sont considérées comme hachées, mais pas chiffrées. Pour les importations autres que UserData, ce champ est ignoré.

IngestEventsResponse

Réponse de IngestEventsRequest.

Champs
request_id

string

ID généré automatiquement pour la demande.

Élément

Représente un article du panier associé à l'événement.

Champs
merchant_product_id

string

Facultatif. ID du produit dans le compte Merchant Center.
quantity

int64

Facultatif. Nombre de cet article associé à l'événement.
unit_price

double

Facultatif. Prix unitaire hors taxes, frais de port et toute remise appliquée aux transactions.

MobileData

ID mobiles pour l'audience. Vous devez indiquer au moins un identifiant mobile.

Champs
mobile_ids[]

string

Obligatoire. Liste des ID d'appareils mobiles (identifiant publicitaire/IDFA). Vous ne pouvez pas fournir plus de 10 mobileIds dans un seul AudienceMember.

PairData

ID PAIR pour l'audience. Vous devez indiquer au moins un ID PAIR.

Champs
pair_ids[]

string

Obligatoire. Données PII fournies par la cleanroom, hachées avec SHA256 et chiffrées avec un chiffrement commutatif EC à l'aide de la clé de l'éditeur pour la liste des utilisateurs PAIR. Vous ne pouvez pas fournir plus de 10 pairIds dans un seul AudienceMember.

Produit

Représente un produit Google spécifique. Permet de localiser des comptes et des destinations.

Enums
PRODUCT_UNSPECIFIED Produit non spécifié. Ce type ne doit jamais être utilisé.
GOOGLE_ADS Google Ads
DISPLAY_VIDEO_PARTNER Partenaire Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Annonceur Display & Video 360.
DATA_PARTNER Partenaire pour les données.

ProductAccount

Représente un compte spécifique.

Champs
product

Product

Obligatoire. Produit auquel appartient le compte. Par exemple, GOOGLE_ADS.
account_id

string

Obligatoire. ID du compte. Par exemple, l'ID de votre compte Google Ads.

RemoveAudienceMembersRequest

Demande de suppression d'utilisateurs d'une audience dans les destinations fournies. Renvoie un objet RemoveAudienceMembersResponse.

Champs
destinations[]

Destination

Obligatoire. Liste des destinations desquelles supprimer les utilisateurs.
audience_members[]

AudienceMember

Obligatoire. Liste des utilisateurs à supprimer.
validate_only

bool

Facultatif. À des fins de test. Si la valeur est true, la requête est validée, mais pas exécutée. Seules les erreurs sont renvoyées, et non les résultats.
encoding

Encoding

Facultatif. Obligatoire pour les importations UserData. Type d'encodage des identifiants utilisateur. Ne s'applique qu'à l'encodage externe des identifiants utilisateur chiffrés. Pour les importations autres que UserData, ce champ est ignoré.
encryption_info

EncryptionInfo

Facultatif. Informations sur le chiffrement des importations UserData. Si elle n'est pas définie, les informations d'identification importées sont considérées comme hachées, mais pas chiffrées. Pour les importations autres que UserData, ce champ est ignoré.

RemoveAudienceMembersResponse

Réponse de RemoveAudienceMembersRequest.

Champs
request_id

string

ID généré automatiquement pour la demande.

TermsOfService

Conditions d'utilisation que l'utilisateur a acceptées ou refusées.

Champs
customer_match_terms_of_service_status

TermsOfServiceStatus

Facultatif. Conditions d'utilisation du ciblage par liste de clients : https://support.google.com/adspolicy/answer/6299717. Vous devez accepter ces conditions pour importer des listes d'utilisateurs pour le ciblage par liste de clients.

TermsOfServiceStatus

Représente la décision de l'appelant d'accepter ou de refuser les conditions d'utilisation.

Enums
TERMS_OF_SERVICE_STATUS_UNSPECIFIED Non spécifié.
ACCEPTED État indiquant que l'appelant a choisi d'accepter les conditions d'utilisation.
REJECTED État indiquant que l'appelant a choisi de refuser les conditions d'utilisation.

UserData

Données permettant d'identifier l'utilisateur. Vous devez indiquer au moins un identifiant.

Champs
user_identifiers[]

UserIdentifier

Obligatoire. Identifiants de l'utilisateur. Il est possible de fournir plusieurs instances du même type de données (par exemple, plusieurs adresses e-mail). Pour augmenter la probabilité d'une correspondance, fournissez autant d'identifiants que possible. Vous ne pouvez pas fournir plus de 10 userIdentifiers dans un seul AudienceMember ou Event.

UserIdentifier

Identifiant unique de l'utilisateur.

Champs
Champ d'union identifier. Vous ne devez en spécifier qu'un seul. identifier ne peut être qu'un des éléments suivants :
email_address

string

Adresse e-mail hachée à l'aide de la fonction de hachage SHA-256 après normalisation.
phone_number

string

Numéro de téléphone haché à l'aide de la fonction de hachage SHA-256 après normalisation (norme E164).
address

AddressInfo

Composants connus de l'adresse d'un utilisateur. Contient un regroupement d'identifiants qui sont mis en correspondance en même temps.

UserProperties

Informations évaluées par l'annonceur sur l'utilisateur au moment de l'événement. Pour en savoir plus, consultez https://support.google.com/google-ads/answer/14007601.

Champs
customer_type

CustomerType

Facultatif. Type de client associé à l'événement.
customer_value_bucket

CustomerValueBucket

Facultatif. Valeur du client évaluée par l'annonceur.