Method: advertisers.invoices.list

Listet die Rechnungen auf, die in einem bestimmten Monat an einen Werbetreibenden gesendet wurden.

Rechnungen, die über Abrechnungsprofile mit der Rechnungsebene „Partner“ erstellt wurden, können nicht über diese Methode abgerufen werden.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameters
advertiserId

string (int64 format)

Erforderlich. Die ID des Werbetreibenden, für den Rechnungen aufgelistet werden sollen.

Abfrageparameter

Parameters
issueMonth

string

Der Monat, für den die Rechnungen aufgelistet werden sollen. Wenn die Richtlinie nicht konfiguriert ist, werden mit der Anfrage Rechnungen für den Vormonat abgerufen.

Muss im Format JJJJMM vorliegen.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Wählen Sie die Art der Rechnung aus, die für Werbetreibende im Sapin-Gesetz abgerufen werden soll.

Gilt nur für Werbetreibende nach dem Sapin-Gesetz. Wird sonst ignoriert.
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 200 liegen. Wenn keine Vorgabe erfolgt, wird standardmäßig 100 verwendet. Gibt den Fehlercode INVALID_ARGUMENT zurück, wenn ein ungültiger Wert angegeben wurde.
pageToken

string

Ein Token, das eine Ergebnisseite identifiziert, die der Server liefern soll. In der Regel ist dies der Wert von nextPageToken, der vom vorherigen Aufruf der invoices.list-Methode zurückgegeben wurde. Wenn nicht angegeben, wird die erste Ergebnisseite zurückgegeben.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung 
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
Felder
invoices[]

object (Invoice)

Die Liste der Rechnungen.

Diese Liste fehlt, wenn sie leer ist.
nextPageToken

string

Ein Token, mit dem die nächste Ergebnisseite abgerufen werden kann. Übergeben Sie diesen Wert im nachfolgenden Aufruf der invoices.list-Methode im Feld pageToken, um die nächste Ergebnisseite abzurufen.

Dieses Token fehlt, wenn keine weiteren invoices zurückgegeben werden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

LoiSapinInvoiceType

Mögliche Rechnungsarten für Kunden im Sapin-Gesetz

Enums
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED Es ist kein Wert angegeben.
LOI_SAPIN_INVOICE_TYPE_MEDIA Rechnungen mit Mediakosten
LOI_SAPIN_INVOICE_TYPE_PLATFORM Rechnungen mit Plattformgebühr.

Rechnung

Eine einzelne Rechnung.

JSON-Darstellung 
{
  "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
}
Felder
name

string

Der Ressourcenname der Rechnung.
invoiceId

string

Eindeutige ID der Rechnung.
displayName

string

Der Anzeigename der Rechnung.
paymentsProfileId

string

Die ID des Zahlungsprofils, zu dem die Rechnung gehört.

Erscheint auf der Rechnung im PDF als Billing ID.
paymentsAccountId

string

Die ID des Zahlungskontos, zu dem die Rechnung gehört.

Erscheint auf der Rechnung im PDF als Billing Account Number.
issueDate

object (Date)

Das Datum, an dem die Rechnung ausgestellt wurde.
dueDate

object (Date)

Das Datum, an dem die Rechnung fällig ist.
serviceDateRange

object (DateRange)

Das Start- und Enddatum der Dienstleistung, die von dieser Rechnung abgedeckt werden.
currencyCode

string

Die auf der Rechnung verwendete Währung im ISO 4217-Format.
subtotalAmountMicros

string (int64 format)

Der Zwischensummenbetrag vor Steuern in Mikros in der Währung der Rechnung.

Wenn currencyCode beispielsweise USD ist, dann steht 1.000.000 für einen US-Dollar.
totalTaxAmountMicros

string (int64 format)

Die Summe aller Steuern der Rechnung in Mikros in der Währung der Rechnung.

Wenn currencyCode beispielsweise USD ist, dann steht 1.000.000 für einen US-Dollar.
totalAmountMicros

string (int64 format)

Der Rechnungsgesamtbetrag in Mikros in der Währung der Rechnung.

Wenn currencyCode beispielsweise USD ist, dann steht 1.000.000 für einen US-Dollar.
purchaseOrderNumber

string

Die mit der Rechnung verknüpfte Auftragsnummer.
budgetInvoiceGroupingId

