Method: advertisers.invoices.list

Zawiera listę faktur opublikowanych dla reklamodawcy w danym miesiącu.

Faktury generowane przez profile płatności z uprawnieniami „Partnera” na poziomie faktury nie można tym sposobem.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

Wymagane. Identyfikator reklamodawcy, dla którego chcesz wyświetlić faktury.

Parametry zapytania

Parametry
issueMonth

string

Miesiąc, dla którego ma być wyświetlana lista faktur. Jeśli jej nie skonfigurujesz, żądanie spowoduje pobranie faktur z poprzedniego miesiąca.

Musi mieć format RRRRMM.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Wybierz typ faktury do pobrania dla reklamodawców podlegających Loi Sapin.

Dotyczy tylko reklamodawców korzystających z Loi Sapin. W przeciwnym razie zostanie zignorowana.
pageSize

integer

Żądany rozmiar strony. Wymagana wartość z zakresu od 1 do 200. Jeśli nie określono inaczej, domyślna wartość to 100. Zwraca kod błędu INVALID_ARGUMENT w przypadku określenia nieprawidłowej wartości.
pageToken

string

Token identyfikujący stronę wyników, którą serwer powinien zwrócić. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody invoices.list. Jeśli nie określono tego ustawienia, zostanie zwrócona pierwsza strona wyników.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
Pola
invoices[]

object (Invoice)

Lista faktur.

Jeśli lista będzie pusta, nie będzie ona dostępna.
nextPageToken

string

Token do pobrania następnej strony wyników. Przekaż tę wartość w polu pageToken w kolejnym wywołaniu metody invoices.list, aby pobrać następną stronę wyników.

Ten token będzie brakował, jeśli nie będzie więcej elementów invoices do zwrócenia.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.

LoiSapinInvoiceType

Możliwe typy faktur dla reklamodawców podlegających Loi Sapin.

Wartości w polu enum
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED Wartość nie została określona.
LOI_SAPIN_INVOICE_TYPE_MEDIA Faktury z kosztem mediów.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Faktury z opłatą za platformę.

Faktura

Jedna faktura.

Zapis 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
}
Pola
name

string

Nazwa zasobu faktury.
invoiceId

string

Niepowtarzalny identyfikator faktury.
displayName

string

Wyświetlana nazwa faktury.
paymentsProfileId

string

Identyfikator profilu płatności, do którego należy faktura.

W pliku PDF faktury jest widoczny jako Billing ID.
paymentsAccountId

string

Identyfikator konta płatności, do którego należy faktura.

Na fakturze wyświetla się jako Billing Account Number.
issueDate

object (Date)

Data wystawienia faktury.
dueDate

object (Date)

Data płatności faktury.
serviceDateRange

object (DateRange)

Daty rozpoczęcia i zakończenia świadczenia usługi uwzględnione na tej fakturze.
currencyCode

string

Waluta użyta na fakturze w formacie ISO 4217.
subtotalAmountMicros

string (int64 format)

Kwota sumy częściowej przed naliczeniem podatku wyrażona w milionowych częściach waluty faktury.

Jeśli np. currencyCode to USD, to 1000000 oznacza jeden dolar amerykański.
totalTaxAmountMicros

string (int64 format)

Suma wszystkich podatków na fakturze w mikrowalucie.

Jeśli np. currencyCode to USD, to 1000000 oznacza jeden dolar amerykański.
totalAmountMicros

string (int64 format)

Łączna kwota na fakturze w milionowych częściach waluty faktury.

Jeśli np. currencyCode to USD, to 1000000 oznacza jeden dolar amerykański.
purchaseOrderNumber

string

Numer zamówienia powiązany z fakturą.
budgetInvoiceGroupingId

string

Identyfikator grupowania budżetu na potrzeby tej faktury.

To pole będzie ustawione tylko wtedy, gdy poziom faktury w odpowiadającym profilowi rozliczeniowemu został ustawiony na „Identyfikator grupowania faktur budżetowych”.
invoiceType

enum (InvoiceType)

Typ dokumentu faktury.
correctedInvoiceId

string

Identyfikator pierwotnej faktury, której korekta dotyczy (jeśli dotyczy).

Na fakturze może występować jako Reference invoice number.

Jeśli ustawiono replacedInvoiceIds, to pole jest puste.
replacedInvoiceIds[]

string

Identyfikatory wszystkich pierwotnie wystawionych faktur, które zostały anulowane przez tę fakturę(w stosownych przypadkach). Możesz podać kilka faktur, jeśli są one skonsolidowane w jedną fakturę.

Może pojawić się na fakturze w formacie PDF jako Replaced invoice numbers.

Jeśli ustawiono correctedInvoiceId, to pole jest puste.
pdfUrl

string

Adres URL, pod którym można pobrać kopię faktury w formacie PDF.

Ten adres URL jest przypisany do użytkownika i wymaga prawidłowego tokena dostępu OAuth 2.0. Token dostępu musi być podany w nagłówku HTTP Authorization: Bearer i autoryzowany dla jednego z tych zakresów:

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

Adres URL będzie ważny przez 7 dni od pobrania tego obiektu faktury lub do czasu ponownego pobrania tej faktury.
budgetSummaries[]

object (BudgetSummary)

Lista podsumowania informacji o każdym budżecie powiązanym z tą fakturą.

To pole zostanie ustawione tylko wtedy, gdy poziom szczegółów faktury w odpowiednim profilu płatności został ustawiony na „Zamówienie na poziomie budżetu”.
nonBudgetMicros

string (int64 format)

Łączna kwota kosztów lub korekt niepowiązanych z konkretnym budżetem, w mikro walutach faktury.

Jeśli np. currencyCode to USD, to 1000000 oznacza jeden dolar amerykański.

InvoiceType

Możliwe typy faktur.

Wartości w polu enum
INVOICE_TYPE_UNSPECIFIED Wartość nie została określona lub jest nieznana w tej wersji.
INVOICE_TYPE_CREDIT Faktura zawiera kwotę ujemną.
INVOICE_TYPE_INVOICE Faktura zawiera kwotę dodatnią.

BudgetSummary

Podsumowanie informacji o budżecie poszczególnych kampanii.

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

string

Odpowiada externalBudgetId budżetu kampanii. Jeśli nie ustawisz tej wartości w budżecie kampanii, to pole będzie puste.
prismaCpeCode

object (PrismaCpeCode)

Odpowiednie kody dotyczące klientów, usług i szacunków z narzędzia Mediaocean Prisma.

Dotyczy tylko budżetów kampanii z externalBudgetSource wynoszącą EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
preTaxAmountMicros

string (int64 format)

Suma opłat dokonanych w ramach tego budżetu przed opodatkowaniem, w mikrowalucie faktury.

Jeśli np. currencyCode to USD, to 1000000 oznacza jeden dolar amerykański.
taxAmountMicros

string (int64 format)

Kwota podatku stosowana do opłat w ramach tego budżetu w mikro waluty faktury.

Jeśli np. currencyCode to USD, to 1000000 oznacza jeden dolar amerykański.
totalAmountMicros

string (int64 format)

Łączna suma opłat dokonanych w ramach tego budżetu (wraz z podatkiem) w milionowych częściach waluty faktury.

Jeśli np. currencyCode to USD, to 1000000 oznacza jeden dolar amerykański.