Method: advertisers.campaigns.list

Bir reklamverendeki kampanyaları listeler.

Sıralama, orderBy parametresi tarafından tanımlanır. entityStatus tarafından sağlanan filter belirtilmezse ENTITY_STATUS_ARCHIVED içeren kampanyalar sonuçlara dahil edilmez.

HTTP isteği

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

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

Yol parametreleri

Parametreler
advertiserId

string (int64 format)

Kampanyalarını listelenecek 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 sonuçların yer aldığı sayfayı tanımlayan jeton. Genellikle bu, campaigns.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:

  • displayName (varsayılan)
  • entityStatus
  • updateTime

Varsayılan sıralama düzeni artan düzendir. Bir alan için azalan sırayı belirtmek için "desc" son eki alan adına eklenmesi gerekir. Örnek: displayName desc.
filter

string

Kampanya 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. Bir dizi kısıtlama, dolaylı olarak AND 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 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 reklamveren 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çiminde) 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çiminde) 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 karakterden uzun 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 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
Alanlar
campaigns[]

object (Campaign)

Kampanyaların listesi.

Boşsa bu liste bulunmayacak.
nextPageToken

string

Sonuçların sonraki sayfasını almak için jeton. Sonraki sonuç sayfasını almak için bu değeri, campaigns.list yöntemine yapılan bir sonraki çağrıda 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 (OAuth 2.0'a Genel Bakış) sayfasına göz atın.