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ı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 hepsinin ait olması gereken iş ortağının kimliği. Sistem, aynı anda yalnızca bir iş ortağı için reklamveren listelemeyi 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 bir sonuç sayfasını tanımlayan jeton. Bu genellikle, advertisers.list yöntemine yapılan önceki çağrıdan döndürülen nextPageToken değerini ifade eder. Belirtilmezse sonuçların ilk sayfası döndürülür.

orderBy

string

Listeyi sıralamak için kullanılacak alan. Kabul edilen değerler şunlardır:

  • displayName (varsayılan)
  • entityStatus
  • updateTime

Varsayılan sıralama düzeni artan düzendir. Bir alan için azalan sıra 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ı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 alanlar EQUALS (=) operatörünü kullanmalı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 (ISO 8601 biçimi) veya daha az olan tüm reklamverenler: updateTime<="2020-11-04T18:54:47Z"
  • Güncelleme zamanı 2020-11-04T18:54:47Z (ISO 8601 biçimi) veya daha büyük olan tüm reklamverenler: updateTime>="2020-11-04T18:54:47Z"

Bu alanın uzunluğu en fazla 500 karakter olmalıdır.

Daha fazla bilgi için LIST isteklerini filtreleme 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.

Boşsa bu liste bulunmaz.

nextPageToken

string

Sonuçların sonraki sayfasını almak için jeton. Sonuçların bir sonraki sayfasını almak için advertisers.list yönteminin sonraki çağrısında 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'a Genel Bakış başlıklı makaleyi inceleyin.