Method: events.ingest

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

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

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

object (Destination)

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

object (Event)

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

object (Consent)

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

boolean

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, pas les résultats.
encoding

enum (Encoding)

Facultatif. Doit être fourni 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 d'une manière différente de la chaîne chiffrée externe. Pour les importations autres que UserData, ce champ est ignoré.
encryptionInfo

object (EncryptionInfo)

Facultatif. Informations de chiffrement pour les importations UserData. Si ce paramètre n'est pas défini, les informations permettant d'identifier l'utilisateur importées sont considérées comme hachées, mais pas chiffrées. Pour les importations autres que UserData, ce champ est ignoré.

Corps de la réponse

Réponse de IngestEventsRequest.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "requestId": string,
  "fieldWarnings": [
    {
      object (FieldWarning)
    }
  ]
}
Champs
requestId

string

ID de la requête généré automatiquement.
fieldWarnings[]

object (FieldWarning)

Avertissements détaillés au niveau des lignes avec les chemins d'accès aux champs.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Événement

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

Représentation 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
}
Champs
destinationReferences[]

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.
transactionId

string

Facultatif. Identifiant unique de cet événement. Obligatoire pour les événements envoyés en tant que source de données supplémentaire pour les conversions de balise.
eventTimestamp

string (Timestamp format)

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

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
lastUpdatedTimestamp

string (Timestamp format)

Facultatif. Dernière mise à jour de l'événement.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
userData

object (UserData)

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

object (Consent)

Facultatif. Indique si l'utilisateur associé a fourni différents types de consentement.
adIdentifiers

object (AdIdentifiers)

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

string

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

enum (EventSource)

Facultatif. Signal indiquant où l'événement s'est produit (Web, application, en magasin, etc.).
eventDeviceInfo

object (DeviceInfo)

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

object (CartData)

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

object (CustomVariable)

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

object (ExperimentalField)

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

object (UserProperties)

Facultatif. Informations sur l'utilisateur évaluées par l'annonceur au moment où l'événement s'est produit.
eventName

string

Facultatif. Nom de l'événement. Obligatoire pour les événements GA4.
clientId

string

Facultatif. Identifiant unique de l'instance utilisateur d'un client Web pour ce flux Web GA4.
userId

string

Facultatif. Identifiant unique d'un utilisateur, tel que défini par l'annonceur.
additionalEventParameters[]

object (EventParameter)

Facultatif. Un bucket de paramètres d'événement à inclure dans l'événement qui n'ont pas déjà été spécifiés à l'aide d'autres champs structurés.
thirdPartyUserData

object (UserData)

Facultatif. Même type de données que celles fournies dans userData, mais explicitement signalées comme appartenant à un tiers et non comme des données first party de l'annonceur.
eventLocation

object (EventLocation)

Facultatif. Informations recueillies sur la position de l'utilisateur au moment de l'événement.
appInstanceId

string

Facultatif. Identifiant unique de l'instance utilisateur d'un client d'application pour ce flux d'application GA4.
callInfo

object (CallInfo)

Facultatif. Informations recueillies sur l'appel (le cas échéant) qui a conduit à cet événement.
conversionValue

number

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

number

Facultatif. Quantité de conversions associée à l'événement, pour les conversions basées sur le comptage.

AdIdentifiers

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

Représentation 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
}
Champs
sessionAttributes

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).
landingPageDeviceInfo

object (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 une interaction avec l'annonce.
mobileDeviceId

string

Facultatif. Identifiant mobile pour les annonceurs. Il s'agit de l'IDFA sur iOS, de l'identifiant publicitaire sur Android ou des identifiants pour les annonceurs sur d'autres plates-formes.
dclid

string

Facultatif. ID de clic display associé à cet événement.
impressionId

string

Facultatif. ID d'impression associé à cet événement.
matchId

string

Facultatif. Champ d'identifiant de mise en correspondance utilisé pour joindre cet événement à un événement précédent.
encryptedUserIds[]

object (EncryptedUserId)

Facultatif. Un nombre quelconque d'ID utilisateur chiffrés.
ppid

string

Facultatif. Identifiant unique d'un utilisateur authentifié (connecté), tel que défini par l'éditeur.
visitorPpid

string

Facultatif. Identifiant unique d'un utilisateur non authentifié (utilisateur qui n'est pas connecté), tel que défini par l'éditeur.
leadId

