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/v5/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 chcesz pobrać listy użytkowników, na których można planować wyświetlanie reklam.

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 to 5000.
pageToken

string

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

string

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

Obsługiwana składnia:

  • Wyrażenia filtra 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 uwzględnić w planie: plannableStatus="PLANNABLE"
  • Listy użytkowników, które można uwzględnić w planie, z wyświetlaną nazwą zawierającą słowo „Zakupy”: plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • Własne listy użytkowników: userListType="FIRST_PARTY"

To pole może zawierać maksymalnie 500 znaków.

Więcej informacji znajdziesz w naszym przewodniku dotyczącym filtrowania żądań LIST.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź dla 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 list użytkowników, które można uwzględnić w planie.
nextPageToken

string

Tylko dane wyjściowe. Token do pobierania następnej strony wyników.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.

PlannableUserList

Lista użytkowników, którą można uwzględnić w planie, 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. Wyświetlana nazwa 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 możliwości planowania listy użytkowników.

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 firmy zewnętrznej.

PlannableStatus

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

Wartości w polu enum
PLANNABLE_STATUS_UNSPECIFIED Nieokreślony stan możliwości planowania.
PLANNABLE Listę użytkowników można uwzględnić w planie.
UNPLANNABLE Nie można zaplanować listy użytkowników.