Method: customBiddingAlgorithms.list

Elenca gli algoritmi di offerte personalizzate che sono accessibili all'utente corrente e che possono essere utilizzati nelle strategie di offerta.

L'ordine è definito dal parametro orderBy.

Richiesta HTTP

GET https://displayvideo.googleapis.com/v2/customBiddingAlgorithms

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di ricerca

Parametri
pageSize

integer

Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 200. Se non specificati, il valore predefinito sarà 100. Restituisce il codice di errore INVALID_ARGUMENT se viene specificato un valore non valido.

pageToken

string

Un token che identifica una pagina di risultati che il server dovrebbe restituire. In genere, si tratta del valore di nextPageToken restituito dalla precedente chiamata al metodo customBiddingAlgorithms.list. Se non specificato, verrà restituita la prima pagina di risultati.

orderBy

string

Campo in base al quale ordinare l'elenco. I valori accettati sono:

  • displayName (valore predefinito)

L'ordinamento predefinito è crescente. Per specificare l'ordine decrescente di un campo, è necessario aggiungere un suffisso "desc" al nome del campo. Esempio: displayName desc.

filter

string

Consente di filtrare in base ai campi dell'algoritmo delle offerte personalizzate.

Sintassi supportata:

  • Le espressioni di filtro sono composte da una o più restrizioni.
  • Le limitazioni possono essere combinate tramite AND. Una sequenza di limitazioni utilizza implicitamente AND.
  • Una restrizione ha il formato {field} {operator} {value}.
  • Il campo customBiddingAlgorithmType deve utilizzare l'operatore EQUALS (=).
  • Il campo displayName deve utilizzare l'operatore HAS (:).

Campi supportati:

  • customBiddingAlgorithmType
  • displayName

Esempi:

  • Tutti gli algoritmi delle offerte personalizzate per i quali il nome visualizzato contiene "politica": displayName:"politics".
  • Tutti gli algoritmi di offerte personalizzate il cui tipo è "SCRIPT_BASED": customBiddingAlgorithmType=SCRIPT_BASED

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

Per ulteriori informazioni, consulta la guida relativa al filtro delle richieste di LIST.

Parametro di unione accessor. obbligatorio. Identifica l'entità DV360 all'interno della quale viene effettuata la richiesta. La richiesta LIST restituirà solo entità di algoritmi delle offerte personalizzate accessibili all'entità DV360 identificata all'interno di accessor. Per eseguire la richiesta LIST, l'utente deve disporre dell'autorizzazione per l'entità accessor. accessor può essere solo uno dei seguenti:
partnerId

string (int64 format)

L'ID del partner DV360 che ha accesso all'algoritmo delle offerte personalizzate.

advertiserId

string (int64 format)

L'ID dell'inserzionista DV360 che ha accesso all'algoritmo delle offerte personalizzate.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

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

Rappresentazione JSON
{
  "customBiddingAlgorithms": [
    {
      object (CustomBiddingAlgorithm)
    }
  ],
  "nextPageToken": string
}
Campi
customBiddingAlgorithms[]

object (CustomBiddingAlgorithm)

L'elenco di algoritmi di offerte personalizzate.

Questo elenco non sarà presente se vuoto.

nextPageToken

string

Un token per recuperare la pagina dei risultati successiva. Passa questo valore nel campo pageToken nella chiamata successiva al metodo ListCustomBiddingAlgorithmsRequest per recuperare la pagina dei risultati successiva. Se questo campo è nullo, significa che si tratta dell'ultima pagina.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la pagina Panoramica di OAuth 2.0.