Package google.ads.datamanager.v1

Indeks

IngestionService

Layanan untuk mengirim data audiens ke tujuan yang didukung.

IngestAudienceMembers

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

Mengupload daftar resource AudienceMember ke Destination yang diberikan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

Mengupload daftar resource Event dari Destination yang diberikan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

Menghapus daftar resource AudienceMember dari Destination yang diberikan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

AdIdentifiers

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

Kolom
session_attributes

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

DeviceInfo

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

AddressInfo

Informasi alamat pengguna.

Kolom
given_name

string

Wajib. Mengingat nama (depan) pengguna, semua huruf kecil, tanpa tanda baca, tanpa spasi kosong di awal atau akhir, dan di-hash sebagai SHA-256.
family_name

string

Wajib. Nama keluarga (terakhir) pengguna, semua huruf kecil, tanpa tanda baca, tanpa spasi kosong di awal atau akhir, dan di-hash sebagai SHA-256.
region_code

string

Wajib. Kode wilayah 2 huruf dalam ISO-3166-1 alpha-2 dari alamat pengguna.
postal_code

string

Wajib. Kode pos alamat pengguna.

AudienceMember

Anggota audiens yang akan dioperasikan.

Kolom
consent

Consent

Opsional. Setelan izin untuk pengguna.
Kolom union data. Jenis data identifikasi yang akan dioperasikan. data hanya dapat berupa salah satu dari berikut:
user_data

UserData

Data yang disediakan pengguna yang mengidentifikasi pengguna.
pair_data

PairData

ID Rekonsiliasi Identitas Pengiklan Penerbit (PAIR).
mobile_data

MobileData

Data yang mengidentifikasi perangkat seluler pengguna.

CartData

Data keranjang yang terkait dengan peristiwa.

Kolom
merchant_id

string

Opsional. ID Merchant Center yang terkait dengan item.
merchant_feed_label

string

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

string

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

double

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

Item

Opsional. Daftar item yang terkait dengan acara.

Setelan izin Digital Markets Act (DMA) untuk pengguna.

Kolom
ad_user_data

ConsentStatus

Opsional. Menunjukkan apakah pengguna memberikan izin untuk data pengguna iklan.
ad_personalization

ConsentStatus

Opsional. Menunjukkan apakah pengguna memberikan izin untuk personalisasi iklan.

ConsentStatus

Menunjukkan apakah pengguna memberikan, menolak, atau belum menentukan izin.

Enum
CONSENT_STATUS_UNSPECIFIED Tidak ditentukan.
CONSENT_GRANTED Diberikan.
CONSENT_DENIED Ditolak.

CustomVariable

Variabel kustom untuk konversi iklan.

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.
destination_references[]

string

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

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.

Destination

Produk Google yang Anda kirimi data. Misalnya, akun Google Ads.

Kolom
reference

string

Opsional. ID untuk resource Destination ini, unik dalam permintaan. Gunakan untuk mereferensikan Destination ini di IngestEventsRequest.
login_account

ProductAccount

Opsional. Akun yang digunakan untuk melakukan panggilan API ini. Untuk menambahkan atau menghapus data dari operating_account, login_account ini harus memiliki akses tulis ke operating_account. Misalnya, akun pengelola operating_account, atau akun yang memiliki tautan yang sudah dibuat ke operating_account.
linked_account

ProductAccount

Opsional. Akun yang dapat diakses oleh login_account pengguna yang memanggil, melalui penautan akun yang telah dibuat. Misalnya, login_account partner data mungkin memiliki akses ke linked_account klien. Partner dapat menggunakan kolom ini untuk mengirim data dari linked_account ke operating_account lain.
operating_account

ProductAccount

Wajib. Akun yang akan menerima data atau akun yang akan dihapus datanya.
product_destination_id

string

Wajib. Objek dalam akun produk yang akan di-ingest. Misalnya, ID audiens Google Ads atau ID audiens Display & Video 360.

DeviceInfo

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

Kolom
user_agent

string

Opsional. String agen pengguna perangkat untuk konteks tertentu.
ip_address

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.

Encoding

Jenis encoding informasi identifikasi yang di-hash.

Enum
ENCODING_UNSPECIFIED Jenis Encoding tidak ditentukan. Tidak boleh digunakan.
HEX Encoding hex.
BASE64 Encoding Base64.

