列出特定月份開立的月結單。
如果月結單層級是「合作夥伴」月結單層級,您就無法透過這種方法擷取月結單。
HTTP 要求
GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/invoices
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
advertiserId |
必要欄位。要列出月結單的廣告客戶 ID。 |
查詢參數
參數 | |
---|---|
issueMonth |
要列出月結單的月份。如未設定,該要求會擷取前一個月的月結單。 格式必須為 YYYYMM。 |
loiSapinInvoiceType |
選取要為 Loi Sapin 廣告主擷取的月結單類型。 僅適用於 Loi Sapin 廣告客戶。否則會遭到忽略。 |
pageSize |
要求的頁面大小。必須介於 |
pageToken |
識別伺服器應傳回之結果頁面的符記。通常這是先前呼叫 |
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"invoices": [
{
object ( |
欄位 | |
---|---|
invoices[] |
月結單清單。 如果留空,這份清單將不會顯示。 |
nextPageToken |
用於擷取下一頁結果的權杖。在對 如果沒有其他可傳回的 |
授權範圍
需要下列其中一種 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 表示法 |
---|
{ "name": string, "invoiceId": string, "displayName": string, "paymentsProfileId": string, "paymentsAccountId": string, "issueDate": { object ( |
欄位 | |
---|---|
name |
應付憑據的資源名稱。 |
invoiceId |
應付憑據的專屬 ID, |
displayName |
月結單的顯示名稱。 |
paymentsProfileId |
月結單所屬的付款資料 ID。 顯示在應付憑據 PDF 上,格式為 |
paymentsAccountId |
月結單所屬的付款帳戶 ID。 顯示在應付憑據 PDF 上,格式為 |
issueDate |
月結單核發日期。 |
dueDate |
月結單的繳款期限。 |
serviceDateRange |
這份月結單涵蓋的服務開始和結束日期。 |
currencyCode |
應付憑據中使用的貨幣,採用 ISO 4217 格式。 |
subtotalAmountMicros |
稅前小計金額 (以應付憑據幣別的百萬分之一表示)。 舉例來說,如果 |
totalTaxAmountMicros |
應付憑據中所有稅金的總和 (以應付憑據幣別的百萬分之一表示)。 舉例來說,如果 |
totalAmountMicros |
應付憑據總金額 (以應付憑據幣別的百萬分之一表示)。 舉例來說,如果 |
purchaseOrderNumber |
與月結單相關聯的訂購單號碼。 |
budgetInvoiceGroupingId |
這份月結單的預算分組 ID。 只有在相應帳單資料的月結單層級設為「預算月結單分組 ID」時,才需要設定這個欄位。 |
invoiceType |
應付憑據文件類型。 |
correctedInvoiceId |
這份月結單調整的原始月結單 ID (如適用)。 可能在應付憑據上以 如果已設定 |
replacedInvoiceIds[] |
這份應付憑據取消的任何原先核發應付憑據的 ID(如有)。如果將多份月結單合併成單一月結單,可能會列出多份月結單。 可能在應付憑據上以 如果已設定 |
pdfUrl |
月結單 PDF 副本的下載網址。 這是每位使用者專屬的網址,您必須提供有效的 OAuth 2.0 存取權杖才能存取。存取權杖必須在
網址在擷取這個發票物件之後的 7 天內有效,或是到再次擷取這張發票為止。 |
budgetSummaries[] |
這份月結單針對各項預算的摘要資訊。 只有在相應帳單資料的月結單詳細資料層級設為「預算層級訂購單」時,才需要設定這個欄位。 |
nonBudgetMicros |
與特定預算無關的費用或調整項總額,以月結單貨幣的百萬分之一表示。 舉例來說,如果 |
InvoiceType
可能的應付憑據類型。
列舉 | |
---|---|
INVOICE_TYPE_UNSPECIFIED |
這個版本未指定或不明。 |
INVOICE_TYPE_CREDIT |
應付憑據的金額為負值。 |
INVOICE_TYPE_INVOICE |
應付憑據金額為正數。 |
BudgetSummary
個別廣告活動預算的摘要資訊。
JSON 表示法 |
---|
{
"externalBudgetId": string,
"prismaCpeCode": {
object ( |
欄位 | |
---|---|
externalBudgetId |
對應廣告活動預算的 |
prismaCpeCode |
Mediaocean Prisma 工具提供的相關客戶、產品和預估代碼。 僅適用於 |
preTaxAmountMicros |
根據這筆預算扣除稅金前的費用總和 (以月結單貨幣的百萬分之一表示)。 舉例來說,如果 |
taxAmountMicros |
這筆預算下費用的稅額 (以月結單貨幣的百萬分之一表示)。 舉例來說,如果 |
totalAmountMicros |
這筆預算下的費用總額 (含稅金),以月結單貨幣的百萬分之一表示。 舉例來說,如果 |