string

Die Budgetgruppierungs-ID für diese Rechnung.

Dieses Feld wird nur ausgefüllt, wenn die Rechnungsebene des entsprechenden Abrechnungsprofils auf „ID der Rechnungsgruppe für das Budget“ festgelegt wurde.
invoiceType

enum (InvoiceType)

Die Art des Rechnungsdokuments.
correctedInvoiceId

string

Die ID der ursprünglichen Rechnung, die durch diese Rechnung korrigiert wurde (sofern zutreffend).

Kann auf der PDF-Rechnung als Reference invoice number erscheinen.

Wenn replacedInvoiceIds festgelegt ist, ist dieses Feld leer.
replacedInvoiceIds[]

string

Die IDs jeder ursprünglich ausgestellten Rechnung, die gegebenenfalls durch diese Rechnung storniert wird. Es können mehrere Rechnungen aufgeführt werden, wenn diese zu einer einzigen Rechnung zusammengefasst werden.

Kann auf PDF-Rechnungen als Replaced invoice numbers erscheinen.

Wenn correctedInvoiceId festgelegt ist, ist dieses Feld leer.
pdfUrl

string

Die URL zum Herunterladen einer PDF-Kopie der Rechnung.

Diese URL ist benutzerspezifisch. Für den Zugriff ist ein gültiges OAuth 2.0-Zugriffstoken erforderlich. Das Zugriffstoken muss in einem Authorization: Bearer-HTTP-Header angegeben werden und für einen der folgenden Bereiche autorisiert sein:

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

Die URL ist nach dem Abrufen dieses Rechnungsobjekts 7 Tage lang oder bis zum erneuten Abrufen der Rechnung gültig.
budgetSummaries[]

object (BudgetSummary)

Die Liste der zusammengefassten Informationen für jedes Budget, das dieser Rechnung zugeordnet ist.

Dieses Feld wird nur ausgefüllt, wenn für die Rechnungsdetails des entsprechenden Abrechnungsprofils „Auftrag auf Budgetebene“ festgelegt ist.
nonBudgetMicros

string (int64 format)

Gesamtbetrag der Kosten oder Korrekturen, die nicht an ein bestimmtes Budget gebunden sind, in "micros", millionstel Einheiten der Rechnungswährung.

Wenn currencyCode beispielsweise USD ist, dann steht 1.000.000 für einen US-Dollar.

InvoiceType

Mögliche Arten von Rechnungen.

Enums
INVOICE_TYPE_UNSPECIFIED Nicht angegeben oder in dieser Version unbekannt.
INVOICE_TYPE_CREDIT Die Rechnung enthält einen negativen Betrag.
INVOICE_TYPE_INVOICE Die Rechnung enthält einen positiven Betrag.

BudgetSummary

Zusammengefasste Informationen zu einem einzelnen Kampagnenbudget

JSON-Darstellung 
{
  "externalBudgetId": string,
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "preTaxAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
Felder
externalBudgetId

string

Entspricht dem externalBudgetId eines Kampagnenbudgets. Wenn der Wert nicht im Kampagnenbudget festgelegt ist, ist dieses Feld leer.
prismaCpeCode

object (PrismaCpeCode)

Relevante Kunden-, Produkt- und Schätzungscodes aus dem Mediaocean Prisma-Tool.

Gilt nur für Kampagnenbudgets mit einem externalBudgetSource von EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
preTaxAmountMicros

string (int64 format)

Die Summe der im Rahmen dieses Budgets angefallenen Kosten vor Steuern in Mikros in der Währung der Rechnung.

Wenn currencyCode beispielsweise USD ist, dann steht 1.000.000 für einen US-Dollar.
taxAmountMicros

string (int64 format)

Der Steuerbetrag, der auf Kosten im Rahmen dieses Budgets berechnet wird, in Mikros in der Währung der Rechnung.

Wenn currencyCode beispielsweise USD ist, dann steht 1.000.000 für einen US-Dollar.
totalAmountMicros

string (int64 format)

Die Gesamtsumme der im Rahmen dieses Budgets angefallenen Kosten, einschließlich Steuern, in „micros“ (millionstel Einheiten) in der Währung der Rechnung.

Wenn currencyCode beispielsweise USD ist, dann steht 1.000.000 für einen US-Dollar.