Method: advertisers.invoices.list

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

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

คำขอ HTTP

GET https://displayvideo.googleapis.com/v3/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 นี้เป็น 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)

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

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