Alan Maskeleri

Ad Manager REST API, kısmi okuma ve yazma işlemleri için alan maskelerini kullanır. Bu aktarılan veri miktarını sınırlayarak performansı artırmak Alan maskeleri alan adlarının virgülle ayrılmış bir listesiyle temsil edilir. Örneğin:

startTime,endTime,targeting.geoTargeting

Maskeleri oku

Okuma maskeleri, API yanıtında hangi alanların mevcut olduğunu kontrol eder. Hedeflerinize göre bir maskenizi iki şekilde okuyabilirsiniz:

  1. fields sorgu parametresi:

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

  2. X-Goog-FieldMask HTTP üst bilgisi:

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

Varsayılan okuma maskeleri

Bazı API yöntemleri, pahalı alanlar için varsayılan bir alan maskesi içerir. geri dönüyor. Liste yöntemleri bu duruma örnek olarak gösterilebilir. Varsayılan olarak totalSize girin.

Bu alanlar, alan maskesinde adla veya * joker karakterini kullanın.

Maskeleri güncelle

Maskeleri güncelle, güncellemede hangi alanların değişeceğini kontrol eder (PATCH) isteği gönderin. Bir güncelleme maskesi ayarlandığında yalnızca maskedeki alanlar güncellenir istek gövdesinde ayarlanan alanlardan bağımsız olarak otomatik olarak oluşturulur.

Güncelleme maskeleri, sorgu parametreleri olarak ayarlanır. Örneğin:

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

Alan geçişi

Alan maskeleri,. geçişidir. Bu, Filtreler.

Alan maskeleri her zaman yanıt nesnesine bağlıdır. Örneğin, LineItem okuma primaryGoal.units içerebilir. İlgili maske giriş için LineItems lineItems.primaryGoal.units.

Bir alanı bütün olarak veya alt alanlarından birini belirtebilirsiniz. Her ikisi primaryGoal ve primaryGoal.units geçerli.

Bu, yinelenen alanlar için de geçerlidir. Şunların LineItem alan maskesi: creativePlaceholders.size geçerlidir ve yalnızca size alanını içerir her CreativePlaceholder için.

Joker Karakterler

Alan maskeleri, iletideki tüm alanları belirten * karakterini destekler. Aşağıdaki örneklerde, listeleme sırasında joker karakter kullanımı gösterilmektedir Orders. Bu yöntem, şunları yapan bir varsayılan okuma maskesine sahiptir: total_size alanını dahil etmeyin.

Örnek Anlamı
* total_size dahil tüm alanları içerir
orders Yalnızca orders alanını ve tüm alt alanlarını içerir
orders.* Yalnızca orders alanını ve tüm alt alanlarını içerir

Geçersiz alanlar

Alan maskesi var olmayan bir değere işaret ederse API yanıt verir INVALID_ARGUMENT hata ile.