Mengubah dan Memeriksa Objek

Tujuan: Memahami cara mengubah dan memeriksa objek menggunakan Google Ads API.

Seperti yang dibahas dalam panduan struktur API, setiap resource level teratas di Google Ads API memiliki layanan khusus jenis resource terkait 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.

Istilah Penting: Resource level teratas adalah resource yang namanya tidak menyertakan titik (.). Misalnya, Campaign adalah resource level teratas, tetapi Campaign.NetworkSettings bukan.

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 berubah atau hanya nama resource yang harus ditampilkan setelah mutasi.

Misalnya, metode MutateCampaigns CampaignService menerima MutateCampaignsRequest yang terdiri dari:

• customerId
• Kumpulan objek CampaignOperation
• Kolom response_content_type yang menunjukkan jenis respons yang diinginkan.

Operations

Objek operasi seperti CampaignOperation memungkinkan Anda menentukan tindakan yang ingin dilakukan pada satu resource dengan menetapkan kolom operation. Kolom ini adalah salah satu kolom yang terdiri dari atribut berikut yang jenisnya adalah jenis resource:

create

Membuat instance resource baru.

update

Mengupdate resource agar cocok 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 update. Setiap library klien memiliki metode utilitas atau bantuan yang akan menghasilkan update_mask untuk Anda, seperti yang ditunjukkan di 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 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 satu MutateCampaignsRequest 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, respons hanya akan berisi kolom yang dapat diubah di kampanye. Anda kemudian dapat membuat mutasi lanjutan 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.

Peringatan: get tidak lagi didukung. Gunakan search atau searchStream untuk mengambil objek sebagai gantinya.

Memeriksa objek dengan get (Tidak digunakan lagi)

Selain mengubah objek, setiap layanan khusus jenis resource juga memiliki metode get untuk mengambil semua atribut dari resource tunggal. Metode ini menerima permintaan get yang atribut satu-satunya adalah resource_name.

Poin Penting: Gunakan dapatkan secukupnya.

Metode get adalah kemudahan yang ditawarkan oleh Google Ads API untuk mempermudah pengambilan semua atribut dari satu objek. Meskipun alat ini efektif untuk mempelajari API atau memeriksa setiap objek untuk tujuan proses debug atau pendidikan, aplikasi Anda tidak boleh menggunakan metode get guna mengambil objek untuk pemrosesan atau pelaporan. Sebagai gantinya, gunakan GoogleAdsService, karena memungkinkan Anda mengambil atribut objek tertentu saja, mendukung pengambilan metrik performa, dan memungkinkan streaming melalui kumpulan hasil yang besar. Jika aplikasi Anda mengirimkan permintaan get dalam jumlah besar, Anda mungkin akan menghadapi batas kapasitas.