Method: advertisers.adGroups.list

Reklam gruplarını listeler.

HTTP isteği

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

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

Yol parametreleri

Parametreler
advertiserId

string (int64 format)

Zorunlu. Reklam gruplarının ait olduğu reklamverenin kimliği.

Sorgu parametreleri

Parametreler
pageSize

integer

İsteğe bağlıdır. İ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

İsteğe bağlıdır. Sunucunun döndürmesi gereken sonuç sayfasını tanımlayan bir jeton. Bu genellikle adGroups.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

İsteğe bağlıdır. Listenin sıralanacağı alan. Kabul edilen değerler şunlardır:

  • displayName (varsayılan)
  • entityStatus

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

string

İsteğe bağlıdır. Özel reklam grubu alanlarına göre filtreleme yapılmasına olanak tanır.

Desteklenen söz dizimi:

  • Filtre ifadeleri bir veya daha fazla kısıtlamadan oluşur.
  • Kısıtlamalar AND ve OR ile birleştirilebilir. Bir kısıtlama dizisi örtülü olarak AND kullanır.
  • Kısıtlama, {field} {operator} {value} biçimindedir.
  • Tüm alanlarda EQUALS (=) operatörü kullanılmalıdır.

Desteklenen tesisler:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Örnekler:

  • Bir satır öğesi altındaki tüm reklam grupları: lineItemId="1234"
  • Bir reklamverenin altındaki tüm ENTITY_STATUS_ACTIVE veya ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM reklam grupları: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

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 
{
  "adGroups": [
    {
      object (AdGroup)
    }
  ],
  "nextPageToken": string
}
Alanlar
adGroups[]

object (AdGroup)

Reklam gruplarının listesi.

Boşsa bu liste gösterilmez.
nextPageToken

string

Sonuçların sonraki sayfasını almak için kullanılan jeton. Sonraki sonuç sayfasını almak için adGroups.list yöntemine yapılan sonraki çağrıda 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 Overview sayfasına bakın.