Method: adEvents.ingest

Mengupload daftar resource AdEvent ke Google Analytics.

Fitur ini hanya tersedia untuk akun yang ada dalam daftar yang diizinkan.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

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

object (AdEvent)

Wajib. Wajib (minimal 1). Daftar peristiwa iklan.
encryptionInfo

object (EncryptionInfo)

Opsional. Informasi tentang kunci enkripsi yang digunakan untuk mengenkripsi data.
validateOnly

boolean

Opsional. Jika benar, permintaan divalidasi, tetapi tidak dieksekusi.

Isi respons

Jika berhasil, isi respons akan kosong.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

AdEvent

Peristiwa iklan.

Representasi 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
}
Kolom
advertiserId

string

Wajib. ID pengiklan untuk peristiwa iklan.

ID ini harus cocok dengan ID yang dikirim dalam alur penautan.
eventType

enum (EventType)

Wajib. Jenis peristiwa.
timestamp

string (Timestamp format)

Wajib. Waktu terjadinya peristiwa.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
eventId

string

Opsional. ID yang dibuat dan dikelola oleh pemanggil yang mengidentifikasi peristiwa ini secara unik.

Wajib diisi jika Anda ingin menghapus duplikat peristiwa iklan yang disertakan dalam beberapa permintaan. Jika tidak, kolom ini bersifat opsional.
userData

object (UserData)

Opsional. Beberapa bagian data yang disediakan pengguna, yang mewakili pengguna yang terkait dengan peristiwa.

Anda dapat memberikan beberapa instance jenis data yang sama (mis. alamat email). Semakin banyak data yang diberikan, semakin besar kemungkinan kecocokan akan ditemukan.
deviceInfo

object (DeviceInfo)

Opsional. Informasi yang dikumpulkan tentang perangkat yang digunakan saat peristiwa iklan terjadi.
mobileDeviceId

string

Opsional. ID perangkat yang digunakan untuk menayangkan iklan.
campaignId

string

Wajib. ID kampanye terkait.
campaignName

string

Wajib. Nama kampanye terkait.
adGroupId

string

Opsional. ID grup iklan terkait.
adId

string

Opsional. ID iklan terkait dalam grup.
adHeight

integer

Opsional. Tinggi iklan dalam piksel.
adWidth

integer

Opsional. Lebar iklan dalam piksel.
regionCode

string

Wajib. Negara plus subdivisi ISO 3166-2.
source

string

Wajib. Sumber platform iklan, mirip dengan sumber Google Analytics.
medium

string

Wajib. Media iklan, mirip dengan media Google Analytics.
attributionHint

enum (AttributionHint)

Opsional. Status atribusi yang diasumsikan partner untuk peristiwa iklan ini.

Hal ini hanya berfungsi sebagai sinyal tentang bagaimana partner mengasumsikan atribusi terjadi, dan tidak memaksakan hasil akhir dalam laporan akhir.
viewabilityInfo

object (ViewabilityInfo)

Wajib. Detail visibilitas iklan yang ditayangkan.

Kolom union event_subtype_oneof. Opsional. Klasifikasi tambahan tentang jenis peristiwa iklan.

String mentah diterima untuk menangani nilai selain enum murni. Enum lebih disukai jika memungkinkan. event_subtype_oneof hanya dapat berupa salah satu dari hal berikut:
eventSubtype

enum (EventSubtype)

Nilai enum untuk subjenis acara.
eventSubtypeString

string

Nilai string untuk subjenis acara.

Kolom union ad_type_oneof. Opsional. Jenis iklan yang ditayangkan.

String mentah diterima untuk menangani nilai selain enum murni. Enum lebih disukai jika memungkinkan. ad_type_oneof hanya dapat berupa salah satu dari hal berikut:
adType

enum (AdType)

Nilai enum untuk jenis iklan.
adTypeString

string

Nilai string untuk jenis iklan.

Kolom union ad_format_oneof. Opsional. Jenis iklan yang ditayangkan.

String mentah diterima untuk menangani nilai selain enum murni. Enum lebih disukai jika memungkinkan. ad_format_oneof hanya dapat berupa salah satu dari hal berikut:
adFormat

enum (AdFormat)

Nilai enum untuk format iklan.
adFormatString

string

Nilai string untuk format iklan.

Kolom union ad_placement_oneof. Opsional. Penempatan iklan yang ditayangkan.

