Method: advertisers.insertionOrders.list

Elenca gli ordini di inserzione in un inserzionista.

L'ordine è definito dal parametro orderBy. Se un valore filter per entityStatus non viene specificato, gli ordini di inserzione con ENTITY_STATUS_ARCHIVED non verranno inclusi nei risultati.

Richiesta HTTP

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/insertionOrders

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
advertiserId

string (int64 format)

Obbligatorio. L'ID dell'inserzionista per cui elencare gli ordini di inserzione.

Parametri di ricerca

Parametri
pageSize

integer

Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 100. 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 deve restituire. In genere, si tratta del valore di nextPageToken restituito dalla precedente chiamata al metodo insertionOrders.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" (predefinita)
  • "entityStatus"
  • "updateTime"

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

string

Consente di filtrare in base ai campi degli ordini di inserzione.

Sintassi supportata:

  • Le espressioni di filtro sono composte da una o più limitazioni.
  • Le restrizioni possono essere combinate dagli operatori logici AND o OR. Una sequenza di limitazioni utilizza implicitamente AND.
  • Una restrizione ha il seguente formato: {field} {operator} {value}.
  • Il campo updateTime deve utilizzare gli operatori GREATER THAN OR EQUAL TO (>=) o LESS THAN OR EQUAL TO (<=).
  • Tutti gli altri campi devono utilizzare l'operatore EQUALS (=).

Campi supportati:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (input in formato ISO 8601 o YYYY-MM-DDTHH:MM:SSZ)

Esempi:

  • Tutti gli ordini di inserzione in una campagna: campaignId="1234"
  • Tutti i ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED ordini di inserzione di un inserzionista: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Tutti gli ordini di inserzione con una data/ora di aggiornamento inferiore o uguale a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Tutti gli ordini di inserzione con data di aggiornamento uguale o superiore a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

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

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 
{
  "insertionOrders": [
    {
      object (InsertionOrder)
    }
  ],
  "nextPageToken": string
}
Campi
insertionOrders[]

object (InsertionOrder)

L'elenco di ordini di inserzione.

Questo elenco non sarà presente se vuoto.
nextPageToken

string

Un token per recuperare la pagina di risultati successiva. Passa questo valore nel campo pageToken nella chiamata successiva al metodo insertionOrders.list per recuperare la pagina dei risultati successiva.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.