Mask Kolom

Ad Manager REST API menggunakan mask kolom untuk pembacaan dan penulisan sebagian. Hal ini dapat meningkatkan kinerja dengan membatasi jumlah data yang ditransfer. Mask kolom diwakili oleh daftar nama {i>field<i} yang dipisahkan koma. Contoh:

startTime,endTime,targeting.geoTargeting

Baca penyamaran

Masker baca mengontrol kolom mana yang ada dalam respons API. Anda dapat menyetel baca mask pada permintaan Anda dengan dua cara:

1. Parameter kueri fields:

   curl https://admanager.googleapis.com/v1/networks/123456/adUnits?fields=adUnits,nextPageToken,totalSize
   

2. Header HTTP X-Goog-FieldMask:

   curl -H "X-Goog-FieldMask: adUnits,nextPageToken,totalSize" \
       https://admanager.googleapis.com/v1/networks/123456/adUnits
   

Catatan: camelCase dan snake_case didukung dalam string mask kolom.

Masker baca default

Beberapa metode API menyertakan mask kolom default untuk kolom yang mahal untuk ditampilkan. Metode daftar adalah contohnya. Secara {i>default<i}, mereka tidak menyertakan totalSize kolom tersebut.

Kolom ini harus diminta secara eksplisit dalam mask kolom menurut nama atau menggunakan karakter pengganti *.

Perbarui mask

Mengupdate mask mengontrol kolom mana yang akan diubah dalam update (PATCH) permintaan. Saat mask pembaruan ditetapkan, hanya kolom dalam mask yang akan diperbarui terlepas dari kolom mana yang ditetapkan dalam isi permintaan.

Masker update ditetapkan sebagai parameter kueri. Contoh:

curl -X PATCH https://admanager.googleapis.com/v1/networks/1234/order/4567?updateMask=displayName

{i>Field traversal<i}

Mask kolom dapat menentukan kolom dalam entitas menggunakan karakter . untuk traversal. Ini adalah {i>syntax<i} yang sama dengan yang digunakan oleh Filter.

Mask kolom selalu relatif terhadap objek respons. Misalnya, {i>mask<i} untuk membaca LineItem mungkin menyertakan primaryGoal.units. Masker yang sesuai untuk listingan LineItems adalah lineItems.primaryGoal.units.

Anda dapat menentukan kolom secara keseluruhan atau salah satu subkolomnya. Keduanya primaryGoal dan primaryGoal.units valid.

Hal ini juga berlaku untuk kolom berulang. Mask kolom LineItem dari creativePlaceholders.size valid dan hanya berisi kolom size untuk setiap CreativePlaceholder.

Catatan: Mask kolom tidak mengizinkan akses ke elemen tertentu dari instance {i>field <i}berdasarkan indeks. Tindakan ini akan menghasilkan error INVALID_ARGUMENT.

Karakter pengganti

Peringatan: Menggunakan karakter pengganti dalam mask update tidak kompatibel dengan penerusan. Tujuan karakter pengganti akan menghapus kolom apa pun yang tidak diketahui klien Anda.

Mask kolom mendukung karakter * yang menunjukkan semua kolom dalam pesan. Contoh berikut menunjukkan penggunaan karakter pengganti saat listingan Orders. Metode ini memiliki mask baca default yang melakukan tidak menyertakan kolom total_size.

Contoh	Arti
*	Mencakup semua kolom, termasuk total_size
orders	Hanya menyertakan kolom orders dan semua subkolomnya
orders.*	Hanya menyertakan kolom orders dan semua subkolomnya

Bidang tidak valid

Jika mask kolom merujuk pada nilai yang tidak ada, API akan merespons dengan error INVALID_ARGUMENT.