String mentah diterima untuk menangani nilai selain enum murni. Enum lebih disukai jika memungkinkan. ad_placement_oneof hanya dapat berupa salah satu dari hal berikut:
adPlacement

enum (AdPlacement)

Nilai enum untuk penempatan iklan.
adPlacementString

string

Nilai string untuk penempatan iklan.

Kolom union targeting_type_oneof. Opsional. Jenis penargetan yang digunakan untuk menayangkan iklan.

String mentah diterima untuk menangani nilai selain enum murni. Enum lebih disukai jika memungkinkan. targeting_type_oneof hanya dapat berupa salah satu dari hal berikut:
targetingType

enum (TargetingType)

Nilai enum untuk jenis penargetan.
targetingTypeString

string

Nilai string untuk jenis penargetan.

Kolom union platform_type_oneof. Opsional. Jenis platform tempat iklan ditayangkan.

String mentah diterima untuk menangani nilai selain enum murni. Enum lebih disukai jika memungkinkan. platform_type_oneof hanya dapat berupa salah satu dari hal berikut:
platformType

enum (PlatformType)

Nilai enum untuk jenis platform.
platformTypeString

string

Nilai string untuk jenis platform.

Kolom union platform_oneof. Opsional. Detail lebih lanjut tentang platform tempat iklan ditayangkan.

String mentah diterima untuk menangani nilai selain enum murni. Enum lebih disukai jika memungkinkan. platform_oneof hanya dapat berupa salah satu dari hal berikut:
platform

enum (Platform)

Nilai enum untuk platform.
platformString

string

Nilai string untuk platform.
measurementAllowed

boolean

Opsional. Menunjukkan apakah baris diizinkan untuk digunakan untuk tujuan pengukuran, sebagaimana diatur oleh hukum privasi yang berlaku dalam yurisdiksi regional.

EventType

Jenis peristiwa.

Enum
EVENT_TYPE_UNSPECIFIED Jenis peristiwa tidak ditentukan.
EVENT_TYPE_VIEW Lihat acara.
EVENT_TYPE_CLICK Peristiwa klik.

EventSubtype

Klasifikasi tambahan tentang jenis peristiwa iklan.

Enum
EVENT_SUBTYPE_UNSPECIFIED Subjenis peristiwa tidak ditentukan.
EVENT_SUBTYPE_IMPRESSION Peristiwa tayangan iklan.
EVENT_SUBTYPE_ENGAGED_VIEW Peristiwa penayangan tak dilewati.
EVENT_SUBTYPE_ONSITE_CLICK Peristiwa klik di situs.
EVENT_SUBTYPE_OUTBOUND_CLICK Peristiwa klik keluar.

AdType

Jenis iklan yang ditayangkan.

Enum
AD_TYPE_UNSPECIFIED Jenis iklan tidak ditentukan.
AD_TYPE_DISPLAY Iklan Display.
AD_TYPE_TEXT Iklan teks.
AD_TYPE_IMAGE Iklan gambar.
AD_TYPE_RICH_MEDIA Iklan multimedia.
AD_TYPE_HTML Iklan HTML.
AD_TYPE_AUDIO Iklan audio.
AD_TYPE_VIDEO Iklan video.

AdFormat

Format iklan yang ditayangkan.

Enum
AD_FORMAT_UNSPECIFIED Format iklan tidak ditentukan.
AD_FORMAT_AR Iklan AR.
AD_FORMAT_AUDIO Iklan audio.
AD_FORMAT_BANNER Iklan banner.
AD_FORMAT_BUMPER Iklan bumper.
AD_FORMAT_COLLECTION Iklan koleksi.
AD_FORMAT_IMAGE Iklan gambar.
AD_FORMAT_INTERACTIVE Iklan interaktif.
AD_FORMAT_INTERSTITIAL Iklan interstisial.
AD_FORMAT_IN_FEED Iklan dalam feed.
AD_FORMAT_IN_STREAM Iklan dalam stream.
AD_FORMAT_IN_STREAM_SKIPPABLE Iklan dalam stream yang dapat dilewati.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE Iklan in-stream yang tidak dapat dilewati.
AD_FORMAT_NATIVE Iklan native.
AD_FORMAT_SHORTS Iklan Shorts.
AD_FORMAT_STORY Iklan cerita.
AD_FORMAT_SPONSORED Iklan bersponsor.
AD_FORMAT_VIDEO Iklan video.

