Method: advertisers.campaigns.list

Bir reklamverendeki kampanyaları listeler.

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

HTTP isteği

GET https://displayvideo.googleapis.com/v5/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. Belirtilmezse varsayılan olarak 100 kullanılır.
pageToken

string

Sunucunun döndürmesi gereken sonuç sayfasını 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 edilen değerler şunlardır:

  • displayName (varsayılan)
  • entityStatus
  • updateTime

Varsayılan sıralama ölçütü artandır. Bir alan için azalan sıralama belirtmek istiyorsanız alan adına "desc" son eki 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 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 veya YYYY-MM-DDTHH:MM:SSZ olarak girin)

Ö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) değerinden 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 (ISO 8601 biçimi) veya daha sonra olan tüm kampanyalar: updateTime>="2020-11-04T18:54:47Z"

Bu alanın uzunluğu 500 karakterden fazla olmamalıdır.

Daha fazla bilgi için İstekleri LIST filtreleme kılavuzumuzu inceleyin.

İstek metni

İ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.

Bu liste boşsa gösterilmez.
nextPageToken

string

Sonraki sonuç sayfasını almak için kullanılan jeton. Sonraki sonuç sayfasını almak için campaigns.list yöntemine yapılan bir 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ını inceleyin.