Method: advertisers.reachForecast.retrievePlannableUserLists

Öngörü için kullanılabilen birinci ve üçüncü taraf kullanıcı listelerini alır.

HTTP isteği

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

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

Yol parametreleri

Parametreler
advertiserId

string (int64 format)

Zorunlu. Planlanabilir kullanıcı listelerinin alınacağı reklamverenin kimliği.

Sorgu parametreleri

Parametreler
pageSize

integer

İsteğe bağlı. İstenen sayfa boyutu. 1 ile 5000 arasında olmalıdır. Belirtilmezse varsayılan olarak 5000 olur.
pageToken

string

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

string

İsteğe bağlı. Planlanabilir kullanıcı listesi özelliklerine 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 veya OR mantıksal operatörleriyle birleştirilebilir.
  • Kısıtlama, {field} {operator} {value} biçimindedir.
  • displayName alanında HAS (:) operatörü kullanılmalıdır.
  • Diğer tüm alanlarda EQUALS (=) operatörü kullanılmalıdır.

Desteklenen alanlar:

  • plannableStatus
  • displayName
  • userListType
  • name

Örnekler:

  • Planlanabilir tüm kullanıcı listeleri: plannableStatus="PLANNABLE"
  • Görünen adı "Alışveriş" içeren planlanabilir kullanıcı listeleri: plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • Birinci taraf kullanıcı listeleri: userListType="FIRST_PARTY"

Bu alanın uzunluğu 500 karakteri aşmamalıdır.

Daha fazla bilgi için filtre LIST istekleri kılavuzumuza bakın.

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

reachForecast.retrievePlannableUserLists için yanıt.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "plannableUserLists": [
    {
      object (PlannableUserList)
    }
  ],
  "nextPageToken": string
}
Alanlar
plannableUserLists[]

object (PlannableUserList)

Yalnızca çıkış. Planlanabilir kullanıcı listelerinin listesi.
nextPageToken

string

Yalnızca çıkış. Sonuçların sonraki sayfasını almak için kullanılan jeton.

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.

PlannableUserList

Erişim tahmini için kullanılan, planlanabilir bir kullanıcı listesi.

JSON gösterimi 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
Alanlar
displayName

string

Yalnızca çıkış. Kullanıcı listesinin görünen adı.
userListType

enum (UserListType)

Yalnızca çıkış. Kullanıcı listesinin türü.
name

string

Yalnızca çıkış. Kullanıcı listesini tanımlayan kaynak adı.

Biçim: advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

Yalnızca çıkış. Kullanıcı listesinin planlanabilirlik durumu.

UserListType

Kullanıcı listesi türleri.

Sıralamalar
USER_LIST_TYPE_UNSPECIFIED Belirtilmemiş kullanıcı listesi türü.
FIRST_PARTY Birinci taraf kullanıcı listesi.
THIRD_PARTY Üçüncü taraf kullanıcı listesi.

PlannableStatus

Bir listenin planlanabilir olup olmadığını gösteren durum.

Sıralamalar
PLANNABLE_STATUS_UNSPECIFIED Planlanabilirlik durumu belirtilmemiş.
PLANNABLE Kullanıcı listesi planlanabilir.
UNPLANNABLE Kullanıcı listesi planlanamıyor.