Method: advertisers.invoices.list

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

Rechnungen, die von Abrechnungsprofilen mit der Rechnungsstellungsebene „Partner“ generiert werden, 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. Wenn nichts angegeben ist, werden mit der Anfrage Rechnungen für den Vormonat abgerufen.

Muss im Format JJJJMM vorliegen.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Wählen Sie den Rechnungsart aus, die für Loi Sapin-Werbetreibende abgerufen werden soll.

Gilt nur für Werbetreibende, die dem Loi Sapin unterliegen. Andernfalls wird sie ignoriert.
pageSize

integer

Angeforderte Seitengröße. Muss zwischen 1 und 200 liegen. Wenn nicht angegeben, 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. Normalerweise 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.

Wenn die Liste leer ist, ist sie nicht vorhanden.
nextPageToken

string

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

Dieses Token ist nicht vorhanden, wenn keine weiteren invoices zurückgegeben werden müssen.

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 unter OAuth 2.0 Overview.

LoiSapinInvoiceType

Mögliche Rechnungstypen für Werbetreibende, die dem Sapin-Gesetz unterliegen.

Enums
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED Wert 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.

Wird in der PDF-Rechnung als Billing ID angezeigt.
paymentsAccountId

string

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

Wird in der PDF-Rechnung als Billing Account Number angezeigt.
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 des Dienstes, der in dieser Rechnung enthalten ist.
currencyCode

string

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

string (int64 format)

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

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

string (int64 format)

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

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

string (int64 format)

Der Rechnungsbetrag insgesamt in Mikroeinheiten der Währung der Rechnung.

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

string

Die mit der Rechnung verknüpfte Auftragsnummer.
budgetInvoiceGroupingId

string

Die ID der Budgetgruppe 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)

Der Typ des Rechnungsdokuments.
correctedInvoiceId

string

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

Wird möglicherweise in der PDF-Rechnung als Reference invoice number angezeigt.

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

string

Die ID(s) aller ursprünglich ausgestellten Rechnungen, die durch diese Rechnung storniert werden (falls zutreffend). Wenn mehrere Rechnungen in einer einzigen Rechnung konsolidiert werden, können sie alle aufgeführt sein.

Kann in der PDF-Rechnung als Replaced invoice numbers angezeigt werden.

Wenn correctedInvoiceId festgelegt ist, ist dieses Feld leer.
pdfUrl

string

Die URL zum Herunterladen einer PDF-Kopie der Rechnung.

Diese URL ist nutzerspezifisch und erfordert ein gültiges OAuth 2.0-Zugriffstoken. 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 sieben Tage lang gültig oder bis diese Rechnung noch einmal abgerufen wird.
budgetSummaries[]

object (BudgetSummary)

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

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

string (int64 format)

Der Gesamtbetrag der Kosten oder Anpassungen, die nicht an ein bestimmtes Budget gebunden sind, in Mikros der Währung der Rechnung.

Wenn currencyCode beispielsweise USD ist, entspricht 1.000.000 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 weist einen negativen Betrag auf.
INVOICE_TYPE_INVOICE Die Rechnung weist einen positiven Betrag auf.

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 Client-, Produkt- und Schätzcodes 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 Gebühren, die im Rahmen dieses Budgets vor Steuern in Mikros der Währung der Rechnung anfallen.

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

string (int64 format)

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

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

string (int64 format)

Die Gesamtsumme der Gebühren, die im Rahmen dieses Budgets anfallen, einschließlich Steuern, in Mikroeinheiten der Währung der Rechnung.

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