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.

Żą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. Wymagane (co najmniej 1). Lista zdarzeń związanych z reklamami.
encryptionInfo

object (EncryptionInfo)

Opcjonalnie. Informacje o kluczach szyfrowania używanych do szyfrowania danych.
validateOnly

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)
  },
  "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)
  },

  // Union field event_subtype_oneof can be only one of the following:
  "eventSubtype": enum (EventSubtype),
  "eventSubtypeString": string
  // End of list of possible types for union field event_subtype_oneof.

  // Union field ad_type_oneof can be only one of the following:
  "adType": enum (AdType),
  "adTypeString": string
  // End of list of possible types for union field ad_type_oneof.

  // Union field ad_format_oneof can be only one of the following:
  "adFormat": enum (AdFormat),
  "adFormatString": string
  // End of list of possible types for union field ad_format_oneof.

  // Union field ad_placement_oneof can be only one of the following:
  "adPlacement": enum (AdPlacement),
  "adPlacementString": string
  // End of list of possible types for union field ad_placement_oneof.

  // Union field targeting_type_oneof can be only one of the following:
  "targetingType": enum (TargetingType),
  "targetingTypeString": string
  // End of list of possible types for union field targeting_type_oneof.

  // Union field platform_type_oneof can be only one of the following:
  "platformType": enum (PlatformType),
  "platformTypeString": string
  // End of list of possible types for union field platform_type_oneof.

  // Union field platform_oneof can be only one of the following:
  "platform": enum (Platform),
  "platformString": string
  // End of list of possible types for union field platform_oneof.
  "measurementAllowed": boolean
}
Pola
advertiserId

string

Wymagane. Identyfikator reklamodawcy w przypadku zdarzenia reklamowego.

Musi on być zgodny z identyfikatorem wysł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 prawdopodobieństwo, że znajdziemy dopasowanie.
deviceInfo

object (DeviceInfo)

Opcjonalnie. Informacje zebrane o urządzeniu używanym w momencie wystąpienia zdarzenia reklamowego.
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

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

string

Wymagane. Źródło platformy reklamy, podobne do źródła Google Analytics.
medium

string

Wymagane. Medium reklamy, podobne do medium w Google Analytics.
attributionHint

enum (AttributionHint)

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

Jest to tylko sygnał informujący o tym, jak partner założył, że przebiegała atrybucja. Nie wymusza on ostatecznego wyniku w raportach końcowych.
viewabilityInfo

object (ViewabilityInfo)

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

Pole zbiorcze event_subtype_oneof. 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. Pole event_subtype_oneof może mieć tylko jedną z tych wartości:
eventSubtype

enum (EventSubtype)

Wartość wyliczeniowa podtypu zdarzenia.
eventSubtypeString

string

Wartość ciągu podtypu zdarzenia.

Pole zbiorcze ad_type_oneof. 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. Pole ad_type_oneof może mieć tylko jedną z tych wartości:
adType

enum (AdType)

Wartość typu wyliczeniowego dla typu reklamy.
adTypeString

string

Wartość ciągu znaków typu reklamy.

Pole zbiorcze ad_format_oneof. 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. Pole ad_format_oneof może mieć tylko jedną z tych wartości:
adFormat

enum (AdFormat)

Wartość typu wyliczeniowego formatu reklamy.
adFormatString

string

Wartość ciągu znaków formatu reklamy.

Pole zbiorcze ad_placement_oneof. 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. Pole ad_placement_oneof może mieć tylko jedną z tych wartości:
adPlacement

enum (AdPlacement)

Wartość wyliczeniowa miejsca docelowego reklamy.
adPlacementString

string

Wartość ciągu znaków dla miejsca docelowego reklamy.

Pole zbiorcze targeting_type_oneof. 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. Pole targeting_type_oneof może mieć tylko jedną z tych wartości:
targetingType

enum (TargetingType)

Wartość typu wyliczeniowego dla typu kierowania.
targetingTypeString

string

Wartość ciągu znaków dla typu kierowania.

Pole zbiorcze platform_type_oneof. Opcjonalnie. Typ platformy, 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. Pole platform_type_oneof może mieć tylko jedną z tych wartości:
platformType

enum (PlatformType)

Wartość typu wyliczeniowego dla typu platformy.
platformTypeString

string

Wartość ciągu znaków dla typu platformy.

Pole zbiorcze platform_oneof. 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. Pole platform_oneof może mieć tylko jedną z tych wartości:
platform

enum (Platform)

Wartość wyliczeniowa platformy.
platformString

string

Wartość ciągu znaków dla platformy.
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 wyświetlenia angażującego.
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 reklama 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 Odkrywanie miejsca docelowego.
AD_PLACEMENT_FEED Miejsce docelowe pliku danych.
AD_PLACEMENT_HEADER Miejsce docelowe w nagłówku.
AD_PLACEMENT_HOME Miejsce docelowe w usłudze.
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 podstawie zamiaru zakupu,
TARGETING_TYPE_REMARKETING kierowanie remarketingowe,

TypPlatformy

Typ platformy, na której wyświetlono reklamę.

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

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 przyjęty przez partnera w przypadku tego zdarzenia reklamowego.

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. Procentowa wartość liczbowa (0–100) pikseli, które były widoczne.
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 reklamy, niezależnie od tego, czy była ona widoczna.

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 według 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.