Method: events.ingest

Mengupload daftar resource Event dari Destination yang diberikan.

Permintaan HTTP

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

URL 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 kepada 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 divalidasi tetapi tidak dieksekusi. Hanya error yang ditampilkan, bukan hasil.
encoding

enum (Encoding)

Opsional. Diperlukan 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 tidak harus 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 disetel, diasumsikan bahwa informasi identitas yang diupload 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
}
Kolom
requestId

string

ID permintaan yang dibuat otomatis.

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,
  "conversionValue": number,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  }
}
Kolom
destinationReferences[]

string

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

string

Wajib. ID unik untuk peristiwa ini.
eventTimestamp

string (Timestamp format)

Wajib. Waktu terjadinya peristiwa.

Menggunakan RFC 3339, dengan output yang dihasilkan 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. Terakhir kali acara diperbarui.

Menggunakan RFC 3339, dengan output yang dihasilkan 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 lain 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.
conversionValue

number

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

enum (EventSource)

Opsional. Sinyal untuk tempat terjadinya peristiwa (web, aplikasi, dalam 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 acara.
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 pasangan kunci/nilai untuk kolom eksperimental yang pada akhirnya dapat dipromosikan menjadi bagian dari API.
userProperties

object (UserProperties)

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

AdIdentifiers

ID dan informasi lain 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)
  }
}
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.

DeviceInfo

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

Representasi JSON 
{
  "userAgent": string,
  "ipAddress": string
}
Kolom
userAgent

string

Opsional. String agen pengguna perangkat untuk konteks tertentu.
ipAddress

string

Opsional. Alamat IP perangkat untuk konteks tertentu.

Catatan: Google Ads tidak mendukung pencocokan alamat IP untuk pengguna akhir di Wilayah Ekonomi Eropa (EEA), Inggris Raya (UK), atau Swiss (CH). Tambahkan logika untuk secara bersyarat mengecualikan pembagian alamat IP dari pengguna di wilayah ini dan pastikan Anda memberikan informasi yang jelas dan komprehensif kepada pengguna tentang data yang Anda kumpulkan di situs, aplikasi, dan properti Anda lainnya, serta mendapatkan izin jika diwajibkan oleh hukum atau kebijakan Google yang berlaku. Lihat halaman Tentang impor konversi offline untuk mengetahui detail selengkapnya.

EventSource

Sumber peristiwa.

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

CartData

Data keranjang yang terkait dengan peristiwa.

Representasi JSON 
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ]
}
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 tempat item Anda diupload.
transactionDiscount

number

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

object (Item)

Opsional. Daftar item yang terkait dengan acara.

Item

Mewakili item dalam keranjang yang terkait dengan acara.

Representasi JSON 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": 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 tidak termasuk pajak, pengiriman, dan diskon tingkat transaksi.

CustomVariable

Variabel kustom untuk konversi iklan.

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

string

Opsional. Nama variabel kustom yang akan disetel. 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 dikirimi variabel kustom. Jika kosong, Event.destination_references akan digunakan.

ExperimentalField

Kolom eksperimental yang merepresentasikan kolom tidak resmi.

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

string

Opsional. Nama kolom yang akan digunakan.
value

string

Opsional. Nilai yang ditetapkan untuk kolom.

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)
}
Kolom
customerType

enum (CustomerType)

Opsional. Jenis pelanggan yang terkait dengan peristiwa.
customerValueBucket

enum (CustomerValueBucket)

Opsional. Nilai pelanggan yang dinilai pengiklan.

CustomerType

Jenis pelanggan yang terkait dengan peristiwa.

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

CustomerValueBucket

Nilai pelanggan yang dinilai pengiklan.

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