- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- LoiSapinInvoiceType
- Faktura
- InvoiceType
- BudgetSummary
- Wypróbuj
Zawiera listę faktur opublikowanych dla reklamodawcy w danym miesiącu.
Faktury generowane przez profile płatności z profilem „Partner” na poziomie faktury nie można tym sposobem.
Żądanie HTTP
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/invoices
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
advertiserId |
Wymagane. Identyfikator reklamodawcy, dla którego chcesz wyświetlić faktury. |
Parametry zapytania
Parametry | |
---|---|
issueMonth |
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 |
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 |
Żądany rozmiar strony. Wymagana wartość z zakresu od |
pageToken |
Token identyfikujący stronę wyników, którą serwer powinien zwrócić. Zwykle jest to wartość |
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 ( |
Pola | |
---|---|
invoices[] |
Lista faktur. Jeśli lista będzie pusta, nie będzie ona dostępna. |
nextPageToken |
Token do pobrania następnej strony wyników. Przekaż tę wartość w polu Ten token będzie brakował, jeśli nie będzie więcej elementów |
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 ( |
Pola | |
---|---|
name |
Nazwa zasobu faktury. |
invoiceId |
Niepowtarzalny identyfikator faktury. |
displayName |
Wyświetlana nazwa faktury. |
paymentsProfileId |
Identyfikator profilu płatności, do którego należy faktura. Na fakturze wyświetla się jako |
paymentsAccountId |
Identyfikator konta płatności, do którego należy faktura. Na fakturze wyświetla się jako |
issueDate |
Data wystawienia faktury. |
dueDate |
Data płatności faktury. |
serviceDateRange |
Daty rozpoczęcia i zakończenia świadczenia usługi uwzględnione na tej fakturze. |
currencyCode |
Waluta użyta na fakturze w formacie ISO 4217. |
subtotalAmountMicros |
Kwota sumy częściowej przed naliczeniem podatku wyrażona w milionowych częściach waluty faktury. Jeśli np. |
totalTaxAmountMicros |
Suma wszystkich podatków na fakturze w mikrowalucie. Jeśli np. |
totalAmountMicros |
Łączna kwota na fakturze w milionowych częściach waluty faktury. Jeśli np. |
purchaseOrderNumber |
Numer zamówienia powiązany z fakturą. |
budgetInvoiceGroupingId |
Identyfikator grupowania budżetu na potrzeby tej faktury. To pole zostanie ustawione tylko wtedy, gdy poziom faktury w odpowiednim profilu płatności będzie miał ustawienie „Identyfikator grupowania faktur z budżetu”. |
invoiceType |
Typ dokumentu faktury. |
correctedInvoiceId |
Identyfikator pierwotnej faktury, której korekta dotyczy (jeśli dotyczy). Na fakturze może występować jako Jeśli ustawiono |
replacedInvoiceIds[] |
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 Jeśli ustawiono |
pdfUrl |
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
Adres URL będzie ważny przez 7 dni od pobrania tego obiektu faktury lub do czasu ponownego pobrania tej faktury. |
budgetSummaries[] |
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 |
Łączna kwota kosztów lub korekt niepowiązanych z konkretnym budżetem, w mikro walutach faktury. Jeśli np. |
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 ( |
Pola | |
---|---|
externalBudgetId |
Odpowiada |
prismaCpeCode |
Odpowiednie kody dotyczące klientów, usług i szacunków z narzędzia Mediaocean Prisma. Dotyczy tylko budżetów kampanii z |
preTaxAmountMicros |
Suma opłat dokonanych w ramach tego budżetu przed opodatkowaniem, w mikrowalucie faktury. Jeśli np. |
taxAmountMicros |
Kwota podatku stosowana do opłat w ramach tego budżetu w mikro waluty faktury. Jeśli np. |
totalAmountMicros |
Łączna suma opłat dokonanych w ramach tego budżetu (wraz z podatkiem) w milionowych częściach waluty faktury. Jeśli np. |