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ı. İstenen sayfa boyutu. 1 ile 200 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

İsteğe bağlı. Sunucunun döndürmesi gereken sonuçların yer aldığı sayfayı tanımlayan bir jeton. Genellikle bu, 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ı. Listenin sıralanacağı alan. Kabul edilebilir değerler şunlardır:

  • displayName (varsayılan)
  • entityStatus

Varsayılan sıralama düzeni artan düzendedir. Bir alanın azalan sırasını belirtmek için alan adına "azalan" son eki eklenmelidir. Örnek: displayName desc.
filter

string

İsteğe bağlı. Özel reklam grubu 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 ve OR ile birleştirilebilir. Bir dizi kısıtlama, dolaylı yoldan AND kullanır.
  • Kısıtlama {field} {operator} {value} biçimindedir.
  • Tüm alanlar EQUALS (=) operatörünü kullanmalıdır.

Desteklenen özellikler:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Örnekler:

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

Bu alan en fazla 500 karakter uzunluğunda olmalıdır.

Daha fazla bilgi edinmek için filtre LIST istekleri kılavuzumuzu inceleyin.

İ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ı listesi.

Boş bırakılırsa bu liste görünmez.
nextPageToken

string

Sonraki sonuç sayfasını almak için jeton. Sonraki sonuç sayfasını almak için bu değeri, adGroups.list yöntemine yapılan sonraki çağrıdaki 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.