Method: advertisers.campaigns.list

Bir reklamverendeki kampanyaları listeler.

Sıra, orderBy parametresiyle tanımlanır. filter x entityStatus belirtilmemişse ENTITY_STATUS_ARCHIVED içeren kampanyalar sonuçlara dahil edilmez.

HTTP isteği

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns

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

Yol parametreleri

Parametreler
advertiserId

string (int64 format)

Kampanyaların listeleneceği reklamverenin kimliği.

Sorgu parametreleri

Parametreler
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 campaigns.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:

  • displayName (varsayılan)
  • 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. Örnek: displayName desc.
filter

string

Kampanya 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. Bir kısıtlama dizisi örtülü olarak AND kullanır.
  • 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:

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

Örnekler:

  • Bir reklamverenin altındaki tüm ENTITY_STATUS_ACTIVE veya ENTITY_STATUS_PAUSED kampanyalar: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Güncelleme zamanı 2020-11-04T18:54:47Z'den (ISO 8601 biçimi) küçük veya bu değere eşit olan tüm kampanyalar: 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 kampanyalar: 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 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
Alanlar
campaigns[]

object (Campaign)

Kampanya 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 campaigns.list yöntemine yapılan sonraki çağrıda bu değeri pageToken alanına iletin.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

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