Method: advertisers.invoices.list

特定の月に広告主に対して送信された請求書を一覧表示します。

請求書レベルが「パートナー」の請求プロファイルによって生成された請求書は、この方法で取得できません。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
advertiserId

string (int64 format)

必須。請求書を一覧表示する広告主の ID。

クエリ パラメータ

パラメータ
issueMonth

string

請求書を表示する月。設定されていない場合、リクエストは前月の請求書を取得します。

YYYYMM の形式で入力してください。
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

サパン法の広告主様向けに取得する請求書の種類を選択します。

サパン法の広告主様のみが対象です。それ以外の場合は無視されます。
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 がそれ以上ない場合、このトークンは存在しません。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、OAuth 2.0 の概要をご覧ください。

LoiSapinInvoiceType

サパン法の広告主様に適用される請求書の種類

列挙型
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)

税引前の小計額（請求書の通貨のマイクロ単位）。

たとえば、currencyCode が USD の場合、1000000 は 1 米ドルを表します。
totalTaxAmountMicros

string (int64 format)

請求書に含まれるすべての税金の合計（請求書の通貨のマイクロ単位）。

たとえば、currencyCode が USD の場合、1000000 は 1 米ドルを表します。
totalAmountMicros

string (int64 format)

請求書の合計金額（請求書の通貨のマイクロ単位）。

たとえば、currencyCode が USD の場合、1000000 は 1 米ドルを表します。
purchaseOrderNumber

string

請求書に関連付けられている注文書番号。
budgetInvoiceGroupingId

string

この請求書の予算グループ ID。

このフィールドは、対応する請求プロファイルの請求書レベルが「予算請求書グループ ID」に設定されている場合にのみ設定されます。
invoiceType

enum (InvoiceType)

請求書ドキュメントのタイプ。
correctedInvoiceId

string

この請求書によって調整される元の請求書の ID（該当する場合）。

請求書の PDF に Reference invoice number と記載される場合があります。

replacedInvoiceIds が設定されている場合、このフィールドは空になります。
replacedInvoiceIds[]

string

この請求書によってキャンセルされる元の発行された請求書の ID（該当する場合）。請求書が 1 つの請求書に統合されている場合、複数の請求書が表示されることがあります。

請求書の PDF に Replaced invoice numbers と記載される場合があります。

correctedInvoiceId が設定されている場合、このフィールドは空になります。
pdfUrl

string

請求書の PDF 版をダウンロードするための URL。

この URL はユーザー固有で、アクセスするには有効な OAuth 2.0 アクセス トークンが必要です。アクセス トークンは Authorization: Bearer HTTP ヘッダーで指定し、次のいずれかのスコープに対して承認されている必要があります。

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

URL は、この請求書オブジェクトの取得後 7 日間、またはこの請求書が再度取得されるまで有効です。
budgetSummaries[]

object (BudgetSummary)

この請求書に関連付けられている各予算の概要情報のリスト。

このフィールドは、対応する請求プロファイルの請求書の詳細レベルが [予算レベル PO] に設定されている場合にのみ設定されます。
nonBudgetMicros

string (int64 format)

特定の予算に関連付けられていない費用または調整の合計金額（請求書の通貨のマイクロ単位）。

たとえば、currencyCode が USD の場合、1000000 は 1 米ドルを表します。

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 は 1 米ドルを表します。
taxAmountMicros

string (int64 format)

この予算の下で料金に適用される税額（請求書の通貨のマイクロ単位）。

たとえば、currencyCode が USD の場合、1000000 は 1 米ドルを表します。
totalAmountMicros

string (int64 format)

この予算の下で行われた料金の合計（税金を含む）。請求書の通貨のマイクロ単位で表示されます。

たとえば、currencyCode が USD の場合、1000000 は 1 米ドルを表します。