Method: advertisers.campaigns.list

Bir reklamverenin kampanyalarını listeler.

Sıralama, orderBy parametresi tarafından tanımlanır. filter ile entityStatus arasında bir değer belirtilmezse 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ın listeleneceği reklamverenin kimliği.

Sorgu parametreleri

Parametreler
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 bir sonuç sayfasını tanımlayan jeton. Genellikle bu, campaigns.list yöntemine yapılan önceki çağrıdan döndürülen nextPageToken değerini ifade eder. Belirtilmemişse 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. Ö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. Kısıtlama dizisi, AND değerini dolaylı olarak kullanır.
  • 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:

  • 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 (ISO 8601 biçimi) veya daha az olan tüm kampanyalar: 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 kampanyalar: 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 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
Alanlar
campaigns[]

object (Campaign)

Kampanya listesi.

Boşsa bu liste gösterilmez.
nextPageToken

string

Sonuçların bir sonraki sayfasını almak için kullanılan jeton. Sonuçların bir sonraki sayfasını almak için campaigns.list yönteminin sonraki çağrısında pageToken alanında bu değeri 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.