Video: Lihat pembahasan Layanan dan Referensi dari workshop 2019
Panduan ini memperkenalkan komponen utama yang membentuk Google Ads API. Google Ads API terdiri dari resource dan layanan. Resource mewakili entitas Google Ads, sedangkan layanan mengambil dan memanipulasi entitas Google Ads.
Hierarki objek
Akun Google Ads dapat dilihat sebagai hierarki objek.
Resource level teratas suatu akun adalah pelanggan.
Setiap pelanggan berisi satu atau beberapa kampanye aktif.
Setiap kampanye berisi satu atau beberapa grup iklan, yang digunakan untuk mengelompokkan iklan ke dalam kumpulan yang logis.
Iklan grup iklan mewakili iklan yang Anda jalankan. Kecuali untuk kampanye aplikasi yang hanya dapat memiliki satu iklan grup iklan per grup iklan, setiap grup iklan berisi satu atau beberapa iklan grup iklan.
Anda dapat menyertakan satu atau beberapa AdGroupCriterion
atau CampaignCriterion
ke grup iklan atau
kampanye. Ketiganya mewakili kriteria yang menentukan cara iklan dipicu.
Ada banyak jenis kriteria, seperti kata kunci, rentang usia, dan lokasi. Kriteria yang ditentukan di tingkat kampanye memengaruhi semua resource lain dalam kampanye. Anda juga dapat menentukan anggaran dan tanggal seluruh kampanye.
Terakhir, Anda dapat melampirkan ekstensi di tingkat akun, kampanye, atau grup iklan. Ekstensi memungkinkan Anda memberikan informasi tambahan ke iklan, seperti nomor telepon, alamat, atau promosi.
Referensi
Resource mewakili entitas dalam akun Google Ads Anda. Campaign
dan AdGroup
adalah dua contoh
resource.
ID Objek
Setiap objek di Google Ads diidentifikasi berdasarkan ID-nya sendiri. Beberapa ID ini unik secara global di semua akun Google Ads, sementara yang lain hanya unik dalam cakupan terbatas.
ID Objek | Cakupan Keunikan | Unik secara Global? |
---|---|---|
ID Anggaran | Global | Ya |
ID kampanye | Global | Ya |
Nomor Grup Iklan | Global | Ya |
ID iklan | Grup Iklan | Tidak, tetapi pasangan (AdGroupId , AdId ) unik secara global |
ID Kriteria GrupIklan | Grup Iklan | Tidak, tetapi pasangan (AdGroupId , CriterionId ) unik secara global |
ID Kriteria Kampanye | Kampanye | Tidak, tetapi pasangan (CampaignId , CriterionId ) unik secara global |
Ekstensi Iklan | Kampanye | Tidak, tetapi pasangan (CampaignId , AdExtensionId ) unik secara global |
ID Feed | Global | Ya |
ID Item Feed | Global | Ya |
ID Atribut Feed | Feed | Tidak |
ID Pemetaan Feed | Global | Ya |
ID Label | Global | Ya |
ID DaftarPengguna | Global | Ya |
Aturan ID ini dapat berguna saat mendesain penyimpanan lokal untuk objek Google Ads Anda.
Beberapa objek dapat digunakan untuk beberapa jenis entity. Dalam kasus tersebut, objek
berisi kolom type
yang menjelaskan kontennya. Misalnya,
AdGroupAd
dapat merujuk pada objek seperti iklan teks,
iklan hotel, atau iklan lokal. Nilai ini dapat diakses melalui
kolom AdGroupAd.ad.type
, dan menampilkan nilai dalam
enum AdType
.
Nama resource
Setiap resource diidentifikasi secara unik oleh string resource_name
, yang
menggabungkan resource dan induknya ke dalam sebuah jalur. Misalnya, nama resource
kampanye memiliki bentuk:
customers/customer_id/campaigns/campaign_id
Jadi, untuk kampanye dengan ID 987654
di akun Google Ads dengan ID pelanggan 1234567
, resource_name
adalah:
customers/1234567/campaigns/987654
Layanan
Layanan memungkinkan Anda mengambil dan mengubah entitas Google Ads Anda. Ada tiga jenis layanan: modifikasi, pengambilan objek dan statistik, serta layanan pengambilan metadata.
Mengubah (mutate) objek
Layanan ini mengubah instance dari jenis resource yang terkait menggunakan permintaan
mutate
. Contoh ini juga menyediakan permintaan get
yang mengambil satu instance
resource, yang dapat berguna untuk memeriksa struktur resource.
Contoh layanan:
CustomerService
untuk mengubah pelanggan.CampaignService
untuk mengubah kampanye.AdGroupService
untuk mengubah grup iklan.
Setiap permintaan mutate
harus menyertakan objek operation
yang sesuai. Misalnya, metode CampaignService.MutateCampaigns
mengharapkan satu atau beberapa
instance CampaignOperation
. Lihat Mengubah dan Memeriksa Objek untuk diskusi terperinci tentang operasi.
Mutasi serentak
Objek Google Ads tidak dapat diubah secara serentak oleh lebih dari satu sumber. Hal ini dapat menyebabkan error jika ada beberapa pengguna yang mengupdate objek yang sama dengan aplikasi Anda, atau jika Anda mengubah objek Google Ads secara paralel menggunakan beberapa thread. Hal ini termasuk mengupdate objek dari beberapa thread dalam aplikasi yang sama, atau dari aplikasi yang berbeda (misalnya aplikasi Anda dan sesi UI Google Ads yang bersamaan).
API tidak menyediakan cara untuk mengunci objek sebelum update; jika dua sumber
mencoba memutasikan objek secara bersamaan, API akan memunculkan
DatabaseError.CONCURRENT_MODIFICATION_ERROR
.
Mutasi asinkron versus sinkron
Metode mutasi Google Ads API bersifat sinkron. Panggilan API hanya menampilkan respons setelah objek dimutasi, sehingga Anda harus menunggu respons atas setiap permintaan. Meskipun pendekatan ini relatif mudah untuk dikodekan, pendekatan ini dapat berdampak negatif pada load balancing dan membuang resource jika proses dipaksa untuk menunggu panggilan selesai.
Pendekatan alternatifnya adalah memutasikan objek secara asinkron menggunakan
BatchJobService
, yang menjalankan batch
operasi pada beberapa layanan tanpa menunggu selesai. Setelah tugas batch dikirimkan, server Google Ads API mengeksekusi operasi secara asinkron, sehingga proses tersebut membebaskan proses untuk melakukan operasi lainnya. Anda dapat memeriksa status tugas secara berkala untuk menyelesaikan tugas.
Lihat panduan Batch Processing untuk mengetahui informasi selengkapnya tentang pemrosesan asinkron.
Validasi mutasi
Sebagian besar permintaan mutasi dapat divalidasi tanpa benar-benar mengeksekusi panggilan terhadap data nyata. Anda dapat menguji permintaan untuk parameter yang tidak ada dan nilai kolom yang salah tanpa benar-benar menjalankan operasi.
Untuk menggunakan fitur ini, setel kolom boolean validate_only
opsional permintaan ke
true
. Permintaan kemudian akan divalidasi sepenuhnya seolah-olah akan
dieksekusi, tetapi eksekusi akhir dilewati. Jika tidak ditemukan error, respons kosong akan ditampilkan. Jika validasi gagal, pesan error dalam respons akan
menunjukkan titik kegagalan.
validate_only
sangat berguna dalam menguji iklan untuk mengetahui pelanggaran kebijakan
umum. Iklan akan otomatis ditolak jika melanggar kebijakan seperti
mengandung kata-kata, tanda baca, kapitalisasi, atau panjang tertentu. Satu iklan yang tidak baik dapat menyebabkan seluruh batch gagal. Menguji iklan baru dalam permintaan validate_only
dapat menemukan pelanggaran tersebut. Lihat contoh kode untuk menangani
error pelanggaran kebijakan guna melihat
cara kerjanya.
Dapatkan objek dan statistik performa
GoogleAdsService
adalah layanan tunggal dan terpadu
untuk mengambil objek dan statistik performa.
Semua permintaan Search
dan SearchStream
untuk GoogleAdsService
memerlukan kueri yang menentukan resource yang akan dikueri, atribut resource dan metrik performa yang akan diambil, predikat yang akan digunakan untuk memfilter permintaan, dan segmen yang akan digunakan untuk menguraikan statistik performa lebih lanjut. Untuk informasi format kueri lebih lanjut, lihat panduan Bahasa Kueri Google Ads.
Mengambil metadata
GoogleAdsFieldService
mengambil
metadata tentang resource di Google Ads API, seperti atribut yang tersedia untuk
resource dan jenis datanya.
Layanan ini memberikan informasi yang diperlukan dalam membuat kueri untuk
GoogleAdsService
. Untuk memudahkan, informasi yang ditampilkan oleh
GoogleAdsFieldService
juga tersedia
di dokumentasi referensi kolom.