Method: advertisers.invoices.list

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

W ten sposób nie można odzyskać faktur wygenerowanych przez profile płatności na poziomie faktury „Partner”.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

To pole jest wymagane. Identyfikator reklamodawcy, dla którego mają zostać wyświetlone faktury.

Parametry zapytania

Parametry
issueMonth

string

Miesiąc, za który mają być wyświetlone faktury. Jeśli jej nie skonfigurujesz, żądanie spowoduje pobranie faktur z poprzedniego miesiąca.

Musi mieć format RRRRMM.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Wybierz typ faktury, którą chcesz pobrać dla reklamodawców objętych ustawą Loi Sapin.

Dotyczy tylko reklamodawców objętych ustawą Loi Sapin. W przeciwnym razie będzie ignorowany.
pageSize

integer

Żądany rozmiar strony. Wartość musi mieścić się w zakresie od 1 do 200. Jeśli nie określono inaczej, domyślnie przyjmuje się wartość 100. Zwraca kod błędu INVALID_ARGUMENT, jeśli określono nieprawidłową wartość.
pageToken

string

Token określający stronę z wynikami zwracanymi przez serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody invoices.list. Jeśli nie podasz tych danych, zwracana jest 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.

Tej listy nie będzie, jeśli będzie pusta.
nextPageToken

string

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

Jeśli nie będzie już żadnych invoices do zwrócenia, token będzie niedostępny.

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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 rodzaje faktur dla reklamodawców objętych ustawą 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

Pojedyncza 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

Unikalny identyfikator faktury.
displayName

string

Wyświetlana nazwa faktury.
paymentsProfileId

string

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

Na fakturze PDF ma postać Billing ID.
paymentsAccountId

string

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

Na fakturze PDF ma postać 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)

Suma częściowa przed opodatkowaniem (w częściach walutowych) waluty na fakturze.

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

string (int64 format)

Suma wszystkich podatków na fakturze, w milionowych częściach waluty faktury.

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

string (int64 format)

Łączna kwota na fakturze wyrażona w mikrojach jej waluty.

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

string

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

string

Identyfikator grupowania budżetu dla tej faktury.

To pole zostanie ustawione tylko wtedy, gdy poziom faktury w odpowiednim profilu płatności miał ustawienie „Identyfikator grupowania faktur pod kątem budżetu”.
invoiceType

enum (InvoiceType)

Typ dokumentu faktury.
correctedInvoiceId

string

Identyfikator oryginalnej faktury korygowanej przez tę fakturę (w stosownych przypadkach).

Na fakturze w formacie PDF może mieć postać Reference invoice number.

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

string

Identyfikatory każdej pierwotnie wystawionej faktury, która została anulowana przez tę fakturę(w stosownych przypadkach). Jeśli faktury zostaną połączone w jedną fakturę, może być widocznych wiele faktur.

Na fakturze PDF może być widoczny 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 przeznaczony dla użytkownika i wymaga prawidłowego tokena dostępu OAuth 2.0. Token dostępu należy podać w nagłówku HTTP Authorization: Bearer i musi być autoryzowany do 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 na fakturze lub do 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 częściach milionowych walut na fakturze.

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

InvoiceType

Możliwe typy faktur.

Wartości w polu enum
INVOICE_TYPE_UNSPECIFIED Nie określono lub jest nieznany 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 wartości externalBudgetId budżetu kampanii. Jeśli budżet kampanii nie ma określonej wartości, to pole jest puste.
prismaCpeCode

object (PrismaCpeCode)

Odpowiednie kody klientów, produktów i szacunków z narzędzia Mediaocean Prisma.

Dotyczy tylko budżetów kampanii o wartości externalBudgetSource w wysokości EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
preTaxAmountMicros

string (int64 format)

Suma opłat naliczonych w ramach tego budżetu przed opodatkowaniem, w częściach walutowych walut na fakturze.

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

string (int64 format)

Kwota podatku nałożona na opłaty w ramach tego budżetu, wyrażona w częściach walutowych waluty faktury.

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

string (int64 format)

Łączna suma opłat naliczonych w ramach tego budżetu, z uwzględnieniem podatków, w częściach walut na fakturze.

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