Seperti yang dibahas dalam panduan struktur API, setiap resource tingkat atas di Google Ads API memiliki layanan khusus jenis resource yang sesuai yang mendukung:
- Mengubah instance resource
- Mengambil satu instance resource untuk diperiksa
Panduan ini akan menggunakan CampaignService
untuk
mendemonstrasikan pengubahan dan pemeriksaan objek Campaign
, tetapi konsep yang sama berlaku untuk semua layanan khusus jenis
resource lainnya.
Mengubah objek
Setiap layanan khusus jenis resource akan memiliki metode mutate yang menerima permintaan mutasi. Permintaan ini terdiri dari:
customerId
- Sekumpulan operasi
- Setelan jenis konten respons yang menentukan apakah resource yang dapat berubah atau hanya nama resource yang harus ditampilkan setelah mutasi.
Misalnya, metode MutateCampaigns
dari CampaignService
menerima
MutateCampaignsRequest
yang terdiri
dari:
customerId
- Kumpulan objek
CampaignOperation
- Kolom
response_content_type
yang menunjukkan jenis respons pilihan.
Operasi
Objek operasi seperti CampaignOperation
memungkinkan Anda menentukan
tindakan yang ingin dilakukan pada satu resource dengan menetapkan kolom
operation
-nya. Kolom ini adalah salah satu kolom
yang terdiri dari atribut berikut yang jenisnya adalah jenis resource:
create
- Membuat instance baru dari resource.
update
- Memperbarui resource agar cocok dengan atribut resource
update
. Jika kolom ini ditetapkan, Anda juga harus menetapkanupdate_mask
operasi, yang memberi tahu Google Ads API atribut mana yang perlu diubah selama operasi update. Setiap library klien memiliki utilitas atau metode helper yang akan menghasilkanupdate_mask
untuk Anda, seperti yang didemonstrasikan di library klien. remove
- Menghapus referensi.
Karena kolom operation
adalah kolom oneof
, Anda tidak dapat menggunakan satu
operasi untuk mengubah beberapa objek. Misalnya, jika Anda ingin membuat satu kampanye dan menghapus kampanye lain, tambahkan dua instance CampaignOperation
ke permintaan Anda: satu dengan create
yang ditetapkan, dan satu lagi dengan remove
yang ditetapkan.
Operasi pengelompokan
Meskipun satu operasi hanya dapat membuat, memperbarui, atau menghapus satu resource, satu permintaan mutasi dapat berisi beberapa operasi. Sebaiknya Anda menggabungkan operasi menjadi satu permintaan mutate, bukan mengirim beberapa permintaan mutasi yang masing-masing berisi satu operasi.
Misalnya, jika ingin membuat sepuluh kampanye, Anda harus mengirim satu MutateCampaignsRequest
yang memiliki sepuluh objek CampaignOperation
.
Mutasi respons
Yang ditampilkan dalam respons bergantung pada apa yang dikirim dalam
response_content_type
permintaan mutasi. Misalnya, jika MUTABLE_RESOURCE
ditentukan, respons hanya akan berisi
kolom yang dapat diubah dalam kampanye. Selanjutnya, Anda dapat membuat mutasi tindak lanjut pada
objek resource tersebut tanpa harus merekonstruksinya.
Mutasi error
Operasi dalam permintaan mutasi tertentu hanya akan diterapkan ke akun Google Ads Anda jika setiap operasi dalam permintaan berhasil. Lihat panduan error umum untuk mengetahui daftar error umum dan cara mengatasinya.
Memeriksa objek dengan get (Tidak digunakan lagi)
Selain mengubah objek, setiap layanan khusus jenis resource juga memiliki metode get untuk mengambil semua atribut resource tunggal.
Metode ini menerima permintaan get yang atributnya hanya resource_name
.
Metode get adalah kemudahan yang ditawarkan oleh Google Ads API untuk memudahkan pengambilan semua atribut dari satu objek. Meskipun ini adalah alat yang bagus untuk
mempelajari API atau memeriksa masing-masing objek untuk tujuan proses debug atau
pendidikan, aplikasi Anda tidak boleh menggunakan metode get guna mengambil objek untuk diproses
atau pelaporan. Sebagai gantinya, gunakan GoogleAdsService
karena hanya memungkinkan Anda mengambil
atribut objek tertentu, mendukung pengambilan metrik performa, dan
memungkinkan streaming melalui kumpulan hasil yang besar. Jika aplikasi Anda mengirimkan
banyak permintaan get, Anda mungkin akan mengalami pembatasan kapasitas.