Method: events.ingest

Mengupload daftar resource Event dari Destination yang disediakan.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  }
}
Kolom
destinations[]

object (Destination)

Wajib. Daftar tujuan untuk mengirim peristiwa.
events[]

object (Event)

Wajib. Daftar peristiwa yang akan dikirim ke tujuan yang ditentukan. Maksimal 2.000 resource Event dapat dikirim dalam satu permintaan.
consent

object (Consent)

Opsional. Izin tingkat permintaan untuk diterapkan ke semua pengguna dalam permintaan. Izin tingkat pengguna menggantikan izin tingkat permintaan, dan dapat ditentukan di setiap Event.
validateOnly

boolean

Opsional. Untuk tujuan pengujian. Jika true, permintaan akan divalidasi, tetapi tidak dijalankan. Hanya error yang ditampilkan, bukan hasil.
encoding

enum (Encoding)

Opsional. Harus diberikan untuk upload UserData. Jenis encoding ID pengguna. Untuk ID pengguna yang di-hash, ini adalah jenis encoding string yang di-hash. Untuk ID pengguna yang di-hash dan dienkripsi, ini adalah jenis encoding string terenkripsi luar, tetapi belum tentu string yang di-hash dalam, yang berarti string yang di-hash dalam dapat dienkode dengan cara yang berbeda dari string terenkripsi luar. Untuk upload non-UserData, kolom ini diabaikan.
encryptionInfo

object (EncryptionInfo)

Opsional. Informasi enkripsi untuk upload UserData. Jika tidak ditetapkan, informasi identitas pribadi yang diupload akan dianggap di-hash, tetapi tidak dienkripsi. Untuk upload non-UserData, kolom ini diabaikan.

Isi respons

Respons dari IngestEventsRequest.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "requestId": string,
  "fieldWarnings": [
    {
      object (FieldWarning)
    }
  ]
}
Kolom
requestId

string

ID permintaan yang dibuat otomatis.
fieldWarnings[]

object (FieldWarning)

Peringatan tingkat baris yang mendetail dengan jalur kolom.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Acara

Peristiwa yang merepresentasikan interaksi pengguna dengan situs atau aplikasi pengiklan.

Representasi JSON 
{
  "destinationReferences": [
    string
  ],
  "transactionId": string,
  "eventTimestamp": string,
  "lastUpdatedTimestamp": string,
  "userData": {
    object (UserData)
  },
  "consent": {
    object (Consent)
  },
  "adIdentifiers": {
    object (AdIdentifiers)
  },
  "currency": string,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  },
  "eventName": string,
  "clientId": string,
  "userId": string,
  "additionalEventParameters": [
    {
      object (EventParameter)
    }
  ],
  "thirdPartyUserData": {
    object (UserData)
  },
  "eventLocation": {
    object (EventLocation)
  },
  "appInstanceId": string,
  "callInfo": {
    object (CallInfo)
  },
  "conversionValue": number,
  "conversionCount": number
}
Kolom
destinationReferences[]

string

Opsional. String referensi yang digunakan untuk menentukan tujuan. Jika kosong, peristiwa akan dikirim ke semua destinations dalam permintaan.
transactionId

string

Opsional. ID unik untuk peristiwa ini. Wajib diisi untuk peristiwa yang dikirim sebagai sumber data tambahan untuk konversi tag.
eventTimestamp

string (Timestamp format)

Wajib. Waktu peristiwa terjadi.

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

string (Timestamp format)

Opsional. Waktu terakhir peristiwa diperbarui.

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

object (UserData)

Opsional. Bagian data yang disediakan pengguna, yang mewakili pengguna yang terkait dengan peristiwa.
consent

object (Consent)

Opsional. Informasi tentang apakah pengguna terkait telah memberikan berbagai jenis izin.
adIdentifiers

object (AdIdentifiers)

Opsional. ID dan informasi lainnya yang digunakan untuk mencocokkan peristiwa konversi dengan aktivitas online lainnya (seperti klik iklan).
currency

