GoogleAdsService
adalah layanan pengambilan dan pelaporan
objek terpadu dari Google Ads API. Layanan memiliki metode yang:
- Mengambil atribut tertentu dari objek.
- Mengambil metrik performa untuk objek berdasarkan rentang tanggal.
- Mengurutkan objek berdasarkan atributnya.
- Gunakan kondisi untuk menunjukkan objek yang ingin Anda tampilkan dalam respons.
- Batasi jumlah objek yang ditampilkan.
GoogleAdsService
dapat menampilkan hasil dengan
dua cara:
GoogleAdsService.SearchStream
menampilkan semua baris dalam satu respons streaming yang lebih efisien untuk kumpulan hasil yang besar (lebih dari 10.000 baris). Cara ini mungkin lebih tepat jika aplikasi batch Anda ingin mendownload data sebanyak mungkin secepat mungkin.GoogleAdsService.Search
membagi respons besar menjadi halaman hasil yang mudah dikelola. Cara ini bisa lebih sesuai jika aplikasi interaktif Anda menampilkan halaman hasil pada satu waktu.
Pelajari lebih lanjut paging versus streaming.
Buat permintaan
Metode penelusuran memerlukan
SearchGoogleAdsRequest
, yang terdiri
dari atribut berikut:
customer_id
query
Bahasa Kueri Google Ads yang menunjukkan resource mana yang akan dikueri, atribut, segmen, dan metrik yang akan diambil, serta kondisi yang digunakan untuk membatasi objek yang ditampilkan- (Khusus
GoogleAdsService.Search
) Apage_size
untuk menunjukkan jumlah objek yang akan ditampilkan dalam satu respons saat menggunakan paging. - (Khusus
GoogleAdsService.Search
)page_token
opsional untuk mengambil batch hasil berikutnya saat menggunakan paging.
Untuk informasi lebih lanjut tentang Bahasa Kueri Google Ads, lihat panduan Bahasa Kueri Google Ads.
Memproses respons
GoogleAdsService
menampilkan daftar
objek GoogleAdsRow
.
Setiap GoogleAdsRow
mewakili objek yang ditampilkan oleh kueri, dan terdiri dari
sekumpulan atribut yang diisi berdasarkan kolom yang diminta dalam
klausa SELECT
. Atribut yang tidak disertakan dalam klausa SELECT
tidak
diisi pada objek GoogleAdsRow
dalam respons.
Misalnya, meskipun ad_group_criterion
memiliki atribut status
, kolom
status
dari atribut ad_group_criterion
baris tidak akan diisi sebagai
respons untuk kueri yang klausa SELECT
-nya tidak menyertakan
ad_group_criterion.status
. Demikian pula, atribut campaign
baris
tidak diisi jika klausa SELECT
tidak menyertakan kolom apa pun dari
resource campaign
.
Setiap GoogleAdsRow
dapat memiliki atribut dan metrik yang berbeda dari baris lain
dalam kumpulan hasil yang sama. Dengan demikian, baris tersebut harus dilihat sebagai objek, bukan
baris tetap dari tabel.
Jenis enum TIDAK DIKETAHUI
Resource yang ditampilkan dengan jenis UNKNOWN
tidak sepenuhnya didukung dalam
versi API tersebut. Referensi ini dapat dibuat melalui antarmuka lain seperti UI Google Ads. Anda dapat memilih metrik saat resource memiliki
jenis UNKNOWN
, tetapi Anda tidak dapat mengubah resource melalui API. Contohnya
adalah kampanye atau iklan baru yang diperkenalkan di UI, tetapi
tidak didukung dalam versi API yang Anda minta.
Berikut ini beberapa pertimbangan yang harus diperhatikan:
- Resource dengan jenis
UNKNOWN
dapat didukung nanti atau tetapUNKNOWN
tanpa batas. - Objek baru dengan jenis
UNKNOWN
dapat muncul kapan saja. Objek ini kompatibel dengan versi sebelumnya karena nilai enum sudah tersedia. Resource diperkenalkan dengan perubahan ini saat tersedia sehingga Anda memiliki tampilan akun yang akurat. ResourceUNKNOWN
dapat muncul karena aktivitas baru di akun Anda melalui antarmuka lain, atau saat resource tidak lagi didukung. - Resource
UNKNOWN
dapat memiliki metrik mendetail yang disertakan pada resource tersebut dan dapat dikueri. - Resource
UNKNOWN
biasanya terlihat sepenuhnya di UI Google Ads. - Resource
UNKNOWN
umumnya tidak dapat dimutasi.
Segmentasi
Responsnya akan berisi satu GoogleAdsRow
untuk setiap kombinasi berikut:
- Instance resource utama yang ditentukan dalam klausa
FROM
- Nilai setiap kolom
segment
yang dipilih
Misalnya, respons untuk kueri yang memilih FROM campaign
dan memiliki segments.ad_network_type
dan segments.date
di klausa SELECT
akan berisi satu baris untuk setiap kombinasi berikut:
campaign
segments.ad_network_type
segments.date
Hasil disegmentasikan secara implisit berdasarkan setiap instance resource utama, bukan menurut nilai masing-masing kolom yang dipilih. Misalnya,
SELECT campaign.status, metrics.impressions
FROM campaign
WHERE segments.date DURING LAST_14_DAYS
menghasilkan satu baris per kampanye, bukan satu baris per nilai yang berbeda dari
kolom campaign.status
.