本頁面由 Cloud Translation API 翻譯而成。

Method: advertisers.invoices.list

HTTP 要求
路徑參數
查詢參數
要求主體
回應主體
- JSON 表示法
授權範圍
LoiSapinInvoiceType
月結單
- JSON 表示法
InvoiceType
BudgetSummary
- JSON 表示法
試試看！

列出廣告客戶於當月張貼的月結單。

您無法透過這個方法擷取採用「合作夥伴」月結單層級的帳單資料所產生的月結單。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數

參數
`advertiserId`	`string (int64 format)` 必要欄位。要列出月結單的廣告主 ID。

advertiserId

string (int64 format)

必要欄位。要列出月結單的廣告主 ID。

查詢參數

參數
`issueMonth`	`string` 要列出月結單的月份。如未設定，要求就會擷取上個月的月結單。格式必須為 YYYYMM。
`loiSapinInvoiceType`	`enum (LoiSapinInvoiceType)` 請為 Loi Sapin 廣告主選取要擷取的月結單類型。僅適用於 Loi Sapin 廣告主。否則將遭到忽略。
`pageSize`	`integer` 要求的頁面大小。必須介於 `1` 至 `200` 之間。如果未指定，則預設值為 `100`。如果指定無效值，則傳回錯誤代碼 `INVALID_ARGUMENT`。
`pageToken`	`string` 用於識別伺服器應傳回結果頁面的符記。一般而言，這是先前呼叫 `invoices.list` 方法後傳回的 `nextPageToken` 值。如未指定，系統會傳回第一頁的結果。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法
{ "invoices": [ { object (`Invoice`) } ], "nextPageToken": string }

欄位

欄位
`invoices[]`	`object (Invoice)` 應付憑據清單。如果空白，這份清單就不會顯示。
`nextPageToken`	`string` 用於擷取下一頁結果的符記。在對 `invoices.list` 方法的後續呼叫中，將這個值傳入 `pageToken` 欄位，擷取下一頁的結果。如果沒有其他可傳回的 `invoices`，就不會出現這個權杖。

invoices[]

object (Invoice)

應付憑據清單。

如果空白，這份清單就不會顯示。

nextPageToken

string

用於擷取下一頁結果的符記。在對 invoices.list 方法的後續呼叫中，將這個值傳入 pageToken 欄位，擷取下一頁的結果。

如果沒有其他可傳回的 invoices，就不會出現這個權杖。

授權範圍

需要下列其中一種 OAuth 範圍：

https://www.googleapis.com/auth/display-video
https://www.googleapis.com/auth/display-video-mediaplanning

詳情請參閱 OAuth 2.0 總覽。

LoiSapinInvoiceType

Loi Sapin 廣告客戶可能適用的月結單類型。

列舉
`LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED`	未指定值。
`LOI_SAPIN_INVOICE_TYPE_MEDIA`	包含媒體費用的月結單。
`LOI_SAPIN_INVOICE_TYPE_PLATFORM`	含有平台費用的月結單。

應付憑據

一筆應付憑據。

JSON 表示法

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 }

{
  "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
}

