Mengubah Objek

Seperti yang dibahas dalam panduan struktur API, setiap resource tingkat teratas di Google Ads API memiliki layanan khusus jenis resource yang sesuai yang mendukung modifikasi instance resource.

Panduan ini akan menggunakan CampaignService untuk mendemonstrasikan modifikasi 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 perubahan. Permintaan ini terdiri dari:

  • customerId
  • Kumpulan operasi
  • Setelan jenis konten respons yang menentukan apakah resource yang dapat diubah 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 Anda lakukan pada satu resource dengan menyetel kolom operation-nya. Kolom ini adalah kolom oneof yang terdiri dari atribut berikut yang jenisnya adalah jenis resource:

create
Membuat instance baru resource.
update
Memperbarui resource agar sesuai dengan atribut resource update. Jika kolom ini ditetapkan, Anda juga harus menetapkan update_mask operasi, yang memberi tahu Google Ads API atribut mana yang akan diubah selama operasi pembaruan. Setiap library klien memiliki utilitas atau metode helper yang akan membuat update_mask untuk Anda, seperti yang ditunjukkan dalam library klien kami.
remove
Menghapus resource.

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 batch

Meskipun satu operasi hanya dapat membuat, memperbarui, atau menghapus satu resource, satu permintaan perubahan dapat berisi beberapa operasi. Anda harus menggabungkan operasi ke dalam satu permintaan perubahan, bukan mengirim beberapa permintaan perubahan yang masing-masing berisi satu operasi.

Misalnya, jika Anda ingin membuat sepuluh kampanye, Anda harus mengirim satu MutateCampaignsRequest yang memiliki sepuluh objek CampaignOperation.

Respons mutasi

Apa yang ditampilkan dalam respons bergantung pada apa yang dikirim dalam response_content_type permintaan perubahan. Misalnya, jika MUTABLE_RESOURCE ditentukan, maka respons hanya akan berisi kolom yang dapat diubah dalam kampanye. Kemudian, Anda dapat membuat mutasi lanjutan pada objek resource tersebut tanpa harus merekonstruksinya.

Error perubahan

Operasi dalam permintaan perubahan tertentu hanya akan diterapkan ke akun Google Ads Anda jika setiap operasi dalam permintaan berhasil. Lihat panduan kesalahan umum untuk mengetahui daftar kesalahan umum dan cara mengatasinya.