string

Opsional. Kode mata uang yang terkait dengan semua nilai uang dalam peristiwa ini.
eventSource

enum (EventSource)

Opsional. Sinyal untuk tempat terjadinya peristiwa (web, aplikasi, di toko, dll.).
eventDeviceInfo

object (DeviceInfo)

Opsional. Informasi yang dikumpulkan tentang perangkat yang digunakan (jika ada) saat peristiwa terjadi.
cartData

object (CartData)

Opsional. Informasi tentang transaksi dan item yang terkait dengan peristiwa.
customVariables[]

object (CustomVariable)

Opsional. Informasi pasangan nilai/kunci tambahan yang akan dikirim ke penampung konversi (tindakan konversi atau aktivitas FL).
experimentalFields[]

object (ExperimentalField)

Opsional. Daftar key-value pair untuk kolom eksperimental yang pada akhirnya dapat dipromosikan untuk menjadi bagian dari API.
userProperties

object (UserProperties)

Opsional. Informasi yang dinilai pengiklan tentang pengguna pada saat peristiwa terjadi.
eventName

string

Opsional. Nama peristiwa. Wajib untuk peristiwa GA4.
clientId

string

Opsional. ID unik untuk instance pengguna klien web untuk aliran data web GA4 ini.
userId

string

Opsional. ID unik untuk pengguna, seperti yang ditentukan oleh pengiklan.
additionalEventParameters[]

object (EventParameter)

Opsional. Bucket parameter peristiwa apa pun yang akan disertakan dalam peristiwa yang belum ditentukan menggunakan kolom terstruktur lainnya.
thirdPartyUserData

object (UserData)

Opsional. Jenis data yang sama yang diberikan di userData, tetapi secara eksplisit ditandai sebagai data yang dimiliki oleh pihak ketiga dan bukan data pengiklan pihak pertama.
eventLocation

object (EventLocation)

Opsional. Informasi yang dikumpulkan tentang lokasi pengguna saat peristiwa ini terjadi.
appInstanceId

string

Opsional. ID unik untuk instance pengguna klien aplikasi untuk aliran data aplikasi GA4 ini.
callInfo

object (CallInfo)

Opsional. Informasi yang dikumpulkan tentang panggilan (jika ada) yang menyebabkan peristiwa ini.
conversionValue

number

Opsional. Nilai konversi yang terkait dengan peristiwa, untuk konversi berbasis nilai.
conversionCount

number

Opsional. Jumlah konversi yang terkait dengan peristiwa, untuk konversi berbasis penghitungan.

AdIdentifiers

ID dan informasi lainnya yang digunakan untuk mencocokkan peristiwa konversi dengan aktivitas online lainnya (seperti klik iklan).

Representasi JSON 
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": string,
  "dclid": string,
  "impressionId": string,
  "matchId": string,
  "encryptedUserIds": [
    {
      object (EncryptedUserId)
    }
  ],
  "ppid": string,
  "visitorPpid": string,
  "leadId": string
}
Kolom
sessionAttributes

string

Opsional. Atribut sesi untuk atribusi dan pemodelan peristiwa.
gclid

string

Opsional. ID klik Google (gclid) yang terkait dengan peristiwa ini.
gbraid

string

Opsional. ID klik untuk klik yang terkait dengan peristiwa aplikasi dan berasal dari perangkat iOS mulai dari iOS14.
wbraid

string

Opsional. ID klik untuk klik yang terkait dengan peristiwa web dan berasal dari perangkat iOS mulai dari iOS14.
landingPageDeviceInfo

object (DeviceInfo)

Opsional. Informasi yang dikumpulkan tentang perangkat yang digunakan (jika ada) pada saat membuka situs pengiklan setelah berinteraksi dengan iklan.
mobileDeviceId

string

Opsional. ID seluler untuk pengiklan. ID ini dapat berupa IDFA di iOS, AdID di Android, atau ID untuk pengiklan di platform lain.
dclid

