Method: advertisers.campaigns.list

Bir reklamverendeki kampanyaları listeler.

Sıra, orderBy parametresiyle tanımlanır. entityStatus ölçütüne göre bir 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ı 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 kullanılır.
pageToken

string

Sunucunun döndürmesi gereken sonuçların bulunduğu sayfayı tanımlayan 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 için azalan sıralamayı belirtmek üzere alan adına "azalan" son eki eklenmelidir. Örnek: displayName desc.
filter

string

Kampanya alanlarına göre filtrelemeye 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örleri tarafından birleştirilebilir. Bir dizi kısıtlama dolaylı 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 alanlar EQUALS (=) operatörünü kullanmalıdır.

Desteklenen alanlar:

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

Örnekler:

  • Bir reklamveren altındaki tüm ENTITY_STATUS_ACTIVE veya ENTITY_STATUS_PAUSED kampanya: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Güncelleme zamanı 2020-11-04T18:54:47Z (ISO 8601 biçiminde) veya daha az olan tüm kampanyalar: updateTime<="2020-11-04T18:54:47Z"
  • Güncelleme zamanı 2020-11-04T18:54:47Z (ISO 8601 biçiminde) veya daha uzun 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 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.

Boşsa bu liste yer almayacak.
nextPageToken

string

Sonraki sonuç sayfasını almak için jeton. Bir sonraki sonuç sayfasını almak için bu değeri, bir sonraki campaigns.list yöntemi çağrısında 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.