Method: advertisers.reachForecast.retrievePlannableUserLists

Pobiera własne i zewnętrzne listy użytkowników dostępne na potrzeby prognozowania.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

Wymagane. Identyfikator reklamodawcy, dla którego mają zostać pobrane listy użytkowników, które można zaplanować.

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie. Żądany rozmiar strony. Musi należeć do przedziału od 1 do 5000. Jeśli nie zostanie określony, domyślnie będzie wynosić 5000.
pageToken

string

Opcjonalnie. Token identyfikujący stronę wyników, którą serwer ma zwrócić. Zwykle jest to wartość nextPageToken zwrócona przez poprzednie wywołanie metody reachForecast.retrievePlannableUserLists. Jeśli nie zostanie określony, zostanie zwrócona pierwsza strona wyników.
filter

string

Opcjonalnie. Umożliwia filtrowanie według właściwości listy użytkowników, którą można zaplanować.

Obsługiwana składnia:

  • Wyrażenia filtru składają się z co najmniej 1 ograniczenia.
  • Ograniczenia można łączyć za pomocą operatorów logicznych AND lub OR.
  • Ograniczenie ma postać {field} {operator} {value}.
  • Pole displayName musi używać operatora HAS (:).
  • Wszystkie pozostałe pola muszą używać operatora EQUALS (=).

Obsługiwane pola:

  • plannableStatus
  • displayName
  • userListType
  • name

Przykłady:

  • Wszystkie listy użytkowników, które można zaplanować: plannableStatus="PLANNABLE"
  • Listy użytkowników, które można zaplanować, z nazwą wyświetlaną zawierającą "Zakupy": plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • Własne listy użytkowników: userListType="FIRST_PARTY"

Długość tego pola nie powinna przekraczać 500 znaków.

Więcej informacji znajdziesz w przewodniku dotyczącym żądań filter LIST requests.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na reachForecast.retrievePlannableUserLists.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "plannableUserLists": [
    {
      object (PlannableUserList)
    }
  ],
  "nextPageToken": string
}
Pola
plannableUserLists[]

object (PlannableUserList)

Tylko dane wyjściowe. Lista użytkowników, których można zaplanować.
nextPageToken

string

Tylko dane wyjściowe. Token umożliwiający pobranie następnej strony wyników.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/display-video

Więcej informacji znajdziesz tutaj: OAuth 2.0 Overview.

PlannableUserList

Lista użytkowników, którą można zaplanować, używana do prognozowania zasięgu.

Zapis JSON 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
Pola
displayName

string

Tylko dane wyjściowe. Nazwa wyświetlana listy użytkowników.
userListType

enum (UserListType)

Tylko dane wyjściowe. Typ listy użytkowników.
name

string

Tylko dane wyjściowe. Nazwa zasobu identyfikująca listę użytkowników.

Format: advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

Tylko dane wyjściowe. Stan listy użytkowników, który można zaplanować.

UserListType

Typy list użytkowników.

Wartości w polu enum
USER_LIST_TYPE_UNSPECIFIED Nieokreślony typ listy użytkowników.
FIRST_PARTY Własna lista użytkowników.
THIRD_PARTY Lista użytkowników dostarczona przez inną firmę.

PlannableStatus

Stan wskazujący, czy listę można zaplanować.

Wartości w polu enum
PLANNABLE_STATUS_UNSPECIFIED Nieokreślony stan, który można zaplanować.
PLANNABLE Listę użytkowników można zaplanować.
UNPLANNABLE Listy użytkowników nie można zaplanować.