Method: advertisers.list

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

Sıra, orderBy parametresiyle tanımlanır.

Tek bir partnerId gereklidir. İş ortakları arasında listeleme desteklenmez.

HTTP isteği

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

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

Sorgu parametreleri

Parametreler
partnerId

string (int64 format)

Zorunlu. Getirilen reklamverenlerin ait olması gereken iş ortağının kimliği. Sistem, aynı anda yalnızca bir iş ortağının reklamverenlerinin listelenmesini destekler.
pageSize

integer

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

string

Sunucunun döndürmesi gereken sonuç sayfasını tanımlayan bir jeton. Bu genellikle advertisers.list yöntemine yapılan ö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 edilen değerler şunlardır:

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

Varsayılan sıralama düzeni artandır. Bir alan için azalan sırayı belirtmek üzere alan adına "desc" soneki eklenmelidir. Örneğin, displayName desc.
filter

string

Reklamveren alanlarına göre filtreleme yapılmasına olanak tanır.

Desteklenen söz dizimi:

  • Filtre ifadeleri bir veya daha fazla kısıtlamadan oluşur.
  • Kısıtlamalar, AND veya OR mantıksal operatörleriyle birleştirilebilir.
  • Kısıtlama, {field} {operator} {value} biçimindedir.
  • updateTime alanı, GREATER THAN OR EQUAL TO (>=) veya LESS THAN OR EQUAL TO (<=) operatörlerini kullanmalı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çimi) küçük veya bu değere 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 karakteri aşmamalıdır.

Daha fazla bilgi için filtre LIST istekleri kılavuzumuza bakın.

İ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.

Liste boşsa gösterilmez.
nextPageToken

string

Sonuçların sonraki sayfasını almak için kullanılan jeton. Sonraki sonuç sayfasını almak için advertisers.list yöntemine yapılan sonraki çağrıda bu değeri 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.