Method: adEvents.ingest

Przesyła do Google Analytics listę zasobów AdEvent.

Ta funkcja jest dostępna tylko na kontach znajdujących się na liście dozwolonych.

Nagłówki autoryzacji:

Ta metoda wymaga też tego nagłówka, aby określić, jak interfejs API autoryzuje dostęp do żądania:

  • login-account: (Wymagane) Nazwa zasobu konta partnera danych, na którym konto Google powiązane z danymi logowania jest użytkownikiem. Format: accountTypes/DATA_PARTNER/accounts/{loginAccountId}

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
Pola
adEvents[]

object (AdEvent)

Wymagane. Wymagany (co najmniej 1). Lista zdarzeń związanych z reklamami.
encryptionInfo

object (EncryptionInfo)

Opcjonalnie: Informacje o kluczach szyfrowania używanych do szyfrowania danych. To pole musi być podane, gdy zdarzenia związane z reklamami zawierają wartość UserData.
validateOnly
(deprecated)

boolean

Opcjonalnie: Jeśli wartość to „prawda”, żądanie jest weryfikowane, ale nie wykonywane.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie pusta.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

AdEvent

Zdarzenie reklamowe.

Zapis 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
}
Pola
advertiserId

string

Wymagane. Identyfikator reklamodawcy w przypadku zdarzenia reklamowego.

Musi on być zgodny z identyfikatorem przesłanym w procesie łączenia.
eventType

enum (EventType)

Wymagane. Typ zdarzenia.
timestamp

string (Timestamp format)

Wymagane. Czas wystąpienia zdarzenia.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
eventId

string

Opcjonalnie: Identyfikator utworzony i zarządzany przez wywołującego, który jednoznacznie identyfikuje to zdarzenie.

Wymagany, jeśli chcesz usuwać duplikaty zdarzeń związanych z reklamami, które są uwzględnione w wielu żądaniach. W przeciwnym razie to pole jest opcjonalne.
userData

object (UserData)

Opcjonalnie: Wiele rodzajów danych przekazywanych przez użytkowników, które reprezentują użytkownika powiązanego ze zdarzeniem.

Możesz podać wiele instancji tego samego typu danych (np. adres e-mail). Im więcej danych podasz, tym większe będzie prawdopodobieństwo znalezienia dopasowania.
deviceInfo

object (DeviceInfo)

Wymagane. Informacje zebrane o urządzeniu używanym w momencie wystąpienia zdarzenia reklamowego.
ipAddress

string

Opcjonalnie: Adres IP używany do pomiaru. Musi mieć taką samą wartość jak DeviceInfo.ip_address. Jeśli nie chcesz udostępniać adresu IP na potrzeby pomiarów, pozostaw to pole puste.
mobileDeviceId

string

Opcjonalnie: Identyfikator urządzenia, na którym wyświetlono reklamę.
campaignId

string

Wymagane. Identyfikator powiązanej kampanii.
campaignName

string

Wymagane. Nazwa powiązanej kampanii.
adGroupId

string

Opcjonalnie: Identyfikator powiązanej grupy reklam.
adId

string

Opcjonalnie: Identyfikator powiązanej reklamy w grupie.
adHeight

integer

Opcjonalnie: Wysokość reklamy w pikselach.
adWidth

integer

Opcjonalnie: Szerokość reklamy w pikselach.
regionCode

string

Opcjonalnie: Kraj i podział podrzędny w formacie ISO 3166-2.
source

string

Wymagane. Platforma źródłowa reklamy, podobna do źródła w Google Analytics.
medium

string

Wymagane. Rodzaj reklamy, podobny do rodzaju w Google Analytics.
attributionHint

enum (AttributionHint)

Opcjonalnie: Stan atrybucji tego zdarzenia reklamowego przyjęty przez partnera.

Służy to tylko jako sygnał informujący o tym, jak partner założył, że przebiegała atrybucja, i nie wymusza ostatecznego wyniku w raportach końcowych.
viewabilityInfo

object (ViewabilityInfo)

Wymagane. Szczegóły widoczności wyświetlonej reklamy.

Opcjonalnie: Dodatkowa klasyfikacja typu zdarzenia reklamowego.

Akceptowany jest ciąg znaków w formacie surowym, aby obsługiwać wartości inne niż czyste wyliczenia. Jeśli to możliwe, preferowany jest typ wyliczeniowy. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
eventSubtype

enum (EventSubtype)

Wartość wyliczeniowa podtypu zdarzenia.
eventSubtypeString

string

Wartość ciągu podtypu zdarzenia.
Koniec pól wykluczających się nawzajem.

Opcjonalnie: Typ wyświetlonej reklamy.

Akceptowany jest ciąg znaków w formacie surowym, aby obsługiwać wartości inne niż czyste wyliczenia. Jeśli to możliwe, preferowany jest typ wyliczeniowy. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
adType

enum (AdType)

Wartość typu wyliczeniowego dla typu reklamy.
adTypeString

string

Wartość ciągu typu reklamy.
Koniec pól wykluczających się nawzajem.

