Method: advertisers.invoices.list

Listet die Rechnungen auf, die für einen Werbetreibenden in einem bestimmten Monat gepostet wurden.

Von Abrechnungsprofilen mit einem „Partner“ generierte Rechnungen Rechnungsebene können mit dieser Methode nicht abgerufen werden.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
advertiserId

string (int64 format)

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

Abfrageparameter

Parameter
issueMonth

string

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

Muss das Format JJJJMM haben.
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, die das Sapin-Gesetz verwenden. Andernfalls wird sie 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 ist.
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 Methode invoices.list zurückgegeben wurde. Wenn keine Angabe erfolgt, 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 ist nicht vorhanden, 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 Methode invoices.list im Feld pageToken, um die nächste Ergebnisseite abzurufen.

Dieses Token ist nicht vorhanden, wenn keine weiteren invoices zurückgegeben werden können.

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 Werbetreibende, die das Sapin-Gesetz verwenden.

Enums
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED Der Wert ist nicht 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

Die eindeutige ID der Rechnung.
displayName

string

Der Anzeigename der Rechnung.
paymentsProfileId

string

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

Erscheint in der PDF-Rechnung als Billing ID.
paymentsAccountId

string

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

Erscheint in der PDF-Rechnung 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 in dieser Rechnung berücksichtigt werden.
currencyCode

string

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

string (int64 format)

Die Zwischensumme vor Steuern, in millionstel Einheiten der Rechnungswährung.

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

string (int64 format)

Die Summe aller Steuern auf der Rechnung in millionstel Einheiten der Rechnungswährung.

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

string (int64 format)

Der Gesamtbetrag der Rechnung in millionstel Einheiten der Rechnungswährung.

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 festgelegt, wenn die Rechnungsebene des entsprechenden Abrechnungsprofils auf „ID der Budgetrechnungsgruppe“ festgelegt wurde.
invoiceType

enum (InvoiceType)

Die Art des Rechnungsdokuments.
correctedInvoiceId

string

Die ID der ursprünglichen Rechnung, die gegebenenfalls durch diese Rechnung angepasst wird.

Kann in der PDF-Datei der Rechnung als „Reference invoice number“ erscheinen.

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

string

Die ID(s) einer ursprünglich ausgestellten Rechnung, die durch diese Rechnung storniert wird, sofern zutreffend. Es können mehrere Rechnungen aufgelistet werden, wenn diese zu einer einzigen Rechnung zusammengefasst werden.

Kann in der PDF-Datei der Rechnung 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 nutzerspezifisch und für den Zugriff ist ein gültiges OAuth 2.0-Zugriffstoken erforderlich. Das Zugriffstoken muss in einem Authorization: Bearer-HTTP-Header angegeben 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 sieben Tage oder bis zum erneuten Abrufen der Rechnung gültig.
budgetSummaries[]

object (BudgetSummary)

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

Dieses Feld wird nur festgelegt, wenn die Rechnungsdetailebene des entsprechenden Abrechnungsprofils auf „Auftrag auf Budgetebene“ festgelegt wurde.
nonBudgetMicros

string (int64 format)

Gesamtbetrag der Kosten oder Korrekturen, die nicht an ein bestimmtes Budget gebunden sind, in Mikros 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 weist einen negativen Betrag auf.
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 kein Wert im Kampagnenbudget festgelegt wurde, 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 der Rechnungswährung.

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

string (int64 format)

Der Steuerbetrag, der auf Gebühren im Rahmen dieses Budgets angewendet wird, in Mikros der Rechnungswährung.

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 Mikros der Rechnungswährung.

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