EncryptionInfo

Informasi enkripsi untuk data yang sedang di-ingest.

Kolom
Kolom union wrapped_key. Kunci yang digabungkan yang digunakan untuk mengenkripsi data. wrapped_key hanya dapat berupa salah satu dari hal berikut:
gcp_wrapped_key_info

GcpWrappedKeyInfo

Informasi kunci terenkapsulasi Google Cloud Platform.

Acara

Peristiwa yang merepresentasikan interaksi pengguna dengan situs atau aplikasi pengiklan.

Kolom
destination_references[]

string

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

string

Wajib. ID unik untuk peristiwa ini.
event_timestamp

Timestamp

Wajib. Waktu terjadinya peristiwa.
last_updated_timestamp

Timestamp

Opsional. Terakhir kali acara diperbarui.
user_data

UserData

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

Consent

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

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

double

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

EventSource

Opsional. Sinyal untuk tempat terjadinya peristiwa (web, aplikasi, dalam toko, dll.).
event_device_info

DeviceInfo

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

CartData

Opsional. Informasi tentang transaksi dan item yang terkait dengan acara.
custom_variables[]

CustomVariable

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

ExperimentalField

Opsional. Daftar pasangan kunci/nilai untuk kolom eksperimental yang pada akhirnya dapat dipromosikan menjadi bagian dari API.
user_properties

UserProperties

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

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.

ExperimentalField

Kolom eksperimental yang merepresentasikan kolom tidak resmi.

Kolom
field

string

Opsional. Nama kolom yang akan digunakan.
value

string

Opsional. Nilai yang ditetapkan untuk kolom.

GcpWrappedKeyInfo

Informasi tentang kunci terenkapsulasi Google Cloud Platform.

Kolom
key_type

KeyType

Wajib. Jenis algoritma yang digunakan untuk mengenkripsi data.
wip_provider

string

Wajib. Penyedia pool Workload Identity yang diperlukan untuk menggunakan KEK.
kek_uri

string

Wajib. ID resource Cloud Key Management Service Google Cloud Platform.
encrypted_dek

string

Wajib. Kunci enkripsi data terenkripsi berenkode base64.

KeyType

Jenis algoritma yang digunakan untuk mengenkripsi data.

Enum
KEY_TYPE_UNSPECIFIED Jenis kunci tidak ditentukan. Tidak boleh digunakan.
XCHACHA20_POLY1305 Algoritma XChaCha20-Poly1305

IngestAudienceMembersRequest

Permintaan untuk mengupload anggota audiens ke tujuan yang diberikan. Menampilkan IngestAudienceMembersResponse.

Kolom
destinations[]

Destination

Wajib. Daftar tujuan untuk mengarahkan anggota audiens.
audience_members[]

AudienceMember

Wajib. Daftar pengguna yang akan dikirim ke tujuan yang ditentukan. Maksimal 10000 resource AudienceMember dapat dikirim dalam satu permintaan.
consent

Consent

Opsional. Izin tingkat permintaan untuk diterapkan kepada semua pengguna dalam permintaan. Izin tingkat pengguna menggantikan izin tingkat permintaan, dan dapat ditentukan di setiap AudienceMember.
validate_only

bool

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

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

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

TermsOfService

Opsional. Persyaratan layanan yang telah disetujui/ditolak pengguna.

IngestAudienceMembersResponse

Respons dari IngestAudienceMembersRequest.

Kolom
request_id

string

ID permintaan yang dibuat otomatis.

IngestEventsRequest

Permintaan untuk mengupload anggota audiens ke tujuan yang diberikan. Menampilkan IngestEventsResponse.

Kolom
destinations[]

Destination

Wajib. Daftar tujuan untuk mengirim peristiwa.
events[]

Event

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

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

bool

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

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

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.

IngestEventsResponse

Respons dari IngestEventsRequest.

Kolom
request_id

string

ID permintaan yang dibuat otomatis.

Item

Mewakili item dalam keranjang yang terkait dengan acara.

Kolom
merchant_product_id

string

Opsional. ID produk dalam akun Merchant Center.
quantity

int64

Opsional. Jumlah item ini yang terkait dengan peristiwa.
unit_price

double

Opsional. Harga satuan tidak termasuk pajak, pengiriman, dan diskon tingkat transaksi.

