Sayfaları numaralandırma

Ad Manager REST API, genellikle Liste'de olmak üzere veri toplamaları sağlar yöntemlerine göz atın. Koleksiyonlar isteğe bağlı olarak boyutlandırılabilir ve API'de sayfalara ayrılır. tıklayın.

Temel seviye

Koleksiyonlar için istek mesajları isteğe bağlı bir tam sayı pageSize alanı tanımlayarak döndürülecek maksimum sonuç sayısını belirtir.

pageSize ayarlanmazsa veya 0 değerine ayarlanırsa varsayılan değer olan 50 kullanılır. pageSize değeri maksimum sayfa boyutunu (1000) aşarsa API sayfa boyutunu 1.000 olarak ayarlayın. Negatif değerler INVALID_ARGUMENT hatasına neden olur.

API, istenen sayıdan daha az sonuç döndürebilir (sıfır dahil) sonuçlarında) gösterilir. nextPageToken alanını kullanarak, reklam grubunda ek sonuçlar olup olmadığını koleksiyonudur.

Koleksiyonların yanıt mesajları bir nextPageToken dizesi alanını tanımlar. Bu alan sonraki sayfayı almak için kullanılabilir. Koleksiyonun sonu şu olduğunda nextPageToken alanı boş olur: ulaştı. Bu, devam eden bir eğitimin sonuna ulaşıp ulaşmadığınızı belirlemenin koleksiyonudur.

Koleksiyonlar için istek mesajları isteğe bağlı bir dize pageToken alanı tanımlayın tıklayarak koleksiyonda bir sonraki sayfaya geçebilirsiniz. Sonraki sayfalar için yapılan istekte pageSize üzerinde değişiklik yapılmasına 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

Koleksiyonların yanıt mesajları, aşağıdakileri temsil eden bir tam sayı (totalSize) sağlar Filtreleme uygulandıktan sonraki toplam varlık sayısı. Bu alan yalnızca ve formdaki alan maskesi gibi).

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

Sipariş sonuçları

Koleksiyonlar için istek mesajları, belirtilecek bir dize orderBy alanı tanımlıyor tıklayın.

Değerler, virgülle ayrılmış bir alan listesi olmalıdır. Örnek: foo,bar. Varsayılan sıralama düzeni artan düzendir. Bir alana yönelik azalan sırayı belirtmek için desc son eki ekleyin; örneğin: foo desc, bar. Söz diziminde gereksiz boşluk karakterleri yoksayılır. orderBy değerleri foo, bar desc, foo , bar desc ve foo,bar desc öğelerinin tümü eşdeğerdir. Alt alanlar . karakteriyle (ör. foo.bar) belirtilir veya address.street.

Sıralama yalnızca temel alanlarda desteklenir.

Sonuçları atla

Sayfalara ayrılmış işlem yöntemleri, atlanacak tam sayı skip alanını tanımlar sonuç. Atlama değeri, atlanacak tek tek kaynakların sayısını ifade eder. sayfa sayısını değil.

Örneğin:

Sayfa jetonu olmayan ve atlama değeri 30 olan bir istek tek bir sayfa döndürür: 31'inci sonuçla başlar.

51. sonuca karşılık gelen bir sayfa jetonu içeren istek (ilk 50 sonuç döndürüldü) ve 30 olan atlama değeri, 81. sonuçtan başlayarak tek bir sonuç sayfası.

İmlecin reklam öğesinin bitişini atlamasına neden olan bir atlama değeri bir sonuç kümesiyse yanıt, "hayır" içermeyen boş bir sonuç kümesiyle birlikte 200 OK nextPageToken.