Method: advertisers.lineItems.list

Elenca gli elementi pubblicitari di un inserzionista.

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

Richiesta HTTP

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/lineItems

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
advertiserId

string (int64 format)

Obbligatorio. L'ID dell'inserzionista per il quale elencare gli elementi pubblicitari.

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 lineItems.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)
  • entityStatus
  • flight.dateRange.endDate
  • 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 alle proprietà degli elementi pubblicitari.

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}.
  • L'operatore utilizzato su flight.dateRange.endDate deve essere INFERIORE DI (<).
  • L'operatore utilizzato su updateTime deve essere GREATER THAN OR EQUAL TO (>=) o LESS THAN OR EQUAL TO (<=).
  • L'operatore utilizzato su warningMessages deve essere HAS (:).
  • Gli operatori utilizzati in tutti gli altri campi devono essere EQUALS (=).
  • Proprietà supportate:
    • campaignId
    • displayName
    • insertionOrderId
    • entityStatus
    • lineItemId
    • lineItemType
    • flight.dateRange.endDate (input formattato come AAAA-MM-GG)
    • warningMessages
    • flight.triggerId
    • updateTime (input nel formato ISO 8601 o AAAA-MM-GGTHH:MM:SSZ)
    • targetedChannelId
    • targetedNegativeKeywordListId

Esempi:

  • Tutti gli elementi pubblicitari in un ordine di inserzione: insertionOrderId="1234"
  • Tutti gli elementi pubblicitari ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED e LINE_ITEM_TYPE_DISPLAY_DEFAULT di un inserzionista: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • Tutti gli elementi pubblicitari il cui periodo di pubblicazione termina prima del 28 marzo 2019: flight.dateRange.endDate<"2019-03-28"
  • Tutti gli elementi pubblicitari con NO_VALID_CREATIVE in warningMessages: warningMessages:"NO_VALID_CREATIVE"
  • Tutti gli elementi pubblicitari con una durata di aggiornamento inferiore o uguale a 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Tutti gli elementi pubblicitari con data e ora di aggiornamento maggiore o uguale a 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z"
  • Tutti gli elementi pubblicitari che utilizzano sia il canale specificato sia l'elenco di parole chiave escluse specificato nel loro targeting: targetedNegativeKeywordListId=789 AND targetedChannelId=12345

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

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

object (LineItem)

L'elenco di elementi pubblicitari.

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 lineItems.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.