Method: advertisers.insertionOrders.list

Bir reklamverendeki kampanya siparişlerini listeler.

Sıralama, orderBy parametresi tarafından tanımlanır. filter ile entityStatus belirtilmezse ENTITY_STATUS_ARCHIVED içeren kampanya siparişleri sonuçlara dahil edilmez.

HTTP isteği

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/insertionOrders

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

Yol parametreleri

Parametreler
advertiserId

string (int64 format)

Zorunlu. Kampanya siparişlerinin listeleneceği reklamverenin kimliği.

Sorgu parametreleri

Parametreler
pageSize

integer

İstenen sayfa boyutu. 1 ile 100 arasında olmalıdır. Belirtilmemişse varsayılan olarak 100 olur. Geçersiz bir değer belirtilirse INVALID_ARGUMENT hata kodunu döndürür.
pageToken

string

Sunucunun döndürmesi gereken bir sonuç sayfasını tanımlayan jeton. Genellikle bu, insertionOrders.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 siparişi 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ö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 kampanya kapsamındaki tüm kampanya siparişleri: campaignId="1234"
  • Bir reklamverenin altındaki tüm ENTITY_STATUS_ACTIVE veya ENTITY_STATUS_PAUSED kampanya siparişleri: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Güncelleme zamanı 2020-11-04T18:54:47Z (ISO 8601 biçiminde) veya bu tarihten önce olan tüm kampanya siparişleri: 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 kampanya siparişleri: 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 
{
  "insertionOrders": [
    {
      object (InsertionOrder)
    }
  ],
  "nextPageToken": string
}
Alanlar
insertionOrders[]

object (InsertionOrder)

Kampanya siparişlerinin 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 insertionOrders.list yönteminin sonraki çağrısında pageToken alanında bu değeri iletin.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/display-video

Daha fazla bilgi için OAuth 2.0 Overview sayfasına bakın.