- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- LoiSapinInvoiceType
- Faktura
- InvoiceType
- BudgetSummary
- Wypróbuj
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/v3/advertisers/{advertiserId}/invoices
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
advertiserId |
Wymagany. Identyfikator reklamodawcy, którego faktury mają być wyświetlane. |
Parametry zapytania
Parametry | |
---|---|
issueMonth |
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 |
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 |
Żądany rozmiar strony. Wartość musi się mieścić w zakresie |
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 jest pusta, nie będzie widoczna. |
nextPageToken |
Token do pobierania następnej strony wyników. Aby pobrać kolejną stronę wyników, prześlij tę wartość w polu Ten token nie będzie obecny, jeśli nie ma już żadnych |
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 ( |
Pola | |
---|---|
name |
Nazwa zasobu faktury. |
invoiceId |
Unikalny identyfikator faktury. |
displayName |
Wyświetlana nazwa faktury. |
paymentsProfileId |
Identyfikator profilu płatności, do którego należy faktura. W pliku PDF faktury jest widoczny jako |
paymentsAccountId |
Identyfikator konta płatności, do którego należy faktura. W pliku PDF faktury jest widoczny jako |
issueDate |
Data wystawienia faktury. |
dueDate |
Data płatności za fakturę. |
serviceDateRange |
daty rozpoczęcia i zakończenia usługi objętej tą fakturą. |
currencyCode |
Waluta użyta na fakturze w formacie ISO 4217. |
subtotalAmountMicros |
Suma częściowa przed podatkiem wyrażona w mikro w walucie faktury. Jeśli na przykład |
totalTaxAmountMicros |
Suma wszystkich podatków na fakturze wyrażona w milionowych częściach waluty faktury. Jeśli na przykład |
totalAmountMicros |
Łączna kwota faktury wyrażona w milionowych częściach waluty faktury. Jeśli na przykład |
purchaseOrderNumber |
Numer zamówienia powiązany z fakturą. |
budgetInvoiceGroupingId |
Identyfikator grupowania budżetu dla 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 |
Typ dokumentu faktury. |
correctedInvoiceId |
Identyfikator oryginalnej faktury, która jest korygowana przez tę fakturę (w odpowiednich przypadkach). Może być widoczny na fakturze PDF jako Jeśli ustawiona jest wartość |
replacedInvoiceIds[] |
Identyfikatory wszystkich pierwotnie wystawionych faktur, które są anulowane przez tę fakturę(w odpowiednich przypadkach). Jeśli faktury są konsolidowane w jedną fakturę, może być widocznych kilka faktur. W pliku PDF z fakturą może być widoczny jako Jeśli ustawiona jest wartość |
pdfUrl |
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
Adres URL będzie ważny przez 7 dni od pobrania obiektu faktury lub do momentu ponownego pobrania tej faktury. |
budgetSummaries[] |
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 rozliczeniowym został ustawiony na „Numer zamówienia na poziomie budżetu”. |
nonBudgetMicros |
Łączna kwota kosztów lub korekt nieprzypisanych do konkretnego budżetu w mikrowalutach waluty faktury. Jeśli na przykład |
InvoiceType
Możliwe typy faktur.
Wartości w polu enum | |
---|---|
INVOICE_TYPE_UNSPECIFIED |
Nie podano lub jest 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 ( |
Pola | |
---|---|
externalBudgetId |
Odpowiada |
prismaCpeCode |
odpowiednie kody klienta, produktu i szacowania z narzędzia Prisma firmy Mediaocean; Dotyczy tylko budżetów kampanii z wartością |
preTaxAmountMicros |
Suma obciążeń dokonanych w ramach tego budżetu przed podatkami w mikro w walucie faktury. Jeśli na przykład |
taxAmountMicros |
kwota podatku od obciążeń w ramach tego budżetu wyrażona w mikro w walucie faktury. Jeśli na przykład |
totalAmountMicros |
Łączna kwota obciążeń w ramach tego budżetu, w tym podatek, w mikrosach waluty faktury. Jeśli na przykład |