Mengubah dan Memeriksa Objek

Seperti yang telah dibahas dalam panduan struktur API, setiap resource tingkat 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 mengubah 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 mutate yang menerima permintaan mutasi. Permintaan ini terdiri dari:

• customerId
• Kumpulan operasi
• Setelan jenis konten respons yang menentukan apakah resource yang dapat diubah atau hanya nama resource yang akan 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 yang lebih disukai.

Operasi

Objek operasi seperti CampaignOperation memungkinkan Anda menentukan tindakan yang ingin dilakukan pada satu resource dengan menetapkan 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 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 pembaruan. Setiap library klien memiliki metode utilitas atau 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 ditetapkan, dan satu lagi dengan remove ditetapkan.

Operasi pengelompokan

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

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

Mengubah 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. Kemudian, Anda dapat melakukan mutasi lanjutan pada objek resource tersebut tanpa harus merekonstruksinya.

Error mutasi

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 dari satu resource. Metode ini menerima permintaan get yang satu-satunya atributnya adalah resource_name.

Metode get adalah kemudahan yang ditawarkan oleh Google Ads API untuk mengambil 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 get untuk mengambil objek guna diproses atau dilaporkan. Sebagai gantinya, gunakan GoogleAdsService, karena memungkinkan Anda mengambil hanya atribut objek tertentu, mendukung pengambilan metrik performa, dan memungkinkan streaming melalui set hasil yang besar. Jika aplikasi Anda mengirimkan permintaan get dalam jumlah besar, Anda mungkin mengalami batas kapasitas.