AdPlacement

Penempatan iklan yang ditayangkan.

Enum
AD_PLACEMENT_UNSPECIFIED Penempatan iklan tidak ditentukan.
AD_PLACEMENT_DISCOVER Temukan penempatan.
AD_PLACEMENT_FEED Penempatan feed.
AD_PLACEMENT_HEADER Penempatan header.
AD_PLACEMENT_HOME Penempatan di halaman beranda.
AD_PLACEMENT_IN_CONTENT Penempatan dalam konten.
AD_PLACEMENT_PROMOTED Penempatan yang dipromosikan.
AD_PLACEMENT_STORY Penempatan cerita.

TargetingType

Jenis penargetan yang digunakan untuk menayangkan iklan.

Enum
TARGETING_TYPE_UNSPECIFIED Jenis penargetan tidak ditentukan.
TARGETING_TYPE_AUDIENCE Penargetan audiens.
TARGETING_TYPE_CONTEXTUAL Penargetan kontekstual.
TARGETING_TYPE_DEMOGRAPHIC Penargetan demografis.
TARGETING_TYPE_DEVICE Penargetan perangkat.
TARGETING_TYPE_GEO Penargetan geografis.
TARGETING_TYPE_INTEREST Penargetan minat.
TARGETING_TYPE_PURCHASE_INTENT Penargetan niat membeli.
TARGETING_TYPE_REMARKETING Penargetan pemasaran ulang.

PlatformType

Jenis platform tempat iklan ditayangkan.

Enum
PLATFORM_TYPE_UNSPECIFIED Jenis platform tidak ditentukan.
PLATFORM_TYPE_MOBILE Platform seluler.
PLATFORM_TYPE_DESKTOP Platform desktop.
PLATFORM_TYPE_CTV Platform CTV.
PLATFORM_TYPE_PHONE Platform ponsel.
PLATFORM_TYPE_TABLET Platform tablet.

Platform

Detail lebih lanjut tentang platform tempat iklan ditayangkan.

Enum
PLATFORM_UNSPECIFIED Platform tidak ditentukan.
PLATFORM_IOS Platform iOS.
PLATFORM_ANDROID Platform Android.
PLATFORM_WEB Platform web.

AttributionHint

Status atribusi yang diasumsikan partner untuk peristiwa iklan ini.

Enum
ATTRIBUTION_HINT_UNSPECIFIED Status atribusi tidak diketahui.
ATTRIBUTION_HINT_CONVERTED Status terkonversi.
ATTRIBUTION_HINT_NOT_CONVERTED Status tidak dikonversi.

ViewabilityInfo

Detail visibilitas iklan yang ditayangkan.

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

enum (ViewType)

Wajib. Jenis peristiwa.
viewablePercent

integer

Opsional. Persen numerik (0-100) piksel yang terlihat.
viewableDuration

string (Duration format)

Opsional. Durasi iklan dapat dilihat.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
mediaSkippable

boolean

Opsional. Apakah media iklan dapat dilewati atau tidak.
mediaQuartile

enum (MediaQuartile)

Opsional. Jumlah media yang diputar sebagai kuartil terpisah.
mediaDuration

string (Duration format)

Opsional. Durasi media iklan.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
mediaVolumePercent

integer

Opsional. Persen numerik (0-100) volume pemutaran media.
playbackDuration

string (Duration format)

Opsional. Durasi pemutaran media iklan, terlepas dari apakah iklan tersebut dapat dilihat atau tidak.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".

ViewType

Jenis peristiwa.

Enum
VIEW_TYPE_UNSPECIFIED Jenis tampilan tidak ditentukan.
VIEW_TYPE_MRC_VIEWED MRC dilihat.
VIEW_TYPE_MRC_RENDERED MRC ditampilkan.

MediaQuartile

Jumlah media yang diputar sebagai kuartil terpisah.

Enum
MEDIA_QUARTILE_UNSPECIFIED Kuartil media tidak ditentukan.
MEDIA_QUARTILE_START Mulai.
MEDIA_QUARTILE_FIRST_QUARTILE Kuartil pertama.
MEDIA_QUARTILE_MIDPOINT Titik tengah.
MEDIA_QUARTILE_THIRD_QUARTILE Kuartil ketiga.
MEDIA_QUARTILE_COMPLETE Selesai.