Method: advertisers.insertionOrders.list

Bir reklamverendeki kampanya siparişlerini listeler.

Sıra, orderBy parametresiyle tanımlanır. entityStatus bazında bir filter belirtilmezse ENTITY_STATUS_ARCHIVED içeren kampanya siparişleri sonuçlara dahil edilmez.

HTTP isteği

GET https://displayvideo.googleapis.com/v2/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 kullanılır. Geçersiz bir değer belirtilirse INVALID_ARGUMENT hata kodunu döndürür.

pageToken

string

Sunucunun döndürmesi gereken sonuçların bulunduğu sayfayı tanımlayan jeton. Genellikle bu, insertionOrders.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)
  • "Varlık Durumu"
  • "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 siparişi 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 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 kampanya altındaki tüm kampanya siparişleri: campaignId="1234"
  • Bir reklamveren altındaki tüm ENTITY_STATUS_ACTIVE veya ENTITY_STATUS_PAUSED kampanya siparişi: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Güncelleme zamanı şu veya bu süreye eşit olan tüm kampanya siparişleri: 2020-11-04T18:54:47Z (ISO 8601 biçimi): updateTime<="2020-11-04T18:54:47Z"
  • Güncelleme zamanı 2020-11-04T18:54:47Z (ISO 8601 biçimi) veya daha uzun olan tüm kampanya siparişleri: 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
{
  "insertionOrders": [
    {
      object (InsertionOrder)
    }
  ],
  "nextPageToken": string
}
Alanlar
insertionOrders[]

object (InsertionOrder)

Kampanya siparişlerinin 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 insertionOrders.list yöntemi çağrısında pageToken alanına geçirin.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.