Method: advertisers.campaigns.list

Bir reklamverendeki kampanyaları listeler.

Sıra, orderBy parametresiyle tanımlanır. entityStatus ölçütüne ait bir filter belirtilmezse ENTITY_STATUS_ARCHIVED içeren kampanyalar sonuçlara dahil edilmez.

HTTP isteği

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

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

Yol parametreleri

Parametreler
advertiserId

string (int64 format)

Kampanyaları 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 bir jeton. Genellikle bu, 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 edilebilir değerler şunlardır:

  • displayName (varsayılan)
  • entityStatus
  • updateTime

Varsayılan sıralama düzeni artan düzendedir. Bir alanın azalan sırasını belirtmek için alan adına "azalan" son eki eklenmelidir. Ö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ı yoldan 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 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 reklamveren altındaki ENTITY_STATUS_ACTIVE veya ENTITY_STATUS_PAUSED kampanyanın tümü: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Güncelleme zamanı şu veya bu süreye eşit olan tüm kampanyalar: 2020-11-04T18:54:47Z (ISO 8601 biçimi): updateTime<="2020-11-04T18:54:47Z"
  • Güncelleme zamanı şu veya bu süreye eşit olan tüm kampanyalar: 2020-11-04T18:54:47Z (ISO 8601 biçimi): updateTime>="2020-11-04T18:54:47Z"

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

Daha fazla bilgi edinmek 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)

Kampanya listesi.

Boş bırakılırsa bu liste görünmez.
nextPageToken

string

Sonraki sonuç sayfasını almak için jeton. Sonraki sonuç sayfasını almak için bu değeri, campaigns.list yöntemine yapılan sonraki çağrıdaki pageToken alanına geçirin.

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'a Genel Bakış başlıklı makaleye bakın.