Method: advertisers.invoices.list

列出在给定月份内为广告商发布的账单。

账单级别为“合作伙伴”的结算资料生成的账单无法通过此方法检索。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
advertiserId

string (int64 format)

必需。要为其列出账单的广告客户 ID。

查询参数

参数
issueMonth

string

要为其列出账单的月份。如果未设置,则请求将检索上个月的账单。

必须采用 YYYYMM 格式。

loiSapinInvoiceType

enum (LoiSapinInvoiceType)

选择要为 Loi Sapin 广告客户检索的账单类型。

仅适用于 Loi Sapin 广告客户。否则,将被忽略。

pageSize

integer

请求的页面大小。必须介于 1200 之间。如果未指定,则默认为 100。如果指定了无效值,则返回错误代码 INVALID_ARGUMENT

pageToken

string

标识服务器应返回的结果页面的令牌。通常,这是上一次调用 invoices.list 方法后返回的 nextPageToken 值。如果未指定,将返回第一页结果。

请求正文

请求正文必须为空。

响应正文

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
字段
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 表示法
{
  "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)

税前小计金额,以账单币种的微单位表示。

例如,如果 currencyCodeUSD,则 1000000 代表一美元。

totalTaxAmountMicros

string (int64 format)

账单中所有税费的总和,以账单币种的微单位表示。

例如,如果 currencyCodeUSD,则 1000000 代表一美元。

totalAmountMicros

string (int64 format)

账单总金额,以账单币种的微单位表示。

例如,如果 currencyCodeUSD,则 1000000 代表一美元。

purchaseOrderNumber

string

与账单关联的采购订单编号。

budgetInvoiceGroupingId

string

此账单的预算分组 ID。

仅当相应结算资料的账单级别设为“预算账单分组 ID”时,才会设置此字段。

invoiceType

enum (InvoiceType)

账单凭证的类型。

correctedInvoiceId

string

由此账单调整的原始账单的 ID(如果适用)。

可能会以 Reference invoice number 的形式显示在账单 PDF 中。

如果设置了 replacedInvoiceIds,此字段将为空。

replacedInvoiceIds[]

string

被此账单取消的任何最初开具的账单的 ID(如果适用)。如果将多个账单合并为一个账单,这些账单可能会列出。

可能会以 Replaced invoice numbers 的形式显示在 PDF 账单中。

如果设置了 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)

与特定预算无关的费用或调整项的总金额,以账单币种的微单位表示。

例如,如果 currencyCodeUSD,则 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 工具提供的相关客户、产品和估算代码。

仅适用于externalBudgetSourceEXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN 的广告系列预算。

preTaxAmountMicros

string (int64 format)

在此预算下产生的税前费用总和(以账单币种的微单位表示)。

例如,如果 currencyCodeUSD,则 1000000 代表一美元。

taxAmountMicros

string (int64 format)

应用于此预算下的费用的税额,以账单币种的微单位表示。

例如,如果 currencyCodeUSD,则 1000000 代表一美元。

totalAmountMicros

string (int64 format)

在此预算下产生的费用总额(包括税费),以账单币种的微单位表示。

例如,如果 currencyCodeUSD,则 1000000 代表一美元。