Method: advertisers.adGroups.list

Reklam gruplarını listeler.

HTTP isteği

GET https://displayvideo.googleapis.com/v5/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 kullanılır. 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. 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ıdır. Listenin sıralanacağı alan. Kabul edilen değerler şunlardır:

  • displayName (varsayılan)
  • entityStatus

Varsayılan sıralama ölçütü artandır. Bir alan için azalan sıralama belirtmek istiyorsanız alan adına "desc" son eki 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 dolaylı olarak AND kullanır.
  • Kısıtlamalar {field} {operator} {value} biçimindedir.
  • Tüm alanlarda EQUALS (=) operatörü kullanılmalıdır.

Desteklenen özellikler:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Örnekler:

  • 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 karakterden fazla olmamalıdır.

Daha fazla bilgi için İstekleri LIST filtreleme kılavuzumuzu inceleyin.

İstek metni

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

Bu liste boşsa gösterilmez.
nextPageToken

string

Sonraki sonuç sayfasını almak için kullanılan jeton. Sonraki sonuç sayfasını almak için adGroups.list yöntemine yapılan bir 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ını inceleyin.