- HTTP リクエスト
- パスパラメータ
- クエリ パラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- LoiSapinInvoiceType
- 請求書
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- InvoiceType
- BudgetSummary
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 試してみる
指定した月に広告主に送信された請求書を一覧表示します。
「パートナー」による請求プロファイルによって生成された請求書請求書レベルは、この方法では取得できません。
HTTP リクエスト
GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/invoices
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
advertiserId |
必須。請求書を一覧表示する広告主の ID。 |
クエリ パラメータ
パラメータ | |
---|---|
issueMonth |
請求書を一覧表示する月。設定しない場合、リクエストは前月の請求書を取得します。 YYYYMM の形式で入力してください。 |
loiSapinInvoiceType |
サパン法の広告主用に取得する請求書のタイプを選択します。 サパン法適用の広告主様にのみ適用されます。それ以外の場合は無視されます。 |
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_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(該当する場合)。 PDF 請求書には
|
replacedInvoiceIds[] |
この請求書によって取り消される元の発行済みの請求書の ID(該当する場合)。複数の請求書が 1 つの請求書に統合されている場合は、複数の請求書が記載されている可能性があります。 PDF 請求書には
|
pdfUrl |
請求書の PDF 版をダウンロードするための URL。 この URL はユーザー固有のものであり、アクセスするには有効な OAuth 2.0 アクセス トークンが必要です。アクセス トークンを
URL は、この請求書オブジェクトの取得後 7 日間、またはこの請求書が再度取得されるまで有効です。 |
budgetSummaries[] |
この請求書に関連付けられている各予算の概要情報のリスト。 このフィールドは、対応する請求プロファイルの請求書の詳細レベルが「予算レベルの PO」に設定されている場合のみ設定されます。 |
nonBudgetMicros |
特定の予算に関連付けられない費用または調整額の合計(請求書の通貨の 100 分の 1 単位)。 たとえば、 |
InvoiceType
請求書の種類
列挙型 | |
---|---|
INVOICE_TYPE_UNSPECIFIED |
指定されていないか、このバージョンでは不明です。 |
INVOICE_TYPE_CREDIT |
請求書の金額がマイナスになっています。 |
INVOICE_TYPE_INVOICE |
請求書の金額が正です。 |
BudgetSummary
個々のキャンペーン予算に関する情報をまとめたものです。
JSON 表現 |
---|
{
"externalBudgetId": string,
"prismaCpeCode": {
object ( |
フィールド | |
---|---|
externalBudgetId |
キャンペーン予算の |
prismaCpeCode |
Mediaocean Prisma ツールから取得した関連クライアント、プロダクト、見積もりコード。
|
preTaxAmountMicros |
この予算に基づく税引前の合計請求額(請求書の通貨の 100 万分の 1 単位)。 たとえば、 |
taxAmountMicros |
この予算の下で請求に適用される税金の金額(請求書の通貨の 100 分の 1 単位)。 たとえば、 |
totalAmountMicros |
この予算に基づく料金(税金を含む)の合計額。請求書の通貨の 100 分の 1 で表されます。 たとえば、 |