- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- LoiSapinInvoiceType
- ใบแจ้งหนี้
- InvoiceType
- BudgetSummary
- ลองใช้งาน
แสดงรายการใบแจ้งหนี้ที่โพสต์สำหรับผู้ลงโฆษณาในเดือนหนึ่งๆ
ใบแจ้งหนี้ที่สร้างโดยโปรไฟล์การเรียกเก็บเงินที่มี "พาร์ทเนอร์" วิธีนี้จะไม่สามารถกู้คืนระดับใบแจ้งหนี้ได้
คำขอ HTTP
GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/invoices
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
advertiserId |
ต้องระบุ รหัสของผู้ลงโฆษณาที่จะแสดงใบแจ้งหนี้ |
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
issueMonth |
เดือนที่จะแสดงใบแจ้งหนี้ หากไม่ได้ตั้งค่า คำขอจะดึงใบแจ้งหนี้สำหรับเดือนก่อนหน้า ต้องอยู่ในรูปแบบ ปปปปดด |
loiSapinInvoiceType |
เลือกประเภทใบแจ้งหนี้ที่ต้องการดึงข้อมูลสำหรับผู้ลงโฆษณา Loi Sapin มีผลกับผู้ลงโฆษณา Loi Sapin เท่านั้น และระบบจะไม่สนใจ |
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
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 ( |
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของใบแจ้งหนี้ |
invoiceId |
รหัสที่ไม่ซ้ำกันของใบแจ้งหนี้ |
displayName |
ชื่อที่แสดงของใบแจ้งหนี้ |
paymentsProfileId |
รหัสของโปรไฟล์การชำระเงินที่ใช้ใบแจ้งหนี้ ปรากฏในใบแจ้งหนี้ PDF เป็น |
paymentsAccountId |
รหัสบัญชีการชำระเงินที่มีใบแจ้งหนี้ดังกล่าว ปรากฏในใบแจ้งหนี้ PDF เป็น |
issueDate |
วันที่ที่ออกใบแจ้งหนี้ |
dueDate |
วันที่ที่ใบแจ้งหนี้ครบกำหนด |
serviceDateRange |
วันที่เริ่มต้นและวันที่สิ้นสุดของบริการซึ่งรวมอยู่ในใบแจ้งหนี้นี้ |
currencyCode |
สกุลเงินที่ใช้ในใบแจ้งหนี้ในรูปแบบ ISO 4217 |
subtotalAmountMicros |
ยอดรวมย่อยก่อนหักภาษี ในหน่วยไมโครของสกุลเงินของใบแจ้งหนี้ เช่น หาก |
totalTaxAmountMicros |
ผลรวมของภาษีทั้งหมดในใบแจ้งหนี้ หน่วยเป็นไมโครสกุลเงินของใบแจ้งหนี้ เช่น หาก |
totalAmountMicros |
จำนวนเงินรวมในใบแจ้งหนี้ ในหน่วยไมโครของสกุลเงินของใบแจ้งหนี้ เช่น หาก |
purchaseOrderNumber |
หมายเลขใบสั่งซื้อที่เชื่อมโยงกับใบแจ้งหนี้ |
budgetInvoiceGroupingId |
รหัสการจัดกลุ่มงบประมาณสำหรับใบแจ้งหนี้นี้ ระบบจะตั้งค่าช่องนี้เฉพาะในกรณีที่ตั้งค่าระดับใบแจ้งหนี้ของโปรไฟล์การเรียกเก็บเงินที่เกี่ยวข้องเป็น "รหัสการจัดกลุ่มใบแจ้งหนี้ตามงบประมาณ" |
invoiceType |
ประเภทของเอกสารใบแจ้งหนี้ |
correctedInvoiceId |
รหัสของใบแจ้งหนี้เดิมที่ใบแจ้งหนี้นี้จะปรับ (หากมี) อาจปรากฏในใบแจ้งหนี้ PDF เป็น หากตั้งค่า |
replacedInvoiceIds[] |
รหัสของใบแจ้งหนี้ที่ออกในตอนแรกที่ถูกยกเลิกโดยใบแจ้งหนี้นี้ หากมี ระบบอาจแสดงใบแจ้งหนี้หลายใบหากใบแจ้งหนี้เหล่านั้นถูกรวมเป็นใบแจ้งหนี้เดียว อาจปรากฏในใบแจ้งหนี้ PDF เป็น หากตั้งค่า |
pdfUrl |
URL สำหรับดาวน์โหลดสำเนาใบแจ้งหนี้แบบ PDF URL นี้เป็นค่าเฉพาะของผู้ใช้ และต้องใช้โทเค็นเพื่อการเข้าถึง OAuth 2.0 ที่ถูกต้องเพื่อเข้าถึง ต้องระบุโทเค็นเพื่อการเข้าถึงในส่วนหัว HTTP
URL จะใช้ได้เป็นเวลา 7 วันหลังจากดึงข้อมูลออบเจ็กต์ใบแจ้งหนี้นี้ หรือจนกว่าจะมีการดึงข้อมูลใบแจ้งหนี้นี้อีกครั้ง |
budgetSummaries[] |
รายการข้อมูลสรุปสำหรับแต่ละงบประมาณที่เชื่อมโยงกับใบแจ้งหนี้นี้ ระบบจะตั้งค่าช่องนี้เฉพาะในกรณีที่ตั้งค่าระดับรายละเอียดใบแจ้งหนี้ของโปรไฟล์การเรียกเก็บเงินที่เกี่ยวข้องเป็น "PO ระดับงบประมาณ" |
nonBudgetMicros |
จำนวนค่าใช้จ่ายหรือการปรับค่าใช้จ่ายทั้งหมดที่ไม่ได้เชื่อมโยงกับงบประมาณหนึ่งๆ ในระดับไมโครของสกุลเงินของใบแจ้งหนี้ เช่น หาก |
InvoiceType
ประเภทของใบแจ้งหนี้ที่อาจมี
Enum | |
---|---|
INVOICE_TYPE_UNSPECIFIED |
ไม่ได้ระบุหรือไม่รู้จักในเวอร์ชันนี้ |
INVOICE_TYPE_CREDIT |
ใบแจ้งหนี้มีจำนวนเงินติดลบ |
INVOICE_TYPE_INVOICE |
ใบแจ้งหนี้มีจำนวนเงินเป็นบวก |
BudgetSummary
ข้อมูลสรุปเกี่ยวกับงบประมาณของแต่ละแคมเปญ
การแสดง JSON |
---|
{
"externalBudgetId": string,
"prismaCpeCode": {
object ( |
ช่อง | |
---|---|
externalBudgetId |
ตรงกับ |
prismaCpeCode |
โค้ดไคลเอ็นต์ ผลิตภัณฑ์ และค่าประมาณที่เกี่ยวข้องจากเครื่องมือ Mediaocean Prisma ใช้ได้กับงบประมาณแคมเปญที่มี |
preTaxAmountMicros |
ผลรวมของการเรียกเก็บเงินที่เกิดขึ้นภายใต้งบประมาณนี้ก่อนหักภาษี ในระดับไมโครสกุลเงินของใบแจ้งหนี้ เช่น หาก |
taxAmountMicros |
จำนวนภาษีที่มีผลบังคับใช้กับการเรียกเก็บเงินภายใต้งบประมาณนี้ ในหน่วยไมโครของสกุลเงินของใบแจ้งหนี้ เช่น หาก |
totalAmountMicros |
ยอดรวมของค่าใช้จ่ายที่เกิดขึ้นภายใต้งบประมาณนี้รวมทั้งภาษีเป็นไมโครสกุลเงินของใบแจ้งหนี้ เช่น หาก |