Ad Manager API, en yaygın olarak Listyöntemlerde olmak üzere veri koleksiyonları sağlar. Koleksiyonlar rastgele boyutlandırılabilir ve API yanıtlarında sayfalandırı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 pageSize tamsayı alanı tanımlar.
pageSize parametresini 1000 değerinden 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.
Kaynak referans belgelerine (ör. AdBreaks) bakın.
Kaynakla ilgili pageSize değeri için.
API, koleksiyonun sonunda olmasa bile istenen sayıdan daha az sonuç (sıfır sonuç dahil) döndürebilir. Koleksiyonda başka sonuç olup olmadığını belirlemek için nextPageToken alanının varlığını kullanın.
Koleksiyonlarla ilgili yanıt mesajları, bir dize nextPageToken alanı tanımlar. Bu alan, sonraki sayfayı almak için kullanılabilir. Koleksiyonun sonuna gelindiğinde nextPageToken alanı boş olur. Bir koleksiyonun sonuna ulaşıp ulaşmadığınızı belirlemenin tek yolu budur.
Koleksiyonlar için istek mesajları, koleksiyonda bir sonraki sayfaya geçmek üzere isteğe bağlı bir dize pageToken alanı tanımlar. Sonraki sayfalar için yapılan isteklerdeki pageSize değişikliklerine izin verilir. Diğer tüm bağımsız değişkenler aynı olmalıdır. Herhangi bir bağımsız değişken farklıysa API, 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
Koleksiyonlarla ilgili yanıt mesajları, filtreleme uygulandıktan sonraki toplam öğe 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
Sonuçları sıralama
Koleksiyonlar için istek mesajları, sıralama düzenini belirtmek üzere bir orderBy alanı tanımlar.
Değerler, virgülle ayrılmış alan listesi olmalıdır. Örneğin: foo,bar. Varsayılan sıralama düzeni artandır. Bir alan için azalan sıralama belirtmek üzere desc sonekini ekleyin. Örneğin: foo desc, bar. Söz dizimindeki gereksiz boşluk karakterleri yoksayılır. orderBy değerleri foo, bar desc, foo , bar desc ve foo,bar desc eşdeğerdir. Alt alanlar, . karakteriyle (ör. foo.bar veya address.street) belirtilir.
Sıralama yalnızca temel alanlarda desteklenir.
Sonuçları atlama
Sayfalandırılmış bir işlem için yöntemler, sonuçları atlamak üzere bir tam sayı skip alanı tanımlar. Atlama değeri, atlanacak tek tek kaynakların sayısını ifade eder, sayfa sayısını değil.
Örneğin:
Sayfa jetonu içermeyen ve atlama değeri 30 olan bir istek, 31. sonuçtan itibaren başlayan tek bir sonuç sayfası döndürür.
İlk 50 sonuç ilk sayfada döndürüldüğünden 51. sonuca karşılık gelen bir sayfa jetonu ve 30 atlama değeri içeren bir istek, 81. sonuçtan başlayan tek bir sonuç sayfası döndürür.
İmlecin sonuç koleksiyonunun sonunu geçmesine neden olan bir atlama değeri sağlanırsa yanıt, 200 OK ile boş bir sonuç kümesi olur ve nextPageToken olmaz.