Method: advertisers.youtubeAdGroups.list

YouTube reklam gruplarını listeler.

HTTP isteği

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroups

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

İstenen sayfa boyutu. 1 ile 200 arasında olmalıdır. Belirtilmemişse varsayılan olarak 100 kullanılır. Geçersiz bir değer belirtilirse INVALID_ARGUMENT hata kodunu döndürür.

pageToken

string

Sunucunun döndürmesi gereken sonuçların bulunduğu sayfayı tanımlayan jeton. Genellikle bu, youtubeAdGroups.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 edilebilir değerler şunlardır:

  • displayName (varsayılan)
  • entityStatus

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

filter

string

Özel YouTube reklam grubu 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 ve OR tarafından birleştirilebilir. Bir dizi kısıtlama dolaylı olarak 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 tüm ENTITY_STATUS_ACTIVE veya ENTITY_STATUS_PAUSED YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM reklam grubu: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM"

Bu alanın uzunluğu 500 karakterden fazla olmamalı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
{
  "youtubeAdGroups": [
    {
      object (YoutubeAdGroup)
    }
  ],
  "nextPageToken": string
}
Alanlar
youtubeAdGroups[]

object (YoutubeAdGroup)

Reklam grupları listesi.

Boşsa bu liste yer almayacak.

nextPageToken

string

Sonraki sonuç sayfasını almak için jeton. Bir sonraki sonuç sayfasını almak için bu değeri, bir sonraki youtubeAdGroups.list yöntemi çağrısında 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.