string

Opsional. ID klik display yang terkait dengan peristiwa ini.
impressionId

string

Opsional. ID tayangan yang terkait dengan peristiwa ini.
matchId

string

Opsional. Kolom ID kecocokan yang digunakan untuk menggabungkan peristiwa ini dengan peristiwa sebelumnya.
encryptedUserIds[]

object (EncryptedUserId)

Opsional. Sejumlah ID pengguna terenkripsi.
ppid

string

Opsional. ID unik untuk pengguna yang diautentikasi (login), seperti yang ditentukan oleh penayang.
visitorPpid

string

Opsional. ID unik untuk pengguna yang tidak diautentikasi (pengguna yang tidak login), seperti yang ditentukan oleh penayang.
leadId

string

Opsional. ID yang dibuat Google yang dikeluarkan saat pengguna mengirimkan formulir lead.

EncryptedUserId

ID pengguna yang dikeluarkan untuk digunakan dalam atribusi. Semua kolom wajib diisi jika ini digunakan.

Representasi JSON 
{
  "encryptedId": string,
  "entityType": enum (EncryptionEntityType),
  "entityId": string,
  "source": enum (EncryptionSource)
}
Kolom
encryptedId

string

Wajib. ID terenkripsi alfanumerik.
entityType

enum (EncryptionEntityType)

Wajib. Jenis entity enkripsi. Konfigurasi ini harus sesuai dengan konfigurasi enkripsi untuk penayangan iklan atau Transfer Data.
entityId

string (int64 format)

Wajib. ID entitas enkripsi. Konfigurasi ini harus sesuai dengan konfigurasi enkripsi untuk penayangan iklan atau Transfer Data.
source

enum (EncryptionSource)

Wajib. Menjelaskan apakah cookie terenkripsi diterima dari penayangan iklan (makro %m) atau dari Transfer Data.

EncryptionEntityType

Jenis entity enkripsi.

Enum
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED Jenis entitas enkripsi tidak ditentukan.
CAMPAIGN_MANAGER_ACCOUNT Akun Campaign Manager 360.
CAMPAIGN_MANAGER_ADVERTISER Pengiklan Campaign Manager 360.
DISPLAY_VIDEO_PARTNER Partner Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Pengiklan Display & Video 360.
GOOGLE_ADS_CUSTOMER Pelanggan Google Ads.
GOOGLE_AD_MANAGER_NETWORK_CODE Kode jaringan Google Ad Manager.

EncryptionSource

Sumber enkripsi.

Enum
ENCRYPTION_SOURCE_UNSPECIFIED Sumber enkripsi tidak ditentukan.
AD_SERVING Sumber enkripsi penayangan iklan.
DATA_TRANSFER Sumber enkripsi transfer data.

EventSource

Sumber peristiwa.

Enum
EVENT_SOURCE_UNSPECIFIED EventSource tidak ditentukan. Tidak boleh digunakan.
WEB Peristiwa dibuat dari browser web.
APP Peristiwa dibuat dari aplikasi.
IN_STORE Peristiwa ini dihasilkan dari transaksi di toko.
PHONE Peristiwa dibuat dari panggilan telepon.
MESSAGE Acara ini dibuat dari pesan.
OTHER Peristiwa ini dibuat dari sumber lain.

CartData

Data keranjang yang terkait dengan peristiwa.

Representasi JSON 
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ],
  "couponCodes": [
    string
  ]
}
Kolom
merchantId

string

Opsional. ID Merchant Center yang terkait dengan item.
merchantFeedLabel

string

Opsional. Label feed Merchant Center yang terkait dengan feed item.
merchantFeedLanguageCode

string

Opsional. Kode bahasa dalam ISO 639-1 yang terkait dengan feed Merchant Center item tempat item Anda diupload.
transactionDiscount

number

Opsional. Jumlah semua diskon yang terkait dengan transaksi.
items[]

object (Item)

Opsional. Daftar item yang terkait dengan peristiwa.
couponCodes[]