MobileData

ID seluler untuk audiens. Setidaknya diperlukan satu ID seluler.

Kolom
mobile_ids[]

string

Wajib. Daftar ID perangkat seluler (ID iklan/IDFA). Maksimal 10 mobileIds dapat diberikan dalam satu AudienceMember.

PairData

ID PAIR untuk audiens. Minimal satu ID PASANGAN diperlukan.

Kolom
pair_ids[]

string

Wajib. Data PII yang disediakan ruang bersih, di-hash dengan SHA256, dan dienkripsi dengan sandi komutatif EC menggunakan kunci penayang untuk daftar pengguna PAIR. Maksimal 10 pairIds dapat diberikan dalam satu AudienceMember.

Produk

Mewakili produk Google tertentu. Digunakan untuk menemukan akun dan tujuan.

Enum
PRODUCT_UNSPECIFIED Produk tidak ditentukan. Tidak boleh digunakan.
GOOGLE_ADS Google Ads.
DISPLAY_VIDEO_PARTNER Partner Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Pengiklan Display & Video 360.
DATA_PARTNER Partner Data.

ProductAccount

Mewakili akun tertentu.

Kolom
product

Product

Wajib. Produk yang memiliki akun tersebut. Misalnya, GOOGLE_ADS.
account_id

string

Wajib. ID akun. Misalnya, ID akun Google Ads Anda.

RemoveAudienceMembersRequest

Permintaan untuk menghapus pengguna dari audiens di tujuan yang diberikan. Menampilkan RemoveAudienceMembersResponse.

Kolom
destinations[]

Destination

Wajib. Daftar tujuan tempat pengguna akan dihapus.
audience_members[]

AudienceMember

Wajib. Daftar pengguna yang akan dihapus.
validate_only

bool

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

Encoding

Opsional. Diperlukan untuk upload UserData. Jenis encoding ID pengguna. Hanya berlaku untuk encoding luar ID pengguna terenkripsi. Untuk upload non-UserData, kolom ini diabaikan.
encryption_info

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.

RemoveAudienceMembersResponse

Respons dari RemoveAudienceMembersRequest.

Kolom
request_id

string

ID permintaan yang dibuat otomatis.

TermsOfService

Persyaratan layanan yang telah disetujui/ditolak pengguna.

Kolom
customer_match_terms_of_service_status

TermsOfServiceStatus

Opsional. Persyaratan layanan Customer Match: https://support.google.com/adspolicy/answer/6299717. Persyaratan ini harus disetujui untuk semua upload ke daftar pengguna Customer Match.

TermsOfServiceStatus

Mewakili keputusan penelepon untuk menyetujui atau menolak persyaratan layanan.

Enum
TERMS_OF_SERVICE_STATUS_UNSPECIFIED Tidak ditentukan.
ACCEPTED Status yang menunjukkan bahwa pemanggil telah memilih untuk menyetujui persyaratan layanan.
REJECTED Status yang menunjukkan bahwa pemanggil telah memilih untuk menolak persyaratan layanan.

UserData

Data yang mengidentifikasi pengguna. Minimal satu ID diperlukan.

Kolom
user_identifiers[]

UserIdentifier

Wajib. ID untuk pengguna. Anda dapat memberikan beberapa instance dari jenis data yang sama (misalnya, beberapa alamat email). Untuk meningkatkan kemungkinan kecocokan, berikan sebanyak mungkin ID. Maksimal 10 userIdentifiers dapat diberikan dalam satu AudienceMember atau Event.

UserIdentifier

Satu ID untuk pengguna.

Kolom
Kolom union identifier. Tepatnya satu yang harus ditentukan. identifier hanya dapat berupa salah satu dari berikut:
email_address

string

Alamat email yang di-hash menggunakan fungsi hash SHA-256 setelah normalisasi.
phone_number

string

Nomor telepon yang di-hash menggunakan fungsi hash SHA-256 setelah normalisasi (standar E164).
address

AddressInfo

Komponen alamat pengguna yang diketahui. Berisi pengelompokan ID yang dicocokkan sekaligus.

UserProperties

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

Kolom
customer_type

CustomerType

Opsional. Jenis pelanggan yang terkait dengan peristiwa.
customer_value_bucket

CustomerValueBucket

Opsional. Nilai pelanggan yang dinilai pengiklan.