Method: adEvents.ingest

Importe une liste de ressources AdEvent dans Google Analytics.

Cette fonctionnalité n'est disponible que pour les comptes figurant sur une liste d'autorisation.

Requête HTTP

POST https://datamanager.googleapis.com/v1/adEvents: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 
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
Champs
adEvents[]

object (AdEvent)

Obligatoire. Obligatoire (au moins une). Liste des événements d'annonce.
encryptionInfo

object (EncryptionInfo)

Facultatif. Informations sur les clés de chiffrement utilisées pour chiffrer les données. Ce champ doit être fourni lorsque les événements d'annonce contiennent UserData.
validateOnly
(deprecated)

boolean

Facultatif. Si la valeur est "true", la requête est validée, mais pas exécutée.

Corps de la réponse

Si la requête aboutit, le corps de la réponse est vide.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

AdEvent

Événement d'annonce.

Représentation JSON 
{
  "advertiserId": string,
  "eventType": enum (EventType),
  "timestamp": string,
  "eventId": string,
  "userData": {
    object (UserData)
  },
  "deviceInfo": {
    object (DeviceInfo)
  },
  "ipAddress": string,
  "mobileDeviceId": string,
  "campaignId": string,
  "campaignName": string,
  "adGroupId": string,
  "adId": string,
  "adHeight": integer,
  "adWidth": integer,
  "regionCode": string,
  "source": string,
  "medium": string,
  "attributionHint": enum (AttributionHint),
  "viewabilityInfo": {
    object (ViewabilityInfo)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "eventSubtype": enum (EventSubtype),
  "eventSubtypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adType": enum (AdType),
  "adTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adFormat": enum (AdFormat),
  "adFormatString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adPlacement": enum (AdPlacement),
  "adPlacementString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "targetingType": enum (TargetingType),
  "targetingTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "platformType": enum (PlatformType),
  "platformTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "platform": enum (Platform),
  "platformString": string
  // End of mutually exclusive fields.
  "measurementAllowed": boolean
}
Champs
advertiserId

string

Obligatoire. ID de l'annonceur pour l'événement publicitaire.

Il doit correspondre à l'ID envoyé lors de la procédure d'association.
eventType

enum (EventType)

Obligatoire. Le type d'événement.
timestamp

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".
eventId

string

Facultatif. ID créé et géré par l'appelant, qui identifie cet événement de manière unique.

Obligatoire si vous souhaitez dédupliquer les événements publicitaires inclus dans plusieurs requêtes. Dans le cas contraire, ce champ est facultatif.
userData

object (UserData)

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

Il est possible de fournir plusieurs instances du même type de données (par exemple, une adresse e-mail). Plus vous fournissez de données, plus vous avez de chances de trouver une correspondance.
deviceInfo

object (DeviceInfo)

Obligatoire. Informations recueillies sur l'appareil utilisé lors de l'événement publicitaire.
ipAddress

string

Facultatif. Adresse IP utilisée pour la mesure. Cette valeur doit être identique à celle de DeviceInfo.ip_address. Laissez ce champ vide si vous ne souhaitez pas partager l'adresse IP pour les mesures.
mobileDeviceId

string

Facultatif. ID de l'appareil sur lequel l'annonce a été diffusée.
campaignId

string

Obligatoire. ID de la campagne associée.
campaignName

string

Obligatoire. Nom de la campagne associée.
adGroupId

string

Facultatif. ID du groupe d'annonces associé.
adId

string

Facultatif. ID de l'annonce associée dans le groupe.
adHeight

integer

Facultatif. Hauteur de l'annonce en pixels.
adWidth

integer

Facultatif. Largeur de l'annonce en pixels.
regionCode

string

Facultatif. Pays et subdivision ISO 3166-2.
source

string

Obligatoire. Plate-forme source de l'annonce, semblable à la source Google Analytics.
medium

string

Obligatoire. Support de l'annonce, semblable au support Google Analytics.
attributionHint

enum (AttributionHint)

Facultatif. État d'attribution supposé par le partenaire pour cet événement d'annonce.

Il ne s'agit que d'un signal indiquant comment le partenaire a supposé que l'attribution s'était déroulée. Il ne force pas un résultat final dans les rapports.
viewabilityInfo

object (ViewabilityInfo)

Obligatoire. Détails sur la visibilité de l'annonce diffusée.

Facultatif. Classification supplémentaire concernant le type d'événement d'annonce.

Une chaîne brute est acceptée pour gérer les valeurs autres que les énumérations pures. L'enum est préférable si possible. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
eventSubtype

enum (EventSubtype)

Valeur d'énumération du sous-type d'événement.
eventSubtypeString

string

Valeur de chaîne pour le sous-type d'événement.
Fin des champs qui s'excluent mutuellement.

Facultatif. Type d'annonce diffusée.

Une chaîne brute est acceptée pour gérer les valeurs autres que les énumérations pures. L'enum est préférable si possible. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
adType

enum (AdType)

Valeur d'énumération pour le type d'annonce.
adTypeString

string

Valeur de chaîne pour le type d'annonce.
Fin des champs qui s'excluent mutuellement.

Facultatif. Type d'annonce diffusée.

Une chaîne brute est acceptée pour gérer les valeurs autres que les énumérations pures. L'enum est préférable si possible. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
adFormat

enum (AdFormat)

Valeur d'énumération pour le format d'annonce.
adFormatString

string

Valeur de chaîne pour le format d'annonce.
Fin des champs qui s'excluent mutuellement.

Facultatif. Emplacement de l'annonce diffusée.

Une chaîne brute est acceptée pour gérer les valeurs autres que les énumérations pures. L'enum est préférable si possible. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
adPlacement

enum (AdPlacement)

Valeur d'énumération pour l'emplacement de l'annonce.
adPlacementString

string

Valeur de chaîne pour l'emplacement de l'annonce.
Fin des champs qui s'excluent mutuellement.

Facultatif. Type de ciblage utilisé pour diffuser l'annonce.

Une chaîne brute est acceptée pour gérer les valeurs autres que les énumérations pures. L'enum est préférable si possible. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
targetingType

enum (TargetingType)

Valeur d'énumération pour le type de ciblage.
targetingTypeString

string

Valeur de chaîne pour le type de ciblage.
Fin des champs qui s'excluent mutuellement.

Facultatif. Type de plate-forme sur laquelle l'annonce a été diffusée.

Une chaîne brute est acceptée pour gérer les valeurs autres que les énumérations pures. L'enum est préférable si possible. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
platformType

enum (PlatformType)

Valeur d'énumération pour le type de plate-forme.
platformTypeString

string

Valeur de chaîne pour le type de plate-forme.
Fin des champs qui s'excluent mutuellement.

Facultatif. Informations plus détaillées sur la plate-forme sur laquelle l'annonce a été diffusée.

Une chaîne brute est acceptée pour gérer les valeurs autres que les énumérations pures. L'enum est préférable si possible. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
platform

enum (Platform)

Valeur d'énumération pour la plate-forme.
platformString

string

Valeur de chaîne pour la plate-forme.
Fin des champs qui s'excluent mutuellement.
measurementAllowed

boolean

Facultatif. Indique si la ligne peut être utilisée à des fins de mesure, conformément aux lois applicables sur la confidentialité dans la juridiction régionale.

EventType

Le type d'événement.

Enums
EVENT_TYPE_UNSPECIFIED Type d'événement non spécifié.
EVENT_TYPE_VIEW Afficher un événement.
EVENT_TYPE_CLICK Événement de clic

EventSubtype

Classification supplémentaire concernant le type d'événement d'annonce.

Enums
EVENT_SUBTYPE_UNSPECIFIED Sous-type d'événement non spécifié.
EVENT_SUBTYPE_IMPRESSION Événement d'impression.
EVENT_SUBTYPE_ENGAGED_VIEW Événement Vue engagée.
EVENT_SUBTYPE_ONSITE_CLICK Événement de clic sur le site.
EVENT_SUBTYPE_OUTBOUND_CLICK Événement de clic sortant.

AdType

Type d'annonce diffusée.

Enums
AD_TYPE_UNSPECIFIED Type d'annonce non spécifié.
AD_TYPE_DISPLAY Annonce display.
AD_TYPE_TEXT Annonce textuelle.
AD_TYPE_IMAGE Les annonces illustrées
AD_TYPE_RICH_MEDIA Annonce rich media.
AD_TYPE_HTML Annonce HTML.
AD_TYPE_AUDIO Annonce audio.
AD_TYPE_VIDEO Les annonces vidéo

AdFormat

Format de l'annonce diffusée.

Enums
AD_FORMAT_UNSPECIFIED Format d'annonce non spécifié.
AD_FORMAT_AR Annonce RA.
AD_FORMAT_AUDIO Annonce audio.
AD_FORMAT_BANNER Bannière publicitaire.
AD_FORMAT_BUMPER Annonce bumper.
AD_FORMAT_COLLECTION Annonce pour une collection.
AD_FORMAT_IMAGE Les annonces illustrées
AD_FORMAT_INTERACTIVE Annonce interactive.
AD_FORMAT_INTERSTITIAL Annonce interstitielle.
AD_FORMAT_IN_FEED Annonce In-Feed.
AD_FORMAT_IN_STREAM Annonce InStream.
AD_FORMAT_IN_STREAM_SKIPPABLE Annonce InStream désactivable.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE Annonce InStream non désactivable.
AD_FORMAT_NATIVE Annonce native.
AD_FORMAT_SHORTS Annonce Shorts
AD_FORMAT_STORY Annonce Story.
AD_FORMAT_SPONSORED Annonce sponsorisée.
AD_FORMAT_VIDEO Les annonces vidéo

AdPlacement

Emplacement de l'annonce diffusée.

Enums
AD_PLACEMENT_UNSPECIFIED Emplacement d'annonce non spécifié.
AD_PLACEMENT_DISCOVER Découvrez l'emplacement.
AD_PLACEMENT_FEED Emplacement du flux.
AD_PLACEMENT_HEADER Emplacement de l'en-tête.
AD_PLACEMENT_HOME Emplacement sur la page d'accueil.
AD_PLACEMENT_IN_CONTENT Emplacement intégré au contenu.
AD_PLACEMENT_PROMOTED Emplacement sponsorisé.
AD_PLACEMENT_STORY Emplacement de l'article.

TargetingType

Type de ciblage utilisé pour diffuser l'annonce.

Enums
TARGETING_TYPE_UNSPECIFIED Type de ciblage non spécifié.
TARGETING_TYPE_AUDIENCE Ciblage d'audience.
TARGETING_TYPE_CONTEXTUAL Ciblage contextuel.
TARGETING_TYPE_DEMOGRAPHIC Ciblage démographique
TARGETING_TYPE_DEVICE Ciblage par types d'appareil
TARGETING_TYPE_GEO Ciblage géographique.
TARGETING_TYPE_INTEREST Ciblage par centres d'intérêt.
TARGETING_TYPE_PURCHASE_INTENT Ciblage par intention d'achat.
TARGETING_TYPE_REMARKETING Ciblage par remarketing.

PlatformType

Type de plate-forme sur laquelle l'annonce a été diffusée.

Enums
PLATFORM_TYPE_UNSPECIFIED Type de plate-forme non spécifié.
PLATFORM_TYPE_MOBILE Plate-forme mobile.
PLATFORM_TYPE_DESKTOP Plate-forme pour ordinateur
PLATFORM_TYPE_CTV Plate-forme CTV.
PLATFORM_TYPE_PHONE Plate-forme téléphonique.
PLATFORM_TYPE_TABLET Plate-forme pour tablette.

Plate-forme

Informations plus détaillées sur la plate-forme sur laquelle l'annonce a été diffusée.

Enums
PLATFORM_UNSPECIFIED Plate-forme non spécifiée.
PLATFORM_IOS Plate-forme iOS.
PLATFORM_ANDROID Plate-forme Android.
PLATFORM_WEB Plate-forme Web.

AttributionHint

État d'attribution supposé par le partenaire pour cet événement d'annonce.

Enums
ATTRIBUTION_HINT_UNSPECIFIED État d'attribution inconnu.
ATTRIBUTION_HINT_CONVERTED État "Converti".
ATTRIBUTION_HINT_NOT_CONVERTED État "Non converti".

ViewabilityInfo

Détails sur la visibilité de l'annonce diffusée.

Représentation JSON 
{
  "viewType": enum (ViewType),
  "viewablePercent": integer,
  "viewableDuration": string,
  "mediaSkippable": boolean,
  "mediaQuartile": enum (MediaQuartile),
  "mediaDuration": string,
  "mediaVolumePercent": integer,
  "playbackDuration": string
}
Champs
viewType

enum (ViewType)

Obligatoire. Le type d'événement.
viewablePercent

integer

Facultatif. Pourcentage numérique (0 à 100) des pixels visibles.
viewableDuration

string (Duration format)

Facultatif. Durée pendant laquelle l'annonce était visible.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
mediaSkippable

boolean

Facultatif. Indique si le média publicitaire était désactivable ou non.
mediaQuartile

enum (MediaQuartile)

Facultatif. Quantité de contenu multimédia lu, exprimée en quarts discrets.
mediaDuration

string (Duration format)

Facultatif. Durée du média publicitaire.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
mediaVolumePercent

integer

Facultatif. Pourcentage numérique (0 à 100) du volume de lecture du contenu multimédia.
playbackDuration

string (Duration format)

Facultatif. Durée de lecture du média publicitaire, qu'il ait été visible ou non.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

ViewType

Le type d'événement.

Enums
VIEW_TYPE_UNSPECIFIED Type de vue non spécifié.
VIEW_TYPE_MRC_VIEWED MRC vu
VIEW_TYPE_MRC_RENDERED MRC rendered.

MediaQuartile

Quantité de contenu multimédia lu, exprimée en quarts discrets.

Enums
MEDIA_QUARTILE_UNSPECIFIED Quartile média non spécifié.
MEDIA_QUARTILE_START Démarrer.
MEDIA_QUARTILE_FIRST_QUARTILE Premier quart.
MEDIA_QUARTILE_MIDPOINT Point médian.
MEDIA_QUARTILE_THIRD_QUARTILE Troisième quart.
MEDIA_QUARTILE_COMPLETE Terminé.