欄位
`name`	`string` 應付憑據的資源名稱。
`invoiceId`	`string` 應付憑據的專屬 ID。
`displayName`	`string` 月結單的顯示名稱。
`paymentsProfileId`	`string` 應付憑據所屬的付款資料 ID。這組號碼在應付憑據的 PDF 中會顯示為 `Billing ID`。
`paymentsAccountId`	`string` 應付憑據所屬的付款帳戶 ID。這組號碼在應付憑據的 PDF 中會顯示為 `Billing Account Number`。
`issueDate`	`object (Date)` 開立應付憑據的日期。
`dueDate`	`object (Date)` 應付憑據的到期日。
`serviceDateRange`	`object (DateRange)` 這份應付憑據涵蓋的服務開始和結束日期。
`currencyCode`	`string` 應付憑據使用的貨幣，以 ISO 4217 格式表示。
`subtotalAmountMicros`	`string (int64 format)` 稅前小計金額，以應付憑據貨幣的百萬分之一表示。舉例來說，如果 `currencyCode` 是 `USD`，則 1000000 代表一美元。
`totalTaxAmountMicros`	`string (int64 format)` 應付憑據中所有稅金的總和，以應付憑據幣別的百萬分之一表示。舉例來說，如果 `currencyCode` 是 `USD`，則 1000000 代表一美元。
`totalAmountMicros`	`string (int64 format)` 月結單總金額，以應付憑據貨幣的百萬分之一表示。舉例來說，如果 `currencyCode` 是 `USD`，則 1000000 代表一美元。
`purchaseOrderNumber`	`string` 與應付憑據相關聯的訂購單號碼。
`budgetInvoiceGroupingId`	`string` 這份月結單的預算分組 ID。只有在對應帳單資料的月結單層級設為「預算月結單分組 ID」時，才需要設定這個欄位。
`invoiceType`	`enum (InvoiceType)` 應付憑據文件的類型。
`correctedInvoiceId`	`string` 此應付憑據調整的原始月結單 ID (如適用)。可能會在應付憑據的 PDF 上顯示為 `Reference invoice number`。如果設定 `replacedInvoiceIds`，這個欄位會留空。
`replacedInvoiceIds[]`	`string` 此應付憑據取消的任何原先開立應付憑據的 ID(如適用)。系統可能會將多份月結單合併成一張月結單。可能會在應付憑據的 PDF 上顯示為 `Replaced invoice numbers`。如果設定 `correctedInvoiceId`，這個欄位會留空。
`pdfUrl`	`string` 下載應付憑據 PDF 副本的網址。這個網址因使用者而異，且必須具備有效的 OAuth 2.0 存取權杖才能存取。存取權杖必須在 `Authorization: Bearer` HTTP 標頭中提供，且已獲授權，可使用下列其中一個範圍： `https://www.googleapis.com/auth/display-video-mediaplanning` `https://www.googleapis.com/auth/display-video` 該網址的效期為擷取這個發票物件後的 7 天，或可於系統再次擷取這份月結單前有效。
`budgetSummaries[]`	`object (BudgetSummary)` 與月結單相關的每筆預算摘要資訊。只有在對應帳單資料的月結單詳細資料層級設為「預算層級訂購單」時，才能設定這個欄位。
`nonBudgetMicros`	`string (int64 format)` 非與特定預算相關聯的費用或調整項總額，以月結單貨幣的百萬分之一表示。舉例來說，如果 `currencyCode` 是 `USD`，則 1000000 代表一美元。

InvoiceType

可能的應付憑據類型。

列舉
`INVOICE_TYPE_UNSPECIFIED`	這個版本未指定或不明。
`INVOICE_TYPE_CREDIT`	應付憑據的金額為負數。
`INVOICE_TYPE_INVOICE`	應付憑據的金額為正數。

BudgetSummary

個別廣告活動預算的摘要資訊。

JSON 表示法
{ "externalBudgetId": string, "prismaCpeCode": { object (`PrismaCpeCode`) }, "preTaxAmountMicros": string, "taxAmountMicros": string, "totalAmountMicros": string }

欄位
`externalBudgetId`	`string` 對應廣告活動預算的 `externalBudgetId`。如果您未在廣告活動預算中設定這個值，這個欄位就會空白。
`prismaCpeCode`	`object (PrismaCpeCode)` Mediaocean Prisma 工具提供的相關客戶、產品和預估代碼。僅適用於`externalBudgetSource`為 `EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN` 的廣告活動預算。
`preTaxAmountMicros`	`string (int64 format)` 這筆預算未稅前金額的總和，以應付憑據幣別的百萬分之一為單位。舉例來說，如果 `currencyCode` 是 `USD`，則 1000000 代表一美元。
`taxAmountMicros`	`string (int64 format)` 這筆預算使用時產生的稅金，以應付憑據幣別的百萬分之一為單位。舉例來說，如果 `currencyCode` 是 `USD`，則 1000000 代表一美元。
`totalAmountMicros`	`string (int64 format)` 這筆預算下的費用總額 (含稅金，以應付憑據幣別為單位)。舉例來說，如果 `currencyCode` 是 `USD`，則 1000000 代表一美元。