Method: advertisers.lineItems.list

Bir reklamverendeki satır öğelerini listeler.

Sıralama, orderBy parametresi tarafından tanımlanır. entityStatus bazında filter belirtilmezse ENTITY_STATUS_ARCHIVED içeren satır öğeleri sonuçlara dahil edilmez.

HTTP isteği

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

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

Yol parametreleri

Parametreler
advertiserId

string (int64 format)

Zorunlu. Satır öğelerinin listeleneceği reklamverenin kimliği.

Sorgu parametreleri

Parametreler
pageSize

integer

İstenen sayfa boyutu. 1 ile 200 arasında olmalıdır. Belirtilmezse 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. Bu genellikle, lineItems.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 alana yönelik azalan sırayı belirtmek için alan adına "azalan" son eki eklenmelidir. Örnek: displayName desc.

filter

string

Satır öğesi 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ö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 alanlarda EQUALS (=) operatörü kullanılmalıdır.

Desteklenen alanlar:

  • campaignId
  • displayName
  • entityStatus
  • insertionOrderId
  • lineItemId
  • lineItemType
  • updateTime (ISO 8601 biçiminde giriş veya YYYY-MM-DDTHH:MM:SSZ)

Örnekler:

  • Bir kampanya siparişi altındaki tüm satır öğeleri: insertionOrderId="1234"
  • Bir reklamverenin altındaki tüm ENTITY_STATUS_ACTIVE veya ENTITY_STATUS_PAUSED ve LINE_ITEM_TYPE_DISPLAY_DEFAULT satır öğeleri: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • Güncelleme zamanı 2020-11-04T18:54:47Z (ISO 8601 biçimi) veya bu tarihten önce olan tüm satır öğeleri: updateTime<="2020-11-04T18:54:47Z"
  • Güncelleme zamanı 2020-11-04T18:54:47Z (ISO 8601 biçimi) veya bu tarihten büyük olan tüm satır öğeleri: 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
{
  "lineItems": [
    {
      object (LineItem)
    }
  ],
  "nextPageToken": string
}
Alanlar
lineItems[]

object (LineItem)

Satır öğeleri listesi.

Boşsa bu liste bulunmaz.

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 lineItems.list yönteminin sonraki çağrısında bu değeri pageToken alanına 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'a Genel Bakış başlıklı makaleyi inceleyin.