Opcjonalnie: Typ wyświetlonej reklamy.

Akceptowany jest ciąg znaków w formacie surowym, aby obsługiwać wartości inne niż czyste wyliczenia. Jeśli to możliwe, preferowany jest typ wyliczeniowy. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
adFormat

enum (AdFormat)

Wartość typu wyliczeniowego formatu reklamy.
adFormatString

string

Wartość ciągu tekstowego formatu reklamy.
Koniec pól wykluczających się nawzajem.

Opcjonalnie: Miejsce docelowe wyświetlonej reklamy.

Akceptowany jest ciąg znaków w formacie surowym, aby obsługiwać wartości inne niż czyste wyliczenia. Jeśli to możliwe, preferowany jest typ wyliczeniowy. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
adPlacement

enum (AdPlacement)

Wartość wyliczeniowa miejsca docelowego reklamy.
adPlacementString

string

Ciąg znaków określający miejsce docelowe reklamy.
Koniec pól wykluczających się nawzajem.

Opcjonalnie: Typ kierowania użyty do wyświetlenia reklamy.

Akceptowany jest ciąg znaków w formacie surowym, aby obsługiwać wartości inne niż czyste wyliczenia. Jeśli to możliwe, preferowany jest typ wyliczeniowy. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
targetingType

enum (TargetingType)

Wartość typu wyliczeniowego dla typu kierowania.
targetingTypeString

string

Wartość ciągu znaków dla typu kierowania.
Koniec pól wykluczających się nawzajem.

Opcjonalnie: Typ platformy, na której wyświetliła się reklama.

Akceptowany jest ciąg znaków w formacie surowym, aby obsługiwać wartości inne niż czyste wyliczenia. Jeśli to możliwe, preferowany jest typ wyliczeniowy. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
platformType

enum (PlatformType)

Wartość typu wyliczeniowego dla typu platformy.
platformTypeString

string

Wartość ciągu dla typu platformy.
Koniec pól wykluczających się nawzajem.

Opcjonalnie: Dodatkowe informacje o platformie, na której wyświetlono reklamę.

Akceptowany jest ciąg znaków w formacie surowym, aby obsługiwać wartości inne niż czyste wyliczenia. Jeśli to możliwe, preferowany jest typ wyliczeniowy. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
platform

enum (Platform)

Wartość typu enum dla platformy.
platformString

string

Wartość ciągu znaków dla platformy.
Koniec pól wykluczających się nawzajem.
measurementAllowed

boolean

Opcjonalnie: Określa, czy wiersz może być używany do celów pomiarowych zgodnie z obowiązującymi przepisami dotyczącymi ochrony prywatności w danym regionie.

EventType

Typ zdarzenia.

Wartości w polu enum
EVENT_TYPE_UNSPECIFIED Nieokreślony typ zdarzenia.
EVENT_TYPE_VIEW Wyświetl wydarzenie.
EVENT_TYPE_CLICK Zdarzenie kliknięcia.

EventSubtype

Dodatkowa klasyfikacja typu zdarzenia reklamowego.

Wartości w polu enum
EVENT_SUBTYPE_UNSPECIFIED Nieokreślony podtyp zdarzenia.
EVENT_SUBTYPE_IMPRESSION Zdarzenie wyświetlenia.
EVENT_SUBTYPE_ENGAGED_VIEW Zdarzenie typu wyświetlenie angażujące.
EVENT_SUBTYPE_ONSITE_CLICK Zdarzenie kliknięcia w witrynie.
EVENT_SUBTYPE_OUTBOUND_CLICK Zdarzenie kliknięcia wychodzącego.

AdType

Typ wyświetlonej reklamy.

Wartości w polu enum
AD_TYPE_UNSPECIFIED Nieokreślony typ reklamy.
AD_TYPE_DISPLAY Reklama displayowa.
AD_TYPE_TEXT Reklama tekstowa.
AD_TYPE_IMAGE Reklama graficzna
AD_TYPE_RICH_MEDIA Reklama multimedialna.
AD_TYPE_HTML reklama HTML,
AD_TYPE_AUDIO reklama audio;
AD_TYPE_VIDEO Reklama wideo

AdFormat

Format wyświetlonej reklamy.

Wartości w polu enum
AD_FORMAT_UNSPECIFIED Nieokreślony format reklamy.
AD_FORMAT_AR reklamy AR.
AD_FORMAT_AUDIO reklama audio;
AD_FORMAT_BANNER Baner reklamowy.
AD_FORMAT_BUMPER Bumper reklamowy.
AD_FORMAT_COLLECTION Reklama z kolekcją.
AD_FORMAT_IMAGE Reklama graficzna
AD_FORMAT_INTERACTIVE reklama interaktywna,
AD_FORMAT_INTERSTITIAL Reklama pełnoekranowa.
AD_FORMAT_IN_FEED Reklama In-Feed.
AD_FORMAT_IN_STREAM Reklama In-Stream.
AD_FORMAT_IN_STREAM_SKIPPABLE Reklama In-Stream możliwa do pominięcia.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE Reklama In-Stream niemożliwa do pominięcia.
AD_FORMAT_NATIVE Reklama natywna.
AD_FORMAT_SHORTS reklamy w Shorts.
AD_FORMAT_STORY Reklama z historyjką.
AD_FORMAT_SPONSORED Reklama sponsorowana.
AD_FORMAT_VIDEO Reklama wideo

