Mengubah dan Memeriksa Objek

Seperti yang dibahas dalam Panduan struktur API, setiap resource level teratas 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 menunjukkan cara memodifikasi dan memeriksa objek Campaign, tetapi konsep yang sama berlaku untuk semua layanan khusus jenis resource lainnya.

Mengubah objek

Setiap layanan khusus jenis resource akan memiliki metode mutasi yang menerima permintaan mutasi. Permintaan ini terdiri dari:

  • customerId
  • Kumpulan operasi
  • Setelan jenis konten respons yang menentukan apakah resource yang dapat berubah atau hanya nama resource 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 menyetel kolom operation. Kolom ini adalah salah satu kolom yang terdiri dari atribut-atribut berikut yang merupakan jenis resource:

create
Membuat instance resource baru.
update
Memperbarui resource agar cocok dengan atribut resource update. Saat kolom ini ditetapkan, Anda juga harus menetapkan update_mask operasi, yang memberi tahu Google Ads API atribut mana yang akan diubah selama operasi update. Setiap library klien memiliki metode utilitas atau helper yang akan menghasilkan update_mask untuk Anda, seperti yang didemonstrasikan 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 lainnya, tambahkan dua instance CampaignOperation ke permintaan: satu dengan create yang ditetapkan, dan satu lagi dengan remove.

Operasi pembuatan batch

Meskipun satu operasi hanya dapat membuat, mengupdate, atau menghapus satu resource, satu permintaan mutasi dapat berisi beberapa operasi. Anda harus menggabungkan operasi Anda menjadi satu permintaan mutasi, bukan mengirim beberapa permintaan mutasi yang masing-masing berisi satu operasi.

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

Mutasi respons

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

Mutasi error

Operasi dalam permintaan mutasi tertentu hanya akan diterapkan ke akun Google Ads 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 dari satu resource. 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 setiap objek untuk tujuan proses debug atau pendidikan, aplikasi Anda tidak boleh menggunakan metode mendapatkan untuk mengambil objek untuk pemrosesan atau pelaporan. Sebagai gantinya, gunakan GoogleAdsService, karena metode ini hanya memungkinkan Anda mengambil atribut tertentu dari objek, mendukung pengambilan metrik performa, dan memungkinkan streaming melalui kumpulan hasil yang besar. Jika aplikasi Anda mengirimkan sejumlah besar permintaan get, Anda mungkin mengalami batas kapasitas.