Method: adEvents.ingest

Lädt eine Liste von AdEvent-Ressourcen in Google Analytics hoch.

Diese Funktion ist nur für Konten auf einer Zulassungsliste verfügbar.

Autorisierungsheader:

Für diese Methode ist auch der folgende Header erforderlich, um festzulegen, wie der Zugriff für die Anfrage durch die API autorisiert wird:

  • login-account: (Erforderlich) Der Ressourcenname des Data Partner-Kontos, in dem das Google-Konto der Anmeldedaten ein Nutzer ist. Format: accountTypes/DATA_PARTNER/accounts/{loginAccountId}

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
Felder
adEvents[]

object (AdEvent)

Erforderlich. Erforderlich (mindestens 1). Eine Liste von Werbeereignissen.
encryptionInfo

object (EncryptionInfo)

Optional. Informationen zu Verschlüsselungsschlüsseln, die zum Verschlüsseln der Daten verwendet werden. Dieses Feld muss angegeben werden, wenn Anzeigenereignisse UserData enthalten.
validateOnly
(deprecated)

boolean

Optional. Wenn „true“, wird die Anfrage validiert, aber nicht ausgeführt.

Antworttext

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

AdEvent

Ein Anzeigenereignis.

JSON-Darstellung 
{
  "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
}
Felder
advertiserId

string

Erforderlich. Die ID des Werbetreibenden für das Anzeigenereignis.

Sie muss mit der ID übereinstimmen, die im Verknüpfungsprozess gesendet wurde.
eventType

enum (EventType)

Erforderlich. Der Typ des Ereignisses.
timestamp

string (Timestamp format)

Erforderlich. Zeit, zu der das Ereignis aufgetreten ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
eventId

string

Optional. Eine ID, die vom Anrufer erstellt und verwaltet wird und dieses Ereignis eindeutig identifiziert.

Erforderlich, wenn Sie Anzeigenereignisse deduplizieren möchten, die in mehreren Anfragen enthalten sind. Andernfalls ist dieses Feld optional.
userData

object (UserData)

Optional. Mehrere von Nutzern bereitgestellte Daten, die den Nutzer darstellen, mit dem das Ereignis verknüpft ist.

Es ist möglich, mehrere Instanzen desselben Datentyps anzugeben, z.B. E-Mail-Adressen. Je mehr Daten angegeben werden, desto wahrscheinlicher ist eine Übereinstimmung.
deviceInfo

object (DeviceInfo)

Erforderlich. Informationen zum Gerät, das zum Zeitpunkt des Anzeigenereignisses verwendet wurde.
ipAddress

string

Optional. Die für die Analyse verwendete IP-Adresse. Dieser Wert muss mit DeviceInfo.ip_address übereinstimmen. Lassen Sie das Feld leer, wenn Sie die IP-Adresse nicht für die Analyse freigeben möchten.
mobileDeviceId

string

Optional. Die Geräte-ID des Geräts, auf dem die Anzeige ausgeliefert wurde.
campaignId

string

Erforderlich. Die ID der zugehörigen Kampagne.
campaignName

string

Erforderlich. Der Name der zugehörigen Kampagne.
adGroupId

string

Optional. Die ID der zugehörigen Anzeigengruppe.
adId

string

Optional. Die ID der zugehörigen Anzeige in der Gruppe.
adHeight

integer

Optional. Die Höhe der Anzeige in Pixeln.
adWidth

integer

Optional. Die Breite der Anzeige in Pixeln.
regionCode

string

Optional. Das Land und die Unterteilung gemäß ISO 3166-2.
source

string

Erforderlich. Die Plattformquelle der Anzeige, ähnlich der Google Analytics-Quelle.
medium

string

Erforderlich. Das Medium der Anzeige, ähnlich dem Google Analytics-Medium.
attributionHint

enum (AttributionHint)

Optional. Der vom Partner angenommene Attributionsstatus für dieses Anzeigenereignis.

Dies dient nur als Signal dafür, wie die Attribution des Partners angenommen wurde, und erzwingt kein Endergebnis in endgültigen Berichten.
viewabilityInfo

object (ViewabilityInfo)

Erforderlich. Details zur Sichtbarkeit der ausgelieferten Anzeige.

Optional. Zusätzliche Klassifizierung des Anzeigenereignistyps.

Es wird ein Rohstring akzeptiert, um andere Werte als die reinen Enumerationen zu verarbeiten. Die Enumeration wird nach Möglichkeit bevorzugt. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
eventSubtype

enum (EventSubtype)

Enum-Wert für den Ereignisuntertyp.
eventSubtypeString

string

Stringwert für den Ereignisuntertyp.
Ende der sich gegenseitig ausschließenden Felder.

Optional. Der Typ der ausgelieferten Anzeige.

Es wird ein Rohstring akzeptiert, um andere Werte als die reinen Enumerationen zu verarbeiten. Die Enumeration wird nach Möglichkeit bevorzugt. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
adType

enum (AdType)

Enum-Wert für den Anzeigentyp.
adTypeString

string

String-Wert für den Anzeigentyp.
Ende der sich gegenseitig ausschließenden Felder.

