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 ne pouvez envoyer que 2 000 ressources Event dans une même requête.
consent

object (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.
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, et non les résultats.
encoding

enum (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é.
encryptionInfo

object (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é.

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
}
Champs
requestId

string

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

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,
  "conversionValue": 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 balises.
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. Date de la 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. Informations indiquant si l'utilisateur associé a donné différents types de consentement.
adIdentifiers

object (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.
eventSource

enum (EventSource)

Facultatif. Signal indiquant où l'événement s'est produit (sur le Web, dans une 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 pourront éventuellement être promus pour faire partie de l'API.
userProperties

object (UserProperties)

Facultatif. Informations évaluées par l'annonceur sur l'utilisateur au moment de l'événement.
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. Il s'agit du même type de données que celles fournies dans userData, mais elles sont explicitement signalées comme appartenant à un tiers et non comme des données d'annonceur first party.
eventLocation

object (EventLocation)

Facultatif. Informations recueillies sur la position de l'utilisateur lorsque cet événement s'est produit.
appInstanceId

string

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

number

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

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

Représentation JSON 
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": 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'accès au site de l'annonceur après l'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 d'autres plates-formes.

DeviceInfo

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

Représentation JSON 
{
  "userAgent": string,
  "ipAddress": string,
  "category": string,
  "languageCode": string,
  "screenHeight": integer,
  "screenWidth": integer,
  "operatingSystem": string,
  "operatingSystemVersion": string,
  "model": string,
  "brand": string,
  "browser": string,
  "browserVersion": string
}
Champs
userAgent

string

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

string

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

Remarque : Google Ads n'accepte pas la mise en correspondance des adresses IP pour les utilisateurs finaux situés dans l'Espace économique européen (EEE), au Royaume-Uni (UK) ou en Suisse (CH). Ajoutez une logique pour exclure conditionnellement le partage des adresses IP des utilisateurs de ces régions. Par ailleurs, assurez-vous de fournir aux utilisateurs des informations claires et complètes concernant 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.
category

string

Facultatif. Catégorie de l'appareil. Par exemple, "ordinateur", "tablette", "mobile" ou "Smart TV".
languageCode

string

Facultatif. Langue utilisée par l'appareil au format ISO 639-1.
screenHeight

integer

Facultatif. Hauteur de l'écran en pixels.
screenWidth

integer

Facultatif. Largeur de l'écran en pixels.
operatingSystem

string

Facultatif. Système d'exploitation ou plate-forme de l'appareil.
operatingSystemVersion

string

Facultatif. Version du système d'exploitation ou de la plate-forme.
model

string

Facultatif. Modèle de l'appareil.
brand

string

Facultatif. Marque de l'appareil.
browser

string

Facultatif. Marque ou type du navigateur.
browserVersion

string

Facultatif. Version du navigateur.

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 de bon de réduction au niveau du panier et de l'article sont indépendants.

Si l'événement concerne 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 de cet article associé à l'événement.
unitPrice

number

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

string

Facultatif. Identifiant unique permettant de faire référence à l'élément.
additionalItemParameters[]

object (ItemParameter)

Facultatif. Un bucket de paramètres d'événement liés à un élément à 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 remplacera 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. Pour les événements de ventes en magasin, cette valeur remplacera 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, dans les cas où la valeur de conversion est différente pour chaque article.

ItemParameter

Un bucket de paramètres d'événement liés à un élément à 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 indiqué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 est vide, le Event.destination_references sera utilisé.

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 indiqué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 est vide, le Event.destination_references sera utilisé.

ExperimentalField

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

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

string

Facultatif. Nom du champ à utiliser.
value

string

Facultatif. Valeur à définir pour le champ.

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.

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 évaluée par l'annonceur.
additionalUserProperties[]

object (UserProperty)

Facultatif. Ensemble de 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 de nouveau interagi avec l'annonceur.

CustomerValueBucket

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

Enums
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Unspecified CustomerValueBucket. 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.

UserProperty

Ensemble de 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 le 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 CLDR à deux lettres de la région 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.