Method: advertisers.creatives.list

Bir reklamverendeki reklam öğelerini listeler.

Sıra, orderBy parametresiyle tanımlanır. filter x entityStatus boyutu belirtilmemişse ENTITY_STATUS_ARCHIVED boyutundaki reklam öğeleri sonuçlara dahil edilmez.

HTTP isteği

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

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

Yol parametreleri

Parametreler
advertiserId

string (int64 format)

Zorunlu. Reklam öğ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 sonuç sayfasını tanımlayan bir jeton. Bu genellikle creatives.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:

  • creativeId (varsayılan)
  • createTime
  • mediaDuration
  • dimensions (önce genişliğe, sonra yüksekliğe göre sıralar)

Varsayılan sıralama düzeni artandır. Bir alan için azalan sırayı belirtmek üzere alan adına "desc" soneki eklenmelidir. Örnek: createTime desc.

filter

string

Reklam öğesi 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. Bir kısıtlama dizisi örtülü olarak AND kullanır.
  • Kısıtlama, {field} {operator} {value} biçimindedir.
  • lineItemIds alanında HAS (:) operatörü kullanılmalıdır.
  • updateTime alanı, GREATER THAN OR EQUAL TO (>=) veya LESS THAN OR EQUAL TO (<=) operatörlerini kullanmalıdır.
  • Diğer tüm alanlarda EQUALS (=) operatörü kullanılmalıdır.
  • entityStatus, minDuration, maxDuration, updateTime ve dynamic alanları için en fazla bir kısıtlama olabilir.

Desteklenen alanlar:

  • approvalStatus
  • creativeId
  • creativeType
  • dimensions ({width}x{height} biçiminde giriş)
  • dynamic
  • entityStatus
  • exchangeReviewStatus ({exchange}-{reviewStatus} biçiminde giriş)
  • lineItemIds
  • maxDuration ({duration}s biçiminde giriş. Yalnızca saniyeler desteklenir)
  • minDuration ({duration}s biçiminde giriş. Yalnızca saniyeler desteklenir)
  • updateTime (ISO 8601 biçiminde giriş veya YYYY-MM-DDTHH:MM:SSZ)

Notlar:

  • updateTime için bir reklam öğesi kaynağının alan değeri, reklam öğesinin en son güncellendiği zamanı yansıtır.Bu, sistem tarafından yapılan güncellemeleri (ör. reklam öğesi inceleme güncellemeleri) içerir.

Örnekler:

  • Tüm doğal reklam öğeleri: creativeType="CREATIVE_TYPE_NATIVE"
  • 300x400 veya 50x100 boyutlarındaki tüm etkin reklam öğeleri: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • AdX veya AppNexus tarafından onaylanan, minimum süresi 5 saniye ve 200 ms olan tüm dinamik reklam öğeleri: dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • Satır öğesi kimliği 1 veya 2 ile ilişkilendirilmiş tüm video reklam öğeleri: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Birden fazla reklam öğesi kimliğine göre reklam öğesi bulma: creativeId=1 OR creativeId=2
  • Güncelleme zamanı 2020-11-04T18:54:47Z'den (ISO 8601 biçimi) büyük veya bu değere eşit olan tüm reklam öğeleri: updateTime>="2020-11-04T18:54:47Z"

Bu alanın uzunluğu 500 karakteri aşmamalı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
{
  "creatives": [
    {
      object (Creative)
    }
  ],
  "nextPageToken": string
}
Alanlar
creatives[]

object (Creative)

Reklam öğeleri listesi.

Liste boşsa gösterilmez.

nextPageToken

string

Sonuçların sonraki sayfasını almak için kullanılan jeton. Sonraki sonuç sayfasını almak için ListCreativesRequest yöntemine yapılan sonraki çağrıda bu değeri pageToken alanına iletin. Bu alan boşsa son sayfadır.

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.