Method: advertisers.list

Geçerli kullanıcının erişebildiği reklamverenleri listeler.

Sıralama, orderBy parametresi tarafından tanımlanır.

Tek bir partnerId gereklidir. İş ortakları arası giriş desteklenmiyor.

HTTP isteği

GET https://displayvideo.googleapis.com/v4/advertisers

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Sorgu parametreleri

Parametreler
partnerId

string (int64 format)

Zorunlu. Getirilen reklamverenlerin ait olduğu iş ortağının kimliği. Sistem, aynı anda yalnızca bir iş ortağı için reklamverenlerin listelenmesini destekler.
pageSize

integer

İstenen sayfa boyutu. 1 ile 200 arasında olmalıdır. Belirtilmemişse varsayılan olarak 100 olur.
pageToken

string

Sunucunun döndürmesi gereken sonuçların yer aldığı sayfayı tanımlayan jeton. Genellikle bu, advertisers.list yöntemine önceki çağrıdan döndürülen nextPageToken değeridir. Belirtilmezse sonuçların ilk sayfası döndürülür.
orderBy

string

Listenin sıralanacağı alan. Kabul edilebilir değerler şunlardır:

  • advertiserId (varsayılan)
  • displayName
  • entityStatus
  • updateTime

Varsayılan sıralama düzeni artan düzendir. Bir alana yönelik azalan sırayı belirtmek için alan adına "azalan" son eki eklenmelidir. Örneğin, displayName desc.
filter

string

Reklamveren alanlarına göre filtrelemeye izin verir.

Desteklenen söz dizimi:

  • Filtre ifadeleri, bir veya daha fazla kısıtlamadan oluşur.
  • Kısıtlamalar, AND veya OR mantıksal operatörleri ile birleştirilebilir.
  • Kısıtlamalar {field} {operator} {value} biçimindedir.
  • updateTime alanında GREATER THAN OR EQUAL TO (>=) veya LESS THAN OR EQUAL TO (<=) operatörleri kullanılmalıdır.
  • Diğer tüm alanlarda EQUALS (=) operatörü kullanılmalıdır.

Desteklenen alanlar:

  • advertiserId
  • displayName
  • entityStatus
  • updateTime (ISO 8601 biçiminde giriş veya YYYY-MM-DDTHH:MM:SSZ)

Örnekler:

  • Bir iş ortağı altındaki tüm etkin reklamverenler: entityStatus="ENTITY_STATUS_ACTIVE"
  • Güncelleme zamanı 2020-11-04T18:54:47Z'den (ISO 8601 biçiminde) küçük veya buna eşit olan tüm reklamverenler: updateTime<="2020-11-04T18:54:47Z"
  • Güncelleme zamanı 2020-11-04T18:54:47Z'den (ISO 8601 biçimi) büyük veya bu değere eşit olan tüm reklamverenler: updateTime>="2020-11-04T18:54:47Z"

Bu alanın uzunluğu 500 karakterden fazla olmamalıdır.

Daha fazla bilgi için filtre LIST istekleri kılavuzumuzu inceleyin.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "advertisers": [
    {
      object (Advertiser)
    }
  ],
  "nextPageToken": string
}
Alanlar
advertisers[]

object (Advertiser)

Reklamverenlerin listesi.

Boşsa bu liste mevcut olmayacak.
nextPageToken

string

Sonuçların sonraki sayfasını almak için jeton. Sonraki sonuç sayfasını almak için bu değeri, advertisers.list yöntemine yapılan bir sonraki çağrıda pageToken alanına iletin.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/display-video

Daha fazla bilgi için OAuth 2.0 Overview sayfasına bakın.