string

Opsional. Daftar kode kupon yang diterapkan ke keranjang. Kode kupon tingkat keranjang dan tingkat item bersifat independen.

Jika peristiwa ditujukan untuk tujuan Google Analytics, berikan hanya satu kode kupon. Google Analytics akan mengabaikan kode kupon tambahan.

Item

Menunjukkan item di keranjang yang terkait dengan peristiwa.

Representasi JSON 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number,
  "itemId": string,
  "additionalItemParameters": [
    {
      object (ItemParameter)
    }
  ],
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "customVariables": [
    {
      object (ItemCustomVariable)
    }
  ],
  "conversionValue": number
}
Kolom
merchantProductId

string

Opsional. ID produk dalam akun Merchant Center.
quantity

string (int64 format)

Opsional. Jumlah item ini yang terkait dengan peristiwa.
unitPrice

number

Opsional. Harga satuan sebelum pajak, ongkos kirim, dan diskon tingkat transaksi.
itemId

string

Opsional. ID unik untuk mereferensikan item.
additionalItemParameters[]

object (ItemParameter)

Opsional. Bucket parameter peristiwa apa pun yang terkait dengan item yang akan disertakan dalam peristiwa yang belum ditentukan menggunakan kolom terstruktur lainnya.
merchantId

string

Opsional. ID Merchant Center yang terkait dengan item. Untuk peristiwa Penjualan Toko, nilai ini akan menggantikan nilai yang ditetapkan di tingkat keranjang. Kolom ini diabaikan untuk peristiwa lain.
merchantFeedLabel

string

Opsional. Label feed dari feed Merchant Center. Jika negara masih digunakan, kode negara 2 huruf dalam ISO-3166-1 alpha-2 dapat digunakan sebagai gantinya. Untuk peristiwa Penjualan Toko, nilai ini akan menggantikan nilai yang ditetapkan di tingkat keranjang. Kolom ini diabaikan untuk peristiwa lain.
merchantFeedLanguageCode

string

Opsional. Kode bahasa dalam ISO 639-1 yang terkait dengan feed Merchant Center tempat item Anda diupload.
customVariables[]

object (ItemCustomVariable)

Opsional. Informasi pasangan nilai kunci tambahan yang akan dikirim ke penampung konversi (tindakan konversi atau aktivitas Floodlight), saat melacak konversi per item.
conversionValue

number

Opsional. Nilai konversi yang terkait dengan item ini dalam peristiwa, untuk kasus saat nilai konversi berbeda untuk setiap item.

ItemParameter

Bucket parameter peristiwa apa pun yang terkait dengan item yang akan disertakan dalam peristiwa yang belum ditentukan menggunakan kolom terstruktur lainnya.

Representasi JSON 
{
  "parameterName": string,
  "value": string
}
Kolom
parameterName

string

Wajib. Nama parameter yang akan digunakan.
value

string

Wajib. Representasi string dari nilai parameter yang akan ditetapkan.

ItemCustomVariable

Variabel kustom tingkat item untuk konversi iklan.

Representasi JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Kolom
variable

string

Opsional. Nama variabel kustom yang akan ditetapkan. Jika variabel tidak ditemukan untuk tujuan yang diberikan, variabel tersebut akan diabaikan.
value

string

Opsional. Nilai yang akan disimpan untuk variabel kustom.
destinationReferences[]

string

Opsional. String referensi yang digunakan untuk menentukan Event.destination_references mana yang harus menerima variabel kustom. Jika kosong, Event.destination_references akan digunakan.

CustomVariable

Variabel kustom untuk konversi iklan.

Representasi JSON 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Kolom
variable

string

Opsional. Nama variabel kustom yang akan ditetapkan. Jika variabel tidak ditemukan untuk tujuan yang diberikan, variabel tersebut akan diabaikan.
value

string

Opsional. Nilai yang akan disimpan untuk variabel kustom.
destinationReferences[]

string