Optional. Der Typ der ausgelieferten Anzeige.

Es wird ein Rohstring akzeptiert, um andere Werte als die reinen Enumerationen zu verarbeiten. Die Enumeration wird nach Möglichkeit bevorzugt. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
adFormat

enum (AdFormat)

Enum-Wert für das Anzeigenformat.
adFormatString

string

Stringwert für das Anzeigenformat.
Ende der sich gegenseitig ausschließenden Felder.

Optional. Das Placement der ausgelieferten Anzeige.

Es wird ein Rohstring akzeptiert, um andere Werte als die reinen Enumerationen zu verarbeiten. Die Enumeration wird nach Möglichkeit bevorzugt. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
adPlacement

enum (AdPlacement)

Enum-Wert für die Anzeigenplatzierung.
adPlacementString

string

String-Wert für die Anzeigenplatzierung.
Ende der sich gegenseitig ausschließenden Felder.

Optional. Der Targeting-Typ, der für die Auslieferung der Anzeige verwendet wurde.

Es wird ein Rohstring akzeptiert, um andere Werte als die reinen Enumerationen zu verarbeiten. Die Enumeration wird nach Möglichkeit bevorzugt. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
targetingType

enum (TargetingType)

Enum-Wert für den Targeting-Typ.
targetingTypeString

string

String-Wert für den Targeting-Typ.
Ende der sich gegenseitig ausschließenden Felder.

Optional. Der Typ der Plattform, auf der die Anzeige ausgeliefert wurde.

Es wird ein Rohstring akzeptiert, um andere Werte als die reinen Enumerationen zu verarbeiten. Die Enumeration wird nach Möglichkeit bevorzugt. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
platformType

enum (PlatformType)

Enum-Wert für den Plattformtyp.
platformTypeString

string

String-Wert für den Plattformtyp.
Ende der sich gegenseitig ausschließenden Felder.

Optional. Weitere Details zur Plattform, auf der die Anzeige ausgeliefert wurde.

Es wird ein Rohstring akzeptiert, um andere Werte als die reinen Enumerationen zu verarbeiten. Die Enumeration wird nach Möglichkeit bevorzugt. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
platform

enum (Platform)

Enum-Wert für die Plattform.
platformString

string

Stringwert für die Plattform.
Ende der sich gegenseitig ausschließenden Felder.
measurementAllowed

boolean

Optional. Gibt an, ob die Zeile gemäß den anwendbaren Datenschutzgesetzen in der regionalen Gerichtsbarkeit für Analysezwecke verwendet werden darf.

EventType

Der Typ des Ereignisses.

Enums
EVENT_TYPE_UNSPECIFIED Nicht angegebener Ereignistyp.
EVENT_TYPE_VIEW Termin ansehen
EVENT_TYPE_CLICK Click-Event.

EventSubtype

Zusätzliche Klassifizierung des Anzeigenereignistyps.

Enums
EVENT_SUBTYPE_UNSPECIFIED Nicht angegebener Ereignisuntertyp.
EVENT_SUBTYPE_IMPRESSION Impressionsereignis.
EVENT_SUBTYPE_ENGAGED_VIEW Ereignis nach aktiver Wiedergabe.
EVENT_SUBTYPE_ONSITE_CLICK Onsite-Click-Event.
EVENT_SUBTYPE_OUTBOUND_CLICK Ereignis für Klicks auf externe Links.

AdType

Der Typ der ausgelieferten Anzeige.

Enums
AD_TYPE_UNSPECIFIED Nicht angegebener Anzeigentyp
AD_TYPE_DISPLAY Displayanzeige
AD_TYPE_TEXT Textanzeige aus.
AD_TYPE_IMAGE Bildanzeige
AD_TYPE_RICH_MEDIA Rich Media-Anzeige
AD_TYPE_HTML HTML-Anzeige
AD_TYPE_AUDIO Audioanzeige
AD_TYPE_VIDEO Videoanzeige

AdFormat

Das Format der ausgelieferten Anzeige.

Enums
AD_FORMAT_UNSPECIFIED Anzeigenformat nicht angegeben.
AD_FORMAT_AR AR-Anzeige
AD_FORMAT_AUDIO Audioanzeige
AD_FORMAT_BANNER Banneranzeige.
AD_FORMAT_BUMPER Bumper-Anzeige
AD_FORMAT_COLLECTION Anzeige aus Sammlung
AD_FORMAT_IMAGE Bildanzeige
AD_FORMAT_INTERACTIVE Interaktive Anzeige.
AD_FORMAT_INTERSTITIAL Interstitial-Anzeige
AD_FORMAT_IN_FEED In-Feed-Anzeige
AD_FORMAT_IN_STREAM In-Stream-Anzeige
AD_FORMAT_IN_STREAM_SKIPPABLE Überspringbare In-Stream-Anzeige
AD_FORMAT_IN_STREAM_NON_SKIPPABLE Nicht überspringbare In-Stream-Anzeige
AD_FORMAT_NATIVE Native Anzeige
AD_FORMAT_SHORTS YouTube Shorts-Anzeige.
AD_FORMAT_STORY Story-Anzeige
AD_FORMAT_SPONSORED Gesponserte Anzeige
AD_FORMAT_VIDEO Videoanzeige

