Method: advertisers.invoices.list

Elenca le fatture pubblicate per un inserzionista in un determinato mese.

Le fatture generate dai profili di fatturazione a livello di "Partner" non possono essere recuperate con questo metodo.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
advertiserId

string (int64 format)

Obbligatorio. L'ID dell'inserzionista per cui elencare le fatture.

Parametri di ricerca

Parametri
issueMonth

string

Il mese di cui visualizzare l'elenco delle fatture. Se non viene configurato, la richiesta recupererà le fatture del mese precedente.

Deve essere nel formato AAAAMM.

loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Seleziona il tipo di fattura da recuperare per gli inserzionisti in base alla legge Sapin.

Valido solo per gli inserzionisti in base alla Legge Sapin. In caso contrario verrà ignorato.

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 deve restituire. In genere, si tratta del valore di nextPageToken restituito dalla precedente chiamata al metodo invoices.list. Se non specificato, verrà restituita la prima pagina di risultati.

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

object (Invoice)

L'elenco delle fatture.

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 invoices.list per recuperare la pagina dei risultati successiva.

Questo token non sarà presente se non vengono restituiti altri invoices.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

LoiSapinInvoiceType

Possibili tipi di fatture per gli inserzionisti in base alla legge Sapin.

Enum
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED Valore non specificato.
LOI_SAPIN_INVOICE_TYPE_MEDIA Fatture con costo dei media.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Fatture con Tariffa piattaforma.

Fattura

Una sola fattura.

Rappresentazione JSON
{
  "name": string,
  "invoiceId": string,
  "displayName": string,
  "paymentsProfileId": string,
  "paymentsAccountId": string,
  "issueDate": {
    object (Date)
  },
  "dueDate": {
    object (Date)
  },
  "serviceDateRange": {
    object (DateRange)
  },
  "currencyCode": string,
  "subtotalAmountMicros": string,
  "totalTaxAmountMicros": string,
  "totalAmountMicros": string,
  "purchaseOrderNumber": string,
  "budgetInvoiceGroupingId": string,
  "invoiceType": enum (InvoiceType),
  "correctedInvoiceId": string,
  "replacedInvoiceIds": [
    string
  ],
  "pdfUrl": string,
  "budgetSummaries": [
    {
      object (BudgetSummary)
    }
  ],
  "nonBudgetMicros": string
}
Campi
name

string

Il nome risorsa della fattura.

invoiceId

string

L'ID univoco della fattura.

displayName

string

Il nome visualizzato della fattura.

paymentsProfileId

string

L'ID del profilo pagamenti a cui appartiene la fattura.

Appare nel PDF della fattura come Billing ID.

paymentsAccountId

string

L'ID dell'account pagamenti a cui appartiene la fattura.

Appare nel PDF della fattura come Billing Account Number.

issueDate

object (Date)

La data di emissione della fattura.

dueDate

object (Date)

Data di scadenza della fattura.

serviceDateRange

object (DateRange)

Le date di inizio e di fine del servizio coperte da questa fattura.

currencyCode

string

La valuta utilizzata nella fattura in formato ISO 4217.

subtotalAmountMicros

string (int64 format)

L'importo del subtotale al lordo delle imposte, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.

totalTaxAmountMicros

string (int64 format)

La somma di tutte le imposte in fattura, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.

totalAmountMicros

string (int64 format)

L'importo totale della fattura, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.

purchaseOrderNumber

string

Numero dell'ordine di acquisto associato alla fattura.

budgetInvoiceGroupingId

string

L'ID raggruppamento del budget per questa fattura.

Questo campo verrà impostato solo se il livello fattura del profilo di fatturazione corrispondente è stato impostato su "ID raggruppamento delle fatture del budget".

invoiceType

enum (InvoiceType)

Il tipo di documento di fatturazione.

correctedInvoiceId

string

L'ID della fattura originale rettificata da questa fattura, se applicabile.

Può essere riportata sul PDF della fattura come Reference invoice number.

Se il criterio replacedInvoiceIds è impostato, questo campo rimarrà vuoto.

replacedInvoiceIds[]

string

Gli ID di qualsiasi fattura emessa in origine che viene annullata da questa fattura, se applicabile. Se vengono consolidate in un'unica fattura, possono essere elencate più fatture.

Sul PDF della fattura può comparire come Replaced invoice numbers.

Se il criterio correctedInvoiceId è impostato, questo campo rimarrà vuoto.

pdfUrl

string

L'URL per scaricare una copia in formato PDF della fattura.

Questo URL è specifico dell'utente e richiede un token di accesso OAuth 2.0 valido per accedere. Il token di accesso deve essere fornito in un'intestazione HTTP Authorization: Bearer ed essere autorizzato per uno dei seguenti ambiti:

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

L'URL sarà valido per 7 giorni dopo il recupero dell'oggetto di questa fattura o fino a quando la fattura non verrà nuovamente recuperata.

budgetSummaries[]

object (BudgetSummary)

L'elenco di informazioni riepilogative per ciascun budget associato a questa fattura.

Questo campo verrà impostato solo se il livello di dettaglio della fattura del profilo di fatturazione corrispondente è stato impostato su "Ordine di acquisto a livello di budget".

nonBudgetMicros

string (int64 format)

L'importo totale dei costi o degli aggiustamenti non legati a un determinato budget, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.

InvoiceType

Possibili tipi di fatture.

Enum
INVOICE_TYPE_UNSPECIFIED Non specificato o sconosciuto in questa versione.
INVOICE_TYPE_CREDIT La fattura ha un importo negativo.
INVOICE_TYPE_INVOICE La fattura ha un importo positivo.

BudgetSummary

Informazioni riassunte sul budget di una singola campagna.

Rappresentazione JSON
{
  "externalBudgetId": string,
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "preTaxAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
Campi
externalBudgetId

string

Corrisponde al externalBudgetId del budget di una campagna. Se il valore non è impostato nel budget della campagna, questo campo sarà vuoto.

prismaCpeCode

object (PrismaCpeCode)

Codici di clienti, prodotti e stime pertinenti dello strumento Mediaocean Prisma.

Applicabile solo per i budget delle campagne con un externalBudgetSource pari a EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.

preTaxAmountMicros

string (int64 format)

La somma degli addebiti effettuati in base a questo budget al lordo delle imposte, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.

taxAmountMicros

string (int64 format)

L'importo delle imposte applicate agli addebiti con questo budget, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.

totalAmountMicros

string (int64 format)

La somma totale degli addebiti effettuati nell'ambito di questo budget, imposte incluse, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.