Opsional. String referensi yang digunakan untuk menentukan Event.destination_references mana yang harus menerima variabel kustom. Jika kosong, Event.destination_references akan digunakan.

ExperimentalField

Kolom eksperimental yang mewakili kolom tidak resmi.

Representasi JSON 
{
  "field": string,
  "value": string
}
Kolom
field

string

Opsional. Nama kolom yang akan digunakan.
value

string

Opsional. Nilai kolom yang akan ditetapkan.

UserProperties

Informasi yang dinilai pengiklan tentang pengguna pada saat peristiwa terjadi. Lihat https://support.google.com/google-ads/answer/14007601 untuk mengetahui detail selengkapnya.

Representasi JSON 
{
  "customerType": enum (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket),
  "additionalUserProperties": [
    {
      object (UserProperty)
    }
  ]
}
Kolom
customerType

enum (CustomerType)

Opsional. Jenis pelanggan yang terkait dengan peristiwa.
customerValueBucket

enum (CustomerValueBucket)

Opsional. Nilai pelanggan yang dinilai oleh pengiklan.
additionalUserProperties[]

object (UserProperty)

Opsional. Bucket properti pengguna tambahan untuk pengguna yang terkait dengan peristiwa ini.

CustomerType

Jenis pelanggan yang terkait dengan peristiwa.

Enum
CUSTOMER_TYPE_UNSPECIFIED CustomerType tidak ditentukan. Tidak boleh digunakan.
NEW Pelanggan tersebut adalah pelanggan baru bagi pengiklan.
RETURNING Pelanggan kembali ke pengiklan.
REENGAGED Pelanggan telah berinteraksi kembali dengan pengiklan.

CustomerValueBucket

Nilai pelanggan yang dinilai oleh pengiklan.

Enum
CUSTOMER_VALUE_BUCKET_UNSPECIFIED CustomerValueBucket tidak ditentukan. Tidak boleh digunakan.
LOW Pelanggan bernilai rendah.
MEDIUM Pelanggan bernilai sedang.
HIGH Pelanggan bernilai tinggi.

UserProperty

Bucket properti pengguna tambahan untuk pengguna yang terkait dengan peristiwa ini.

Representasi JSON 
{
  "propertyName": string,
  "value": string
}
Kolom
propertyName

string

Wajib. Nama properti pengguna yang akan digunakan.
value

string

Wajib. Representasi string dari nilai properti pengguna yang akan digunakan.

EventParameter

Parameter peristiwa untuk peristiwa GA4.

Representasi JSON 
{
  "parameterName": string,
  "value": string
}
Kolom
parameterName

string

Wajib. Nama parameter yang akan digunakan.
value

string

Wajib. Representasi string dari nilai parameter yang akan ditetapkan.

EventLocation

Lokasi tempat peristiwa terjadi.

Representasi JSON 
{
  "storeId": string,
  "city": string,
  "subdivisionCode": string,
  "regionCode": string,
  "subcontinentCode": string,
  "continentCode": string
}
Kolom
storeId

string

Opsional. Wajib untuk Penjualan Toko. ID untuk mewakili toko fisik tempat peristiwa terjadi.
city

string

Opsional. Nama kota tempat peristiwa terjadi.
subdivisionCode

string

Opsional. Kode subdivisi ISO 3166-2 tempat peristiwa terjadi.
regionCode

string

Opsional. Kode wilayah CLDR 2 huruf dari alamat pengguna.
subcontinentCode

string

Opsional. Kode subbenua dalam format UN M49 tempat peristiwa terjadi.
continentCode

string

Opsional. Kode benua dalam format UN M49 tempat peristiwa terjadi.

CallInfo

Informasi yang dikumpulkan tentang panggilan (jika ada) yang menyebabkan peristiwa ini.

Representasi JSON 
{
  "startTimestamp": string
}
Kolom
startTimestamp

string (Timestamp format)

Wajib. Waktu dimulainya panggilan telepon yang menghasilkan peristiwa ini.

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