Ad Manager API, çoğunlukla Listyöntemlerinde veri koleksiyonları sağlar. Koleksiyonlar istediğiniz boyutta olabilir ve API yanıtlarında sayfalara ayrılır.
Temel seviye
Koleksiyonlar için istek mesajları, döndürülecek maksimum sonuç sayısını belirtmek üzere isteğe bağlı bir tamsayı pageSize alanı tanımlar.
pageSize parametresini 1000'ten küçük pozitif bir sayıya ayarlayın. Herhangi bir değer ayarlamazsanız veya parametreyi sıfıra ayarlarsanız API, 50 varsayılan değerini kullanır. Parametreyi negatif bir değere ayarlarsanız API INVALID_ARGUMENT hatası döndürür.
Kaynağa özgü pageSize değeri için kaynak referans dokümanlarına (ör. AdBreaks) bakın.
API, koleksiyonun sonunda olmasa bile istenen sayıdan daha az sonuç döndürebilir (sıfır sonuç dahil). Koleksiyonda başka sonuç olup olmadığını belirlemek için nextPageToken alanının varlığını kullanın.
Koleksiyonlara yönelik yanıt mesajları, sonraki sayfayı almak için kullanılabilecek bir dize nextPageToken alanı tanımlar. Koleksiyonun sonuna ulaşıldığında nextPageToken alanı boş olur. Bir koleksiyonun sonuna ulaşıp ulaşmadığınızı belirlemenin tek yolu budur.
Koleksiyonlar için istek mesajları, koleksiyondaki bir sonraki sayfaya geçmek üzere isteğe bağlı bir dize pageToken alanı tanımlar. Sonraki sayfalar için istekteki pageSize değerinde değişiklik yapılmasına izin verilir. Diğer tüm bağımsız değişkenler aynı olmalıdır. Bağımsız değişkenlerden herhangi biri farklıysa API bir INVALID_ARGUMENT hatası döndürür.
Örnek
cURL
İlk istek
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500
{
"adUnits": [ ... ],
"nextPageToken": "eCGwAcs6hUerggzd2DGv"
}
Sonraki sayfa isteği
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500&pageToken=eCGwAcs6hUerggzd2DGv
{
"adUnits": [ ... ]
}
Toplam boyut
Koleksiyonlara yönelik yanıt mesajları, filtreleme uygulandıktan sonra toplam varlık sayısını temsil eden bir tam sayı totalSize sağlar. Bu alan yalnızca alan maskesinde istendiğinde doldurulur.
GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize
Sıralama sonuçları
Koleksiyonlar için istek mesajları, sıralama sırasını belirtmek üzere bir dize orderBy alanı tanımlar.
Değerler, virgülle ayrılmış bir alan listesi olmalıdır. Örneğin: foo,bar. Varsayılan sıralama düzeni artan düzendir. Bir alan için azalan sıra belirtmek üzere desc son eki ekleyin. Örneğin: foo desc, bar. Söz dizimi içindeki gereksiz boşluk karakterleri yoksayılır. orderBy değerleri foo, bar desc, foo , bar desc ve foo,bar desc birbirine eşdeğerdir. Alt alanlar, foo.bar veya address.street gibi bir . karakteriyle belirtilir.
Sıralama yalnızca ilkel alanlarda desteklenir.
Sonuçları atlama
Sayfaya ayrılmış işlem yöntemleri, sonuçları atlamak için bir tam sayı skip alanı tanımlar. Atlama değeri, sayfa sayısını değil, atlanacak tekil kaynakların sayısını ifade eder.
Örneğin:
Sayfa jetonu olmayan ve atlama değeri 30 olan bir istek, 31. sonuçtan itibaren tek bir sayfalık sonuç döndürür.
51. sonuca karşılık gelen bir sayfa jetonu (ilk 50 sonuç ilk sayfada döndürüldüğü için) ve 30 atlama değeri içeren bir istek, 81. sonuçtan itibaren tek bir sonuç sayfası döndürür.
İmlecin sonuç koleksiyonunun sonunu aşmasına neden olan bir atlama değeri sağlanırsa yanıt, nextPageToken içermeyen boş bir sonuç kümesiyle 200 OK olur.