string

Facultatif. ID généré par Google lorsqu'un utilisateur envoie un formulaire de lead.

EncryptedUserId

Identifiant utilisateur émis pour être utilisé pour l'attribution. Tous les champs sont obligatoires si vous utilisez cette option.

Représentation JSON 
{
  "encryptedId": string,
  "entityType": enum (EncryptionEntityType),
  "entityId": string,
  "source": enum (EncryptionSource)
}
Champs
encryptedId

string

Obligatoire. ID alphanumérique chiffré.
entityType

enum (EncryptionEntityType)

Obligatoire. Type d'entité de chiffrement. Elle doit correspondre à la configuration de chiffrement pour la diffusion d'annonces ou le transfert de données.
entityId

string (int64 format)

Obligatoire. ID de l'entité de chiffrement. Elle doit correspondre à la configuration de chiffrement pour la diffusion d'annonces ou le transfert de données.
source

enum (EncryptionSource)

Obligatoire. Indique si le cookie chiffré a été reçu de la diffusion d'annonces (macro %m) ou du transfert de données.

EncryptionEntityType

Type d'entité de chiffrement.

Enums
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED Type d'entité de chiffrement non spécifié.
CAMPAIGN_MANAGER_ACCOUNT Compte Campaign Manager 360.
CAMPAIGN_MANAGER_ADVERTISER annonceur Campaign Manager 360.
DISPLAY_VIDEO_PARTNER Partenaire Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Annonceur Display & Video 360.
GOOGLE_ADS_CUSTOMER Client Google Ads.
GOOGLE_AD_MANAGER_NETWORK_CODE Code de réseau Google Ad Manager.

EncryptionSource

La source de chiffrement.

Enums
ENCRYPTION_SOURCE_UNSPECIFIED Source de chiffrement non spécifiée.
AD_SERVING Source de chiffrement de la diffusion d'annonces.
DATA_TRANSFER Source de chiffrement du transfert de données.

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.
MESSAGE L'événement a été généré à partir d'un message.
OTHER L'événement a été généré à partir d'autres sources.

CartData

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

Représentation JSON 
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ],
  "couponCodes": [
    string
  ]
}
Champs
merchantId

string

Facultatif. ID Merchant Center associé aux articles.
merchantFeedLabel

string

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

string

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

number

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

object (Item)

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

string

Facultatif. Liste des codes promotionnels appliqués au panier. Les codes promotionnels au niveau du panier et de l'article sont indépendants.

Si l'événement est destiné à une destination Google Analytics, ne fournissez qu'un seul code promotionnel. Google Analytics ignore les codes promotionnels supplémentaires.

Élément

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

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

string

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

string (int64 format)

Facultatif. Nombre d'articles associés à l'événement.
unitPrice

number

Facultatif. Prix unitaire hors taxes, frais de livraison et éventuelles remises au niveau des transactions.
itemId

string

Facultatif. Identifiant unique permettant de référencer l'élément.
additionalItemParameters[]

object (ItemParameter)

Facultatif. Un bucket de tous les paramètres d'événement liés à un article à inclure dans l'événement qui n'ont pas déjà été spécifiés à l'aide d'autres champs structurés.
merchantId

string

Facultatif. ID Merchant Center associé à l'article. Pour les événements de ventes en magasin, cette valeur remplace celle définie au niveau du panier. Ce champ est ignoré pour les autres événements.
merchantFeedLabel

string

Facultatif. Libellé du flux Merchant Center. Si des pays sont toujours utilisés, vous pouvez utiliser le code pays à deux lettres au format ISO-3166-1 alpha-2 à la place. Pour les événements de ventes en magasin, cette valeur remplace celle définie au niveau du panier. Ce champ est ignoré pour les autres événements.
merchantFeedLanguageCode

