Method: advertisers.invoices.list

แสดงใบแจ้งหนี้ที่โพสต์สำหรับผู้ลงโฆษณาในเดือนหนึ่งๆ

ใบแจ้งหนี้ที่โปรไฟล์การเรียกเก็บเงินสร้างขึ้นซึ่งมีระดับใบแจ้งหนี้เป็น "พาร์ทเนอร์" จะเรียกดูไม่ได้ผ่านวิธีการนี้

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
advertiserId

string (int64 format)

ต้องระบุ รหัสของผู้ลงโฆษณาที่จะแสดงใบแจ้งหนี้

พารามิเตอร์การค้นหา

พารามิเตอร์
issueMonth

string

เดือนที่จะแสดงใบแจ้งหนี้ หากไม่ได้ตั้งค่าไว้ คำขอจะดึงข้อมูลใบแจ้งหนี้ของเดือนก่อนหน้า

ต้องอยู่ในรูปแบบ ปปปปดด
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

เลือกประเภทใบแจ้งหนี้ที่จะดึงข้อมูลสําหรับผู้ลงโฆษณาภายใต้กฎหมาย Loi Sapin

ใช้ได้กับผู้ลงโฆษณา Loi Sapin เท่านั้น มิเช่นนั้นระบบจะไม่สนใจ
pageSize

integer

ขนาดหน้าที่ต้องการ ต้องอยู่ระหว่าง 1 ถึง 200 หากไม่ระบุ ระบบจะใช้ 100 เป็นค่าเริ่มต้น แสดงรหัสข้อผิดพลาด INVALID_ARGUMENT หากระบุค่าที่ไม่ถูกต้อง
pageToken

string

โทเค็นที่ระบุหน้าผลการค้นหาที่เซิร์ฟเวอร์ควรแสดง โดยปกติแล้ว ค่านี้คือค่าของ nextPageToken ที่แสดงผลจากการเรียกใช้เมธอด invoices.list ก่อนหน้านี้ หากไม่ระบุ ระบบจะแสดงหน้าแรกของผลการค้นหา

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
ช่อง
invoices[]

object (Invoice)

รายการใบแจ้งหนี้

รายการนี้จะหายไปหากไม่มีข้อมูล
nextPageToken

string

โทเค็นสําหรับดึงข้อมูลหน้าถัดไปของผลการค้นหา ส่งค่านี้ในช่อง pageToken ในการเรียกใช้เมธอด invoices.list ครั้งถัดไปเพื่อดึงข้อมูลหน้าถัดไป

โทเค็นนี้จะหายไปหากไม่มี invoices ที่จะแสดงอีก

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview

LoiSapinInvoiceType

ประเภทใบแจ้งหนี้ที่เป็นไปได้สำหรับผู้ลงโฆษณาภายใต้กฎหมาย Loi Sapin

Enum
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

รหัสที่ไม่ซ้ำกันของใบแจ้งหนี้
displayName

string

ชื่อที่แสดงของใบแจ้งหนี้
paymentsProfileId

string

รหัสของโปรไฟล์การชำระเงินที่เป็นเจ้าของใบแจ้งหนี้

ปรากฏใน PDF ของใบแจ้งหนี้เป็น Billing ID
paymentsAccountId

string

รหัสของบัญชีการชําระเงินที่เป็นเจ้าของใบแจ้งหนี้

ปรากฏใน 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

รหัสการจัดกลุ่มงบประมาณสําหรับใบแจ้งหนี้นี้

ระบบจะตั้งค่าฟิลด์นี้เฉพาะในกรณีที่ตั้งค่าระดับใบแจ้งหนี้ของโปรไฟล์การเรียกเก็บเงินที่เกี่ยวข้องเป็น "รหัสการจัดกลุ่มใบแจ้งหนี้ตามงบประมาณ"
invoiceType

enum (InvoiceType)

ประเภทเอกสารใบแจ้งหนี้
correctedInvoiceId

string

รหัสของใบแจ้งหนี้เดิมที่ใบแจ้งหนี้นี้ใช้ปรับค่าใช้จ่าย หากมี

อาจปรากฏใน PDF ของใบแจ้งหนี้เป็น Reference invoice number

หากตั้งค่าเป็น replacedInvoiceIds ฟิลด์นี้จะว่างเปล่า
replacedInvoiceIds[]

string

รหัสของใบแจ้งหนี้ที่ออกให้ตั้งแต่แรกซึ่งถูกยกเลิกโดยใบแจ้งหนี้นี้ หากมี ระบบอาจแสดงใบแจ้งหนี้หลายรายการหากมีการรวมใบแจ้งหนี้เหล่านั้นเป็นใบแจ้งหนี้เดียว

อาจปรากฏในใบแจ้งหนี้ PDF เป็น Replaced invoice numbers

หากตั้งค่าเป็น correctedInvoiceId ฟิลด์นี้จะว่างเปล่า
pdfUrl

string

URL สำหรับดาวน์โหลดสําเนาใบแจ้งหนี้ในรูปแบบ PDF

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)

รายการข้อมูลสรุปสำหรับงบประมาณแต่ละรายการที่เชื่อมโยงกับใบแจ้งหนี้นี้

ระบบจะตั้งค่าฟิลด์นี้เฉพาะในกรณีที่ตั้งค่าระดับรายละเอียดใบแจ้งหนี้ของโปรไฟล์การเรียกเก็บเงินที่เกี่ยวข้องเป็น "ใบสั่งซื้อระดับงบประมาณ"
nonBudgetMicros

string (int64 format)

จํานวนเงินค่าใช้จ่ายหรือการปรับค่าใช้จ่ายทั้งหมดที่ไม่ได้เชื่อมโยงกับงบประมาณใดๆ ในสกุลเงินของใบแจ้งหนี้

เช่น หาก currencyCode คือ USD แสดงว่า 1000000 หมายถึง 1 ดอลลาร์สหรัฐ

InvoiceType

ประเภทใบแจ้งหนี้ที่เป็นไปได้

Enum
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)

รหัสลูกค้า ผลิตภัณฑ์ และการคาดการณ์ที่เกี่ยวข้องจากเครื่องมือ Prisma ของ Mediaocean

ใช้ได้กับงบประมาณแคมเปญที่มี 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 ดอลลาร์สหรัฐ