Method: advertisers.invoices.list

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

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

คำขอ HTTP

GET https://displayvideo.googleapis.com/v2/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

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 นี้เป็น URL เฉพาะสำหรับผู้ใช้และต้องมีโทเค็นเพื่อการเข้าถึง OAuth 2.0 ที่ถูกต้องจึงจะเข้าถึงได้ ต้องระบุโทเค็นเพื่อการเข้าถึงในส่วนหัว HTTP ของ Authorization: Bearer และได้รับสิทธิ์สำหรับขอบเขตใดขอบเขตหนึ่งต่อไปนี้

  • 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

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

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)

โค้ดลูกค้า ผลิตภัณฑ์ และค่าประมาณที่เกี่ยวข้องจากเครื่องมือ 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 ดอลลาร์สหรัฐ