Method: advertisers.invoices.list

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

Tej metody nie można pobrać za pomocą faktur wygenerowanych przez profile płatności na poziomie „Partner”.

Żądanie HTTP

GET https://displayvideo.googleapis.com/v2/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, dla którego mają być wyświetlane faktury. Jeśli jej nie skonfigurujesz, żądanie pobierze faktury z poprzedniego miesiąca.

Musi mieć format RRRRMM.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

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

Dotyczy tylko reklamodawców korzystających z loi Sapin. W przeciwnym razie zostanie zignorowana.
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 identyfikujący stronę z wynikami, który powinien zwrócić serwer. Zwykle jest to wartość nextPageToken zwrócona z poprzedniego wywołania metody invoices.list. Jeśli nie podasz żadnej wartości, wyświetlana 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 widać.
nextPageToken

string

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

Ten token nie będzie dostępny, jeśli nie będzie więcej 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 omówieniu protokołu OAuth 2.0.

LoiSapinInvoiceType

Możliwe rodzaje faktur dla reklamodawców objętych Loi Sapin.

Wartości w polu enum
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED Wartość nie jest 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

Niepowtarzalny identyfikator faktury.
displayName

string

Wyświetlana nazwa faktury.
paymentsProfileId

string

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

Na fakturze w formacie PDF pojawia się jako Billing ID.
paymentsAccountId

string

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

Na fakturze w formacie PDF pojawia się jako 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 objęte tą fakturą.
currencyCode

string

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

string (int64 format)

Suma częściowa przed naliczeniem podatku wyrażona w milionach walut na fakturze.

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

string (int64 format)

Suma wszystkich podatków na fakturze w częściach walutowych.

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

string (int64 format)

Łączna kwota na fakturze wyrażona w procentach waluty faktury.

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

string

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

string

Identyfikator grupowania budżetu na potrzeby tej faktury.

To pole zostanie skonfigurowane tylko wtedy, gdy poziom faktury odpowiedniego profilu płatności został ustawiony na „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).

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

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

string

Identyfikatory każdej pierwotnie wystawionej faktury, która została anulowana na podstawie tej faktury(w stosownych przypadkach). Jeśli faktura zostanie scalona w jedną fakturę, może być widocznych wiele faktur.

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

Jeśli skonfigurowano ustawienie correctedInvoiceId, to pole jest puste.
pdfUrl

string

adres URL, pod którym można pobrać fakturę 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 mieć autoryzację 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 faktury lub do czasu ponownego pobrania tej faktury.
budgetSummaries[]

object (BudgetSummary)

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

To pole zostanie skonfigurowane tylko wtedy, gdy poziom szczegółów faktury odpowiedniego 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 walutowych na fakturze.

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

InvoiceType

Możliwe typy faktur.

Wartości w polu enum
INVOICE_TYPE_UNSPECIFIED Nie określono lub jest nieznana w tej wersji.
INVOICE_TYPE_CREDIT Kwota na fakturze jest ujemna.
INVOICE_TYPE_INVOICE Faktura zawiera kwotę dodatnią.

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 ta wartość nie jest ustawiona w budżecie kampanii, to pole jest puste.
prismaCpeCode

object (PrismaCpeCode)

Odpowiednie kody klienta, usług i szacunków z narzędzia Mediaocean Prisma.

Ma zastosowanie tylko w przypadku budżetów kampanii z externalBudgetSource wynoszącym EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
preTaxAmountMicros

string (int64 format)

Suma opłat naliczonych w ramach tego budżetu przed opodatkowaniem, w milionowych częściach waluty faktury.

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

string (int64 format)

Kwota podatku naliczona do opłat w ramach tego budżetu, wyrażona w częściach waluty faktury.

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

string (int64 format)

Łączna suma opłat naliczonych w ramach tego budżetu, z podatkiem, wyrażona w milionowych częściach waluty faktury.

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