Method: advertisers.reachForecast.retrievePlannableUserLists

Recupera gli elenchi di utenti proprietari e di terze parti disponibili per le previsioni.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
advertiserId

string (int64 format)

Obbligatorio. L'ID dell'inserzionista per cui recuperare gli elenchi di utenti pianificabili.

Parametri di query

Parametri
pageSize

integer

Facoltativo. Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 5000. Se non specificato, il valore predefinito è 5000.
pageToken

string

Facoltativo. Un token che identifica una pagina di risultati che il server deve restituire. In genere, questo è il valore di nextPageToken restituito dalla chiamata precedente al metodo reachForecast.retrievePlannableUserLists. Se non specificato, verrà restituita la prima pagina dei risultati.
filter

string

Facoltativo. Consente di filtrare in base alle proprietà dell'elenco di utenti pianificabili.

Sintassi supportata:

  • Le espressioni di filtro sono costituite da una o più limitazioni.
  • Le limitazioni possono essere combinate con gli operatori logici AND o OR.
  • Una limitazione ha il formato {field} {operator} {value}.
  • Il campo displayName deve utilizzare l'operatore HAS (:).
  • Tutti gli altri campi devono utilizzare l'operatore EQUALS (=).

Campi supportati:

  • plannableStatus
  • displayName
  • userListType
  • name

Esempi:

  • Tutti gli elenchi di utenti pianificabili: plannableStatus="PLANNABLE"
  • Elenchi di utenti pianificabili con nome visualizzato contenente "Shopping": plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • Elenchi di utenti proprietari: userListType="FIRST_PARTY"

La lunghezza di questo campo non deve superare i 500 caratteri.

Per ulteriori informazioni, consulta la nostra guida alle richieste di filtro LIST.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta per reachForecast.retrievePlannableUserLists.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "plannableUserLists": [
    {
      object (PlannableUserList)
    }
  ],
  "nextPageToken": string
}
Campi
plannableUserLists[]

object (PlannableUserList)

Solo output. L'elenco degli elenchi di utenti pianificabili.
nextPageToken

string

Solo output. Un token per recuperare la pagina successiva dei risultati.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.

PlannableUserList

Un elenco di utenti pianificabili utilizzato per le previsioni di copertura.

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

string

Solo output. Il nome visualizzato dell'elenco di utenti.
userListType

enum (UserListType)

Solo output. Il tipo di elenco di utenti.
name

string

Solo output. Il nome risorsa che identifica l'elenco di utenti.

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

enum (PlannableStatus)

Solo output. Lo stato di pianificazione dell'elenco di utenti.

UserListType

Tipi di elenchi di utenti.

Enum
USER_LIST_TYPE_UNSPECIFIED Tipo di elenco di utenti non specificato.
FIRST_PARTY Un elenco di utenti proprietario.
THIRD_PARTY Un elenco di utenti di terze parti.

PlannableStatus

Stato che indica se un elenco è pianificabile o meno.

Enum
PLANNABLE_STATUS_UNSPECIFIED Stato di pianificazione non specificato.
PLANNABLE L'elenco di utenti è pianificabile.
UNPLANNABLE L'elenco di utenti non è pianificabile.