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 bir sonuç sayfasını tanımlayan jeton. Genellikle bu, adGroups.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

İsteğe bağlı. Listeyi sıralamak için kullanılacak alan. Kabul edilen değerler şunlardır:

  • displayName (varsayılan)
  • entityStatus

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

string

İsteğe bağlı. Ö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 birlikte kullanılabilir. Kısıtlama dizisi, AND değerini dolaylı olarak kullanır.
  • Kısıtlamalar {field} {operator} {value} biçimindedir.
  • Tüm alanlarda EQUALS (=) operatörü kullanılmalıdır.

Desteklenen mülkler:

  • 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 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 
{
  "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 bir sonraki sayfasını almak için kullanılan jeton. Sonuçların bir sonraki sayfasını almak için adGroups.list yönteminin sonraki çağrısında pageToken alanında bu değeri 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.