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/v1/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 aufgeführt werden sollen.

Abfrageparameter

Parameter
issueMonth

string

Der Monat, für den die Rechnungen aufgelistet werden sollen. Wenn die Richtlinie nicht konfiguriert ist, werden über die Anfrage die 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 gemäß Sapin-Gesetz abgerufen werden soll.

Gilt nur für Werbetreibende gemäß dem Sapin-Gesetz. Andernfalls wird sie ignoriert.
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 200 liegen. Wenn kein Wert angegeben ist, wird standardmäßig 100 verwendet. Gibt den Fehlercode INVALID_ARGUMENT zurück, wenn ein ungültiger Wert angegeben wird.
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 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 invoices.list-Methode im Feld pageToken, um die nächste Ergebnisseite abzurufen.

Dieses Token ist nicht vorhanden, wenn keine invoices mehr 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 Arten von Rechnungen für Werbetreibende gemäß Sapin-Gesetz.

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 auf der Rechnung im PDF-Format als Billing ID.
paymentsAccountId

string

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

Erscheint auf der Rechnung im PDF-Format 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, auf die sich diese Rechnung bezieht.
currencyCode

string

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

string (int64 format)

Die Zwischensumme vor Steuern in Mikros in der Währung der Rechnung.

Wenn currencyCode beispielsweise USD ist, dann entspricht 1.000000 einem US-Dollar.
totalTaxAmountMicros

string (int64 format)

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

Wenn currencyCode beispielsweise USD ist, dann entspricht 1.000000 einem US-Dollar.
totalAmountMicros

string (int64 format)

Der Rechnungsgesamtbetrag in „micros“, millionstel Einheiten der Rechnungswährung.

Wenn currencyCode beispielsweise USD ist, dann entspricht 1.000000 einem US-Dollar.
purchaseOrderNumber

string

Auftragsnummer, die der Rechnung zugeordnet ist.
budgetInvoiceGroupingId

string

Die Budgetgruppierungs-ID für diese Rechnung.

Dieses Feld wird nur festgelegt, wenn die Rechnungsebene des entsprechenden Abrechnungsprofils auf „ID der Rechnungsgruppe des Budgets“ festgelegt wurde.
invoiceType

enum (InvoiceType)

Die Art des Rechnungsdokuments.
correctedInvoiceId

string

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

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, sofern diese zu einer einzigen Rechnung zusammengefasst werden.

Kann auf der Rechnung als PDF-Datei 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. 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 7 Tage lang oder so lange gültig, bis die Rechnung noch einmal abgerufen wird.
budgetSummaries[]

object (BudgetSummary)

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

Dieses Feld wird nur festgelegt, wenn die Rechnungsdetails des entsprechenden Abrechnungsprofils auf „Bestellung auf Budgetebene“ festgelegt wurden.
nonBudgetMicros

string (int64 format)

Der 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 entspricht 1.000000 einem 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 Kosten, die im Rahmen dieses Budgets vor Steuern angefallen sind, in Mikros in der Währung der Rechnung.

Wenn currencyCode beispielsweise USD ist, dann entspricht 1.000000 einem US-Dollar.
taxAmountMicros

string (int64 format)

Der Steuerbetrag für Kosten im Rahmen dieses Budgets, in Mikros in der Währung der Rechnung.

Wenn currencyCode beispielsweise USD ist, dann entspricht 1.000000 einem US-Dollar.
totalAmountMicros

string (int64 format)

Die Gesamtsumme der Kosten, die im Rahmen dieses Budgets angefallen sind, einschließlich Steuern, in Mikros in der Währung der Rechnung.

Wenn currencyCode beispielsweise USD ist, dann entspricht 1.000000 einem US-Dollar.