Method: advertisers.invoices.list

Wyświetla faktury wystawione dla reklamodawcy w danym miesiącu.

Faktur wygenerowanych przez profile płatności z poziomem faktury „Partner” nie można pobrać za pomocą tej metody.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
advertiserId

string (int64 format)

Wymagane. Identyfikator reklamodawcy, którego faktury mają być wyświetlane.

Parametry zapytania

Parametry
issueMonth

string

Miesiąc, w którym mają być wyświetlane faktury. Jeśli nie zostanie ustawiony, żądanie pobierze faktury za poprzedni miesiąc.

Musi mieć format RRRRMM.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Wybierz typ faktury, którą chcesz pobrać dla reklamodawców we Francji.

Dotyczy to tylko reklamodawców z Francji. W przeciwnym razie zostanie zignorowany.
pageSize

integer

Żądany rozmiar strony. Wartość musi się mieścić w zakresie 1–200. Jeśli nie podasz żadnej wartości, zostanie użyta wartość domyślna 100. Jeśli podana zostanie nieprawidłowa wartość, zwraca kod błędu INVALID_ARGUMENT.
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 zostanie określony, zwrócona zostanie 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 jest pusta, nie będzie widoczna.
nextPageToken

string

Token do pobierania następnej strony wyników. Aby pobrać kolejną stronę wyników, prześlij tę wartość w polu pageToken w kolejnych wywołaniach metody invoices.list.

Ten token nie będzie obecny, jeśli nie ma już żadnych invoices do zwrócenia.

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

LoiSapinInvoiceType

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

Wartości w polu enum
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED Nie określono wartości.
LOI_SAPIN_INVOICE_TYPE_MEDIA faktury z koszty 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

Unikalny 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.

W pliku PDF faktury jest widoczny jako Billing Account Number.
issueDate

object (Date)

Data wystawienia faktury.
dueDate

object (Date)

Data płatności za fakturę.
serviceDateRange

object (DateRange)

daty rozpoczęcia i zakończenia usługi objętej tą fakturą.
currencyCode

string

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

string (int64 format)

Suma częściowa przed podatkiem wyrażona w mikro w walucie faktury.

Jeśli na przykład currencyCode to USD, to 1000000 to 1 dolar amerykański.
totalTaxAmountMicros

string (int64 format)

Suma wszystkich podatków na fakturze wyrażona w milionowych częściach waluty faktury.

Jeśli na przykład currencyCode to USD, to 1000000 to 1 dolar amerykański.
totalAmountMicros

string (int64 format)

Łączna kwota faktury wyrażona w milionowych częściach waluty faktury.

Jeśli na przykład currencyCode to USD, to 1000000 to 1 dolar amerykański.
purchaseOrderNumber

string

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

string

Identyfikator grupowania budżetu dla tej faktury.

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

enum (InvoiceType)

Typ dokumentu faktury.
correctedInvoiceId

string

Identyfikator oryginalnej faktury, która jest korygowana przez tę fakturę (w odpowiednich przypadkach).

Może być widoczny na fakturze PDF jako Reference invoice number.

Jeśli ustawiona jest wartość replacedInvoiceIds, to pole będzie puste.
replacedInvoiceIds[]

string

Identyfikatory wszystkich pierwotnie wystawionych faktur, które są anulowane przez tę fakturę(jeśli dotyczy). Jeśli faktury są konsolidowane w jedną fakturę, może być widocznych kilka faktur.

W pliku PDF z fakturą może być widoczny jako Replaced invoice numbers.

Jeśli ustawiona jest wartość correctedInvoiceId, to pole będzie puste.
pdfUrl

string

Adres URL do pobrania kopii faktury w formacie PDF.

Ten adres URL jest specyficzny dla 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 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 obiektu faktury lub do momentu ponownego pobrania tej faktury.
budgetSummaries[]

object (BudgetSummary)

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

To pole zostanie ustawione tylko wtedy, gdy poziom szczegółów faktury odpowiadającego profilu rozliczeniowego został ustawiony na „Numer zamówienia na poziomie budżetu”.
nonBudgetMicros

string (int64 format)

Łączna kwota kosztów lub korekt nieprzypisanych do konkretnego budżetu w mikrowalutach waluty faktury.

Jeśli na przykład currencyCode to USD, to 1000000 to 1 dolar amerykański.

InvoiceType

Możliwe typy faktur.

Wartości w polu enum
INVOICE_TYPE_UNSPECIFIED Nie podano lub nieznany w tej wersji.
INVOICE_TYPE_CREDIT Kwota na fakturze jest ujemna.
INVOICE_TYPE_INVOICE faktura ma dodatnią kwotę;

BudgetSummary

Podsumowanie informacji o budżecie pojedynczej kampanii.

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

string

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

object (PrismaCpeCode)

odpowiednie kody klienta, produktu i szacowania z narzędzia Prisma firmy Mediaocean;

Dotyczy tylko budżetów kampanii z wartością externalBudgetSource EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
preTaxAmountMicros

string (int64 format)

Suma obciążeń dokonanych w ramach tego budżetu przed podatkami w mikro w walucie faktury.

Jeśli na przykład currencyCode to USD, to 1000000 to 1 dolar amerykański.
taxAmountMicros

string (int64 format)

kwota podatku od obciążeń w ramach tego budżetu wyrażona w mikro w walucie faktury.

Jeśli na przykład currencyCode to USD, to 1000000 to 1 dolar amerykański.
totalAmountMicros

string (int64 format)

Łączna kwota obciążeń w ramach tego budżetu, w tym podatek, w mikrosach waluty faktury.

Jeśli na przykład currencyCode to USD, to 1000000 to 1 dolar amerykański.