AdPlacement

Das Placement der ausgelieferten Anzeige.

Enums
AD_PLACEMENT_UNSPECIFIED Nicht angegebenes Anzeigen-Placement.
AD_PLACEMENT_DISCOVER Placement ermitteln
AD_PLACEMENT_FEED Feed-Placement.
AD_PLACEMENT_HEADER Platzierung des Headers.
AD_PLACEMENT_HOME Platzierung auf der Startseite.
AD_PLACEMENT_IN_CONTENT Placement im Content
AD_PLACEMENT_PROMOTED Gesponserte Platzierung.
AD_PLACEMENT_STORY Platzierung von Stories.

TargetingType

Der Targeting-Typ, der für die Auslieferung der Anzeige verwendet wurde.

Enums
TARGETING_TYPE_UNSPECIFIED Nicht angegebener Ausrichtungstyp
TARGETING_TYPE_AUDIENCE Zielgruppen-Targeting
TARGETING_TYPE_CONTEXTUAL Kontext-Targeting
TARGETING_TYPE_DEMOGRAPHIC Demografisches Targeting.
TARGETING_TYPE_DEVICE Geräte-Targeting:
TARGETING_TYPE_GEO Geografisches Targeting
TARGETING_TYPE_INTEREST Ausrichtung auf Interessengebiete.
TARGETING_TYPE_PURCHASE_INTENT Targeting auf Kaufabsicht
TARGETING_TYPE_REMARKETING Remarketing-Targeting

PlatformType

Der Typ der Plattform, auf der die Anzeige ausgeliefert wurde.

Enums
PLATFORM_TYPE_UNSPECIFIED Nicht angegebener Plattformtyp
PLATFORM_TYPE_MOBILE Mobile Plattform
PLATFORM_TYPE_DESKTOP Desktop-Plattform
PLATFORM_TYPE_CTV CTV-Plattform
PLATFORM_TYPE_PHONE Smartphone-Plattform
PLATFORM_TYPE_TABLET Tablet-Plattform

Plattform

Weitere Details zur Plattform, auf der die Anzeige ausgeliefert wurde.

Enums
PLATFORM_UNSPECIFIED Nicht angegebene Plattform.
PLATFORM_IOS iOS-Plattform
PLATFORM_ANDROID Android-Plattform
PLATFORM_WEB Webplattform

AttributionHint

Der vom Partner angenommene Attributionsstatus für dieses Anzeigenereignis.

Enums
ATTRIBUTION_HINT_UNSPECIFIED Unbekannter Attributionsstatus.
ATTRIBUTION_HINT_CONVERTED Konvertierter Status.
ATTRIBUTION_HINT_NOT_CONVERTED Status „Nicht konvertiert“.

ViewabilityInfo

Details zur Sichtbarkeit der ausgelieferten Anzeige.

JSON-Darstellung 
{
  "viewType": enum (ViewType),
  "viewablePercent": integer,
  "viewableDuration": string,
  "mediaSkippable": boolean,
  "mediaQuartile": enum (MediaQuartile),
  "mediaDuration": string,
  "mediaVolumePercent": integer,
  "playbackDuration": string
}
Felder
viewType

enum (ViewType)

Erforderlich. Der Typ des Ereignisses.
viewablePercent

integer

Optional. Der numerische Prozentsatz (0–100) der sichtbaren Pixel.
viewableDuration

string (Duration format)

Optional. Die Zeit, in der die Anzeige sichtbar war.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
mediaSkippable

boolean

Optional. Gibt an, ob die Anzeigenmedien überspringbar waren.
mediaQuartile

enum (MediaQuartile)

Optional. Die Menge der Medien, die als diskrete Quartile wiedergegeben wurden.
mediaDuration

string (Duration format)

Optional. Die Dauer der Anzeigenmedien.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
mediaVolumePercent

integer

Optional. Der numerische Prozentsatz (0–100) der Lautstärke der Medienwiedergabe.
playbackDuration

string (Duration format)

Optional. Die Dauer der Wiedergabe der Anzeigenmedien, unabhängig davon, ob sie sichtbar waren.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".

ViewType

Der Typ des Ereignisses.

Enums
VIEW_TYPE_UNSPECIFIED Nicht angegebener Ansichtstyp.
VIEW_TYPE_MRC_VIEWED MRC-Ansicht
VIEW_TYPE_MRC_RENDERED MRC-gerendert.

MediaQuartile

Die Menge der Medien, die als diskrete Quartile wiedergegeben wurden.

Enums
MEDIA_QUARTILE_UNSPECIFIED Nicht angegebenes Media-Quartil.
MEDIA_QUARTILE_START Start.
MEDIA_QUARTILE_FIRST_QUARTILE Erstes Quartil.
MEDIA_QUARTILE_MIDPOINT Mittelpunkt
MEDIA_QUARTILE_THIRD_QUARTILE Drittes Quartil.
MEDIA_QUARTILE_COMPLETE Abgeschlossen