string

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

object (ItemCustomVariable)

Facultatif. Informations supplémentaires sur les paires clé/valeur à envoyer aux conteneurs de conversion (action de conversion ou activité Floodlight) lors du suivi des conversions par article.
conversionValue

number

Facultatif. Valeur de conversion associée à cet article dans l'événement, lorsque la valeur de conversion est différente pour chaque article.

ItemParameter

Un bucket de tous les paramètres d'événement liés à un article à inclure dans l'événement qui n'ont pas déjà été spécifiés à l'aide d'autres champs structurés.

Représentation JSON 
{
  "parameterName": string,
  "value": string
}
Champs
parameterName

string

Obligatoire. Nom du paramètre à utiliser.
value

string

Obligatoire. Représentation sous forme de chaîne de la valeur du paramètre à définir.

ItemCustomVariable

Variable personnalisée au niveau de l'article pour les conversions d'annonces.

Représentation JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Champs
variable

string

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

string

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

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 n'est pas renseigné, la valeur Event.destination_references sera utilisée.

Variable personnalisée

Variable personnalisée pour les conversions d'annonces.

Représentation JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Champs
variable

string

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

string

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

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 n'est pas renseigné, la valeur Event.destination_references sera utilisée.

ExperimentalField

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

Représentation JSON 
{
  "field": string,
  "value": string
}
Champs
field

string

Facultatif. Nom du champ à utiliser.
value

string

Facultatif. Valeur du champ à définir.

UserProperties

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

Représentation JSON 
{
  "customerType": enum (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket),
  "additionalUserProperties": [
    {
      object (UserProperty)
    }
  ]
}
Champs
customerType

enum (CustomerType)

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

enum (CustomerValueBucket)

Facultatif. Valeur du client, telle qu'évaluée par l'annonceur.
additionalUserProperties[]

object (UserProperty)

Facultatif. Un bucket de toutes les propriétés utilisateur supplémentaires pour l'utilisateur associé à cet événement.

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 réengagé le contact avec l'annonceur.

CustomerValueBucket

Valeur du client, telle qu'évaluée par l'annonceur.

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

UserProperty

Un bucket de toutes les propriétés utilisateur supplémentaires pour l'utilisateur associé à cet événement.

Représentation JSON 
{
  "propertyName": string,
  "value": string
}
Champs
propertyName

string

Obligatoire. Nom de la propriété utilisateur à utiliser.
value

string

Obligatoire. Représentation sous forme de chaîne de la valeur de la propriété utilisateur à utiliser.

EventParameter

Paramètre d'événement pour les événements GA4.

Représentation JSON 
{
  "parameterName": string,
  "value": string
}
Champs
parameterName

string

Obligatoire. Nom du paramètre à utiliser.
value

string

Obligatoire. Représentation sous forme de chaîne de la valeur du paramètre à définir.

EventLocation

Lieu où l'événement s'est produit.

Représentation JSON 
{
  "storeId": string,
  "city": string,
  "subdivisionCode": string,
  "regionCode": string,
  "subcontinentCode": string,
  "continentCode": string
}
Champs
storeId

string

Facultatif. Obligatoire pour les ventes en magasin. Identifiant représentant un magasin physique où l'événement s'est produit.
city

string

Facultatif. Nom de la ville où l'événement s'est produit.
subdivisionCode

string

Facultatif. Code de subdivision ISO 3166-2 où l'événement s'est produit.
regionCode

string

Facultatif. Code de région CLDR à deux lettres de l'adresse de l'utilisateur.
subcontinentCode

string

Facultatif. Code du sous-continent au format UN M49 où l'événement s'est produit.
continentCode

string

Facultatif. Code du continent au format UN M49 où l'événement s'est produit.

CallInfo

Informations recueillies sur l'appel (le cas échéant) qui a conduit à cet événement.

Représentation JSON 
{
  "startTimestamp": string
}
Champs
startTimestamp

string (Timestamp format)

Obligatoire. Heure à laquelle l'appel téléphonique à l'origine de cet événement a commencé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".