Method: advertisers.invoices.list

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

Faktur wygenerowanych przez profile płatności z poziomem faktury „Partner” nie można pobrać tą metodą.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v3/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 mają być wyświetlane faktury. Jeśli nie zostanie ustawiona, żądanie pobierze faktury za poprzedni miesiąc.

Musi mieć format RRRRMM.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Wybierz typ faktury, którą chcesz pobrać dla reklamodawców podlegających ustawie Loi Sapin.

Dotyczy to tylko reklamodawców podlegających ustawie Loi Sapin. W przeciwnym razie zostanie zignorowany.
pageSize

integer

Żądany rozmiar strony. Wartość musi mieścić się w przedziale od 1 do 200. Jeśli nie podasz tu żadnej wartości, zostanie użyta wartość domyślna 100. Jeśli podano nieprawidłową 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ślona, zwracana będzie 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 jej w tym miejscu.
nextPageToken

string

Token do pobierania 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.

Jeśli nie ma już więcej invoices do zwrócenia, ten token nie będzie obecny.

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 sekcji 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 kosztem mediów.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Faktury z opłatą za platformę.

Faktura

jedną fakturę,

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 pojawia się jako Billing ID.
paymentsAccountId

string

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

Na fakturze PDF pojawia się jako Billing Account Number.
issueDate

object (Date)

data wystawienia faktury;
dueDate

object (Date)

Data, w której przypada termin płatności faktury.
serviceDateRange

object (DateRange)

Daty rozpoczęcia i zakończenia usługi, które obejmuje ta faktura.
currencyCode

string

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

string (int64 format)

Kwota częściowa przed opodatkowaniem wyrażona w milionowych częściach waluty faktury.

Jeśli na przykład currencyCode to USD, wartość 1000000 oznacza 1 dolara amerykańskiego.
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, wartość 1000000 oznacza 1 dolara amerykańskiego.
totalAmountMicros

string (int64 format)

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

Jeśli na przykład currencyCode to USD, wartość 1000000 oznacza 1 dolara amerykańskiego.
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 został ustawiony na „Identyfikator grupowania faktur za budżet”.
invoiceType

enum (InvoiceType)

Typ dokumentu faktury.
correctedInvoiceId

string

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

Może pojawić się na fakturze w formacie PDF jako Reference invoice number.

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

string

Identyfikatory pierwotnie wystawionych faktur, które są anulowane przez tę fakturę(w odpowiednich przypadkach). Jeśli faktury są konsolidowane w jedną fakturę, może być wyświetlonych kilka faktur.

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

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

string

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

Ten adres URL jest przypisany do konkretnego 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 w jednym 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 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 w odpowiednim profilu płatności został ustawiony na „Numer zamówienia na poziomie budżetu”.
nonBudgetMicros

string (int64 format)

Łączna kwota kosztów lub korekt niezwiązanych z określonym budżetem, wyrażona w mikro waluty faktury.

Jeśli na przykład currencyCode to USD, wartość 1000000 oznacza 1 dolara amerykańskiego.

InvoiceType

Możliwe typy faktur.

Wartości w polu enum
INVOICE_TYPE_UNSPECIFIED Nieokreślony lub nieznany w tej wersji.
INVOICE_TYPE_CREDIT Faktura ma ujemną kwotę.
INVOICE_TYPE_INVOICE Faktura ma kwotę dodatnią.

BudgetSummary

Podsumowane informacje o indywidualnym budżecie kampanii.

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

string

Odpowiada externalBudgetId budżetu kampanii. Jeśli wartość nie jest ustawiona w budżecie kampanii, to pole będzie puste.
prismaCpeCode

object (PrismaCpeCode)

Odpowiednie kody klienta, usługi i wartości szacunkowych z narzędzia Mediaocean Prisma.

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

string (int64 format)

Suma opłat naliczonych w ramach tego budżetu przed opodatkowaniem, wyrażona w mikro w walucie faktury.

Jeśli na przykład currencyCode to USD, wartość 1000000 oznacza 1 dolara amerykańskiego.
taxAmountMicros

string (int64 format)

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

Jeśli na przykład currencyCode to USD, wartość 1000000 oznacza 1 dolara amerykańskiego.
totalAmountMicros

string (int64 format)

Łączna suma opłat naliczonych w ramach tego budżetu, łącznie z podatkiem, w mikrojednostkach waluty faktury.

Jeśli na przykład currencyCode to USD, wartość 1000000 oznacza 1 dolara amerykańskiego.