AdPlacement

Miejsce docelowe wyświetlonej reklamy.

Wartości w polu enum
AD_PLACEMENT_UNSPECIFIED Nieokreślone miejsce docelowe reklamy.
AD_PLACEMENT_DISCOVER Reklamy Discover w miejscach docelowych.
AD_PLACEMENT_FEED umieszczenie w kanale,
AD_PLACEMENT_HEADER Umieszczenie w nagłówku.
AD_PLACEMENT_HOME Miejsce docelowe na stronie głównej.
AD_PLACEMENT_IN_CONTENT Miejsce docelowe w treści.
AD_PLACEMENT_PROMOTED Promowane miejsce docelowe.
AD_PLACEMENT_STORY Miejsce docelowe relacji.

TargetingType

Typ kierowania użyty do wyświetlenia reklamy.

Wartości w polu enum
TARGETING_TYPE_UNSPECIFIED Nieokreślony typ kierowania.
TARGETING_TYPE_AUDIENCE Kierowanie na odbiorców.
TARGETING_TYPE_CONTEXTUAL Kierowanie kontekstowe.
TARGETING_TYPE_DEMOGRAPHIC Kierowanie demograficzne.
TARGETING_TYPE_DEVICE Kierowanie na urządzenia.
TARGETING_TYPE_GEO Kierowanie geograficzne.
TARGETING_TYPE_INTEREST Kierowanie na zainteresowania.
TARGETING_TYPE_PURCHASE_INTENT kierowanie na zamiar zakupu,
TARGETING_TYPE_REMARKETING kierowanie na remarketing,

TypPlatformy

Typ platformy, na której wyświetliła się reklama.

Wartości w polu enum
PLATFORM_TYPE_UNSPECIFIED Nieokreślony typ platformy.
PLATFORM_TYPE_MOBILE Platforma mobilna.
PLATFORM_TYPE_DESKTOP platforma komputerowa,
PLATFORM_TYPE_CTV platformy CTV.
PLATFORM_TYPE_PHONE Platforma telefonu.
PLATFORM_TYPE_TABLET platforma tabletów,

Platforma

Dodatkowe informacje o platformie, na której wyświetlono reklamę.

Wartości w polu enum
PLATFORM_UNSPECIFIED Nieokreślona platforma.
PLATFORM_IOS platformy iOS.
PLATFORM_ANDROID platforma Android,
PLATFORM_WEB Platforma internetowa.

AttributionHint

Stan atrybucji tego zdarzenia reklamowego przyjęty przez partnera.

Wartości w polu enum
ATTRIBUTION_HINT_UNSPECIFIED Nieznany stan atrybucji.
ATTRIBUTION_HINT_CONVERTED Stan przekształcenia.
ATTRIBUTION_HINT_NOT_CONVERTED Stan „Nie skonwertowano”.

ViewabilityInfo

Szczegóły widoczności wyświetlonej reklamy.

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

enum (ViewType)

Wymagane. Typ zdarzenia.
viewablePercent

integer

Opcjonalnie: Procent pikseli, które były widoczne (0–100).
viewableDuration

string (Duration format)

Opcjonalnie: Czas, przez jaki reklama była widoczna.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".
mediaSkippable

boolean

Opcjonalnie: Czy treści reklamowe można było pominąć.
mediaQuartile

enum (MediaQuartile)

Opcjonalnie: Ilość odtworzonych multimediów w postaci dyskretnych kwartyli.
mediaDuration

string (Duration format)

Opcjonalnie: Czas trwania treści reklamowych.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".
mediaVolumePercent

integer

Opcjonalnie: Procentowa wartość liczbowa (0–100) głośności odtwarzania multimediów.
playbackDuration

string (Duration format)

Opcjonalnie: Czas trwania odtwarzania treści reklamowych, niezależnie od tego, czy były widoczne.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".

ViewType

Typ zdarzenia.

Wartości w polu enum
VIEW_TYPE_UNSPECIFIED Nieokreślony typ widoku.
VIEW_TYPE_MRC_VIEWED Wyświetlono zgodnie z zasadami MRC.
VIEW_TYPE_MRC_RENDERED MRC rendered.

MediaQuartile

Ilość odtworzonych multimediów w postaci dyskretnych kwartyli.

Wartości w polu enum
MEDIA_QUARTILE_UNSPECIFIED Nieokreślony kwartyl multimediów.
MEDIA_QUARTILE_START Rozpocznij.
MEDIA_QUARTILE_FIRST_QUARTILE Pierwszy kwartyl
MEDIA_QUARTILE_MIDPOINT Do połowy.
MEDIA_QUARTILE_THIRD_QUARTILE Trzeci kwartyl
MEDIA_QUARTILE_COMPLETE Zakończono.