列出在给定月份为广告客户发布的帐单。
如果账单级别为“合作伙伴”账单级别,则无法通过此方法检索所生成的账单。
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(如果适用)。如果多个账单被合并为一份账单,则可能会列出这些账单。 可能会在 PDF 账单上以 如果设置了 |
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 |
在此预算下产生的费用总额(包括税费),以账单币种的微单位表示。 例如,如果 |