Method: advertisers.invoices.list

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

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

คำขอ HTTP

GET https://displayvideo.googleapis.com/v1/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 นี้เป็นของผู้ใช้แต่ละรายและต้องมีโทเค็นเพื่อการเข้าถึง 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 ดอลลาร์สหรัฐ