Method: advertisers.invoices.list

Mencantumkan invoice yang diposting untuk pengiklan dalam bulan tertentu.

Invoice yang dibuat oleh profil penagihan dengan tingkat invoice "Partner" tidak dapat diambil melalui metode ini.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
advertiserId

string (int64 format)

Wajib. ID pengiklan yang akan dicantumkan invoice.

Parameter kueri

Parameter
issueMonth

string

Bulan untuk mencantumkan invoice. Jika tidak ditetapkan, permintaan akan mengambil invoice untuk bulan sebelumnya.

Harus dalam format YYYYMM.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Pilih jenis invoice yang akan diambil untuk pengiklan Loi Sapin.

Hanya berlaku untuk pengiklan Loi Sapin. Jika tidak, akan diabaikan.
pageSize

integer

Ukuran halaman yang diminta. Harus antara 1 dan 200. Jika tidak ditentukan, setelan defaultnya adalah 100. Menampilkan kode error INVALID_ARGUMENT jika nilai yang ditentukan tidak valid.
pageToken

string

Token yang mengidentifikasi halaman hasil yang harus ditampilkan server. Biasanya, ini adalah nilai nextPageToken yang ditampilkan dari panggilan sebelumnya ke metode invoices.list. Jika tidak ditentukan, halaman pertama hasil akan ditampilkan.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
Kolom
invoices[]

object (Invoice)

Daftar invoice.

Daftar ini tidak akan ada jika kosong.
nextPageToken

string

Token untuk mengambil halaman hasil berikutnya. Teruskan nilai ini di kolom pageToken dalam panggilan berikutnya ke metode invoices.list untuk mengambil halaman hasil berikutnya.

Token ini tidak akan ada jika tidak ada lagi invoices yang akan ditampilkan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

LoiSapinInvoiceType

Kemungkinan jenis invoice untuk pengiklan Loi Sapin.

Enum
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED Nilai tidak ditentukan.
LOI_SAPIN_INVOICE_TYPE_MEDIA Invoice dengan biaya Media.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Invoice dengan Biaya platform.

Faktur

Satu invoice.

Representasi 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
}
Kolom
name

string

Nama resource invoice.
invoiceId

string

ID unik invoice.
displayName

string

Nama tampilan invoice.
paymentsProfileId

string

ID profil pembayaran yang terkait dengan invoice.

Muncul di PDF invoice sebagai Billing ID.
paymentsAccountId

string

ID akun pembayaran yang memiliki invoice.

Muncul di PDF invoice sebagai Billing Account Number.
issueDate

object (Date)

Tanggal penerbitan invoice.
dueDate

object (Date)

Tanggal jatuh tempo invoice.
serviceDateRange

object (DateRange)

Tanggal mulai dan akhir layanan yang dicakup dalam invoice ini.
currencyCode

string

Mata uang yang digunakan dalam invoice dalam format ISO 4217.
subtotalAmountMicros

string (int64 format)

Jumlah subtotal sebelum pajak, dalam mikro mata uang invoice.

Misalnya, jika currencyCode adalah USD, 1000000 mewakili satu dolar AS.
totalTaxAmountMicros

string (int64 format)

Jumlah semua pajak dalam invoice, dalam mikro mata uang invoice.

Misalnya, jika currencyCode adalah USD, maka 1.000.000 mewakili satu dolar AS.
totalAmountMicros

string (int64 format)

Jumlah total invoice, dalam mikro mata uang invoice.

Misalnya, jika currencyCode adalah USD, maka 1.000.000 mewakili satu dolar AS.
purchaseOrderNumber

string

Nomor pesanan pembelian yang terkait dengan invoice.
budgetInvoiceGroupingId

string

ID pengelompokan anggaran untuk invoice ini.

Kolom ini hanya akan ditetapkan jika tingkat invoice profil penagihan yang sesuai ditetapkan ke "ID pengelompokan invoice anggaran".
invoiceType

enum (InvoiceType)

Jenis dokumen invoice.
correctedInvoiceId

string

ID invoice asli yang disesuaikan oleh invoice ini, jika ada.

Dapat muncul di PDF invoice sebagai Reference invoice number.

Jika replacedInvoiceIds ditetapkan, kolom ini akan kosong.
replacedInvoiceIds[]

string

ID invoice yang awalnya diterbitkan dan dibatalkan oleh invoice ini, jika ada. Beberapa invoice dapat dicantumkan jika invoice tersebut digabungkan menjadi satu invoice.

Mungkin muncul di PDF invoice sebagai Replaced invoice numbers.

Jika correctedInvoiceId ditetapkan, kolom ini akan kosong.
pdfUrl

string

URL untuk mendownload salinan invoice dalam format PDF.

URL ini khusus pengguna dan memerlukan token akses OAuth 2.0 yang valid untuk diakses. Token akses harus diberikan dalam header HTTP Authorization: Bearer dan diberi otorisasi untuk salah satu cakupan berikut:

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

URL akan valid selama 7 hari setelah pengambilan objek invoice ini atau hingga invoice ini diambil lagi.
budgetSummaries[]

object (BudgetSummary)

Daftar ringkasan informasi untuk setiap anggaran yang terkait dengan invoice ini.

Kolom ini hanya akan ditetapkan jika tingkat detail invoice untuk profil penagihan terkait ditetapkan ke "PO tingkat anggaran".
nonBudgetMicros

string (int64 format)

Jumlah total biaya atau penyesuaian yang tidak terkait dengan anggaran tertentu, dalam mikro mata uang invoice.

Misalnya, jika currencyCode adalah USD, maka 1.000.000 mewakili satu dolar AS.

InvoiceType

Kemungkinan jenis invoice.

Enum
INVOICE_TYPE_UNSPECIFIED Tidak ditentukan atau tidak diketahui dalam versi ini.
INVOICE_TYPE_CREDIT Invoice memiliki jumlah negatif.
INVOICE_TYPE_INVOICE Invoice memiliki jumlah positif.

BudgetSummary

Ringkasan informasi anggaran masing-masing kampanye.

Representasi JSON 
{
  "externalBudgetId": string,
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "preTaxAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
Kolom
externalBudgetId

string

Sesuai dengan externalBudgetId anggaran kampanye. Jika nilai tidak ditetapkan dalam anggaran kampanye, kolom ini akan kosong.
prismaCpeCode

object (PrismaCpeCode)

Kode klien, produk, dan estimasi yang relevan dari alat Mediaocean Prisma.

Hanya berlaku untuk anggaran kampanye dengan externalBudgetSource EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
preTaxAmountMicros

string (int64 format)

Jumlah tagihan yang dibuat berdasarkan anggaran ini sebelum pajak, dalam mikro mata uang invoice.

Misalnya, jika currencyCode adalah USD, 1000000 mewakili satu dolar AS.
taxAmountMicros

string (int64 format)

Jumlah pajak yang diterapkan pada tagihan berdasarkan anggaran ini, dalam mikro mata uang invoice.

Misalnya, jika currencyCode adalah USD, maka 1.000.000 mewakili satu dolar AS.
totalAmountMicros

string (int64 format)

Jumlah total tagihan yang dibuat berdasarkan anggaran ini, termasuk pajak, dalam mikro mata uang invoice.

Misalnya, jika currencyCode adalah USD, maka 1.000.000 mewakili satu dolar AS.