- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi cấp phép
- LoiSapinInvoiceType
- Hoá đơn
- InvoiceType
- BudgetSummary
- Hãy làm thử!
Liệt kê các hoá đơn đã đăng cho một nhà quảng cáo trong một tháng nhất định.
Bạn không thể truy xuất hoá đơn do hồ sơ thanh toán có cấp hoá đơn "Đối tác" tạo thông qua phương pháp này.
Yêu cầu HTTP
GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/invoices
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Các tham số | |
---|---|
advertiserId |
Bắt buộc. Mã của nhà quảng cáo cần lập hoá đơn. |
Tham số truy vấn
Các tham số | |
---|---|
issueMonth |
Tháng liệt kê hoá đơn. Nếu bạn không đặt chính sách này, yêu cầu này sẽ truy xuất hoá đơn của tháng trước đó. Phải ở định dạng YYYYMM. |
loiSapinInvoiceType |
Chọn loại hoá đơn để truy xuất cho nhà quảng cáo Loi Sapin. Chỉ áp dụng cho các nhà quảng cáo Loi Sapin. Nếu không, giá trị này sẽ bị bỏ qua. |
pageSize |
Kích thước trang được yêu cầu. Phải nằm trong khoảng từ |
pageToken |
Mã thông báo xác định trang kết quả mà máy chủ sẽ trả về. Thông thường, đây là giá trị của |
Nội dung yêu cầu
Nội dung yêu cầu phải trống.
Nội dung phản hồi
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{
"invoices": [
{
object ( |
Các trường | |
---|---|
invoices[] |
Danh sách hoá đơn. Danh sách này sẽ không có nếu trống. |
nextPageToken |
Mã thông báo để truy xuất trang kết quả tiếp theo. Truyền giá trị này vào trường Mã thông báo này sẽ không có nếu không còn |
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau:
https://www.googleapis.com/auth/display-video
https://www.googleapis.com/auth/display-video-mediaplanning
Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.
LoiSapinInvoiceType
Các loại hoá đơn có thể có cho nhà quảng cáo Loi Sapin.
Enum | |
---|---|
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED |
Giá trị chưa được chỉ định. |
LOI_SAPIN_INVOICE_TYPE_MEDIA |
Hoá đơn có chi phí truyền thông. |
LOI_SAPIN_INVOICE_TYPE_PLATFORM |
Hoá đơn có Phí nền tảng. |
Hóa đơn
Một hoá đơn.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "invoiceId": string, "displayName": string, "paymentsProfileId": string, "paymentsAccountId": string, "issueDate": { object ( |
Các trường | |
---|---|
name |
Tên tài nguyên của hoá đơn. |
invoiceId |
Mã nhận dạng duy nhất của hoá đơn. |
displayName |
Tên hiển thị của hoá đơn. |
paymentsProfileId |
Mã hồ sơ thanh toán có chứa hoá đơn. Xuất hiện trên hoá đơn PDF dưới dạng |
paymentsAccountId |
Mã tài khoản thanh toán có chứa hoá đơn. Xuất hiện trên hoá đơn PDF dưới dạng |
issueDate |
Ngày phát hành hoá đơn. |
dueDate |
Ngày đến hạn của hoá đơn. |
serviceDateRange |
Ngày bắt đầu và ngày kết thúc dịch vụ được đề cập trong hoá đơn này. |
currencyCode |
Đơn vị tiền tệ dùng trong hoá đơn theo định dạng ISO 4217. |
subtotalAmountMicros |
Tổng phụ trước thuế, tính bằng micro đơn vị tiền tệ của hoá đơn. Ví dụ: nếu |
totalTaxAmountMicros |
Tổng tất cả các khoản thuế trong hoá đơn, tính bằng phần triệu đơn vị tiền tệ của hoá đơn. Ví dụ: nếu |
totalAmountMicros |
Tổng số tiền trên hoá đơn, tính bằng micro đơn vị tiền tệ của hoá đơn. Ví dụ: nếu |
purchaseOrderNumber |
Số đơn đặt hàng được liên kết với hoá đơn. |
budgetInvoiceGroupingId |
Mã nhóm ngân sách cho hoá đơn này. Bạn sẽ chỉ đặt trường này nếu đã đặt cấp hoá đơn của hồ sơ thanh toán tương ứng thành "Mã nhóm hoá đơn theo ngân sách". |
invoiceType |
Loại chứng từ hoá đơn. |
correctedInvoiceId |
Mã của hoá đơn gốc đang được điều chỉnh theo hoá đơn này, nếu có. Có thể xuất hiện trên tệp PDF hoá đơn dưới dạng Nếu bạn đặt |
replacedInvoiceIds[] |
(Các) Mã của bất kỳ hoá đơn nào được phát hành ban đầu đang bị huỷ bởi hoá đơn này, nếu có. Nhiều hoá đơn có thể được liệt kê nếu các hoá đơn đó được tổng hợp thành một hoá đơn duy nhất. Có thể xuất hiện trên hoá đơn dưới dạng Nếu bạn đặt |
pdfUrl |
URL để tải bản sao hoá đơn xuống dưới dạng PDF. URL này dành riêng cho người dùng và cần có mã truy cập OAuth 2.0 hợp lệ để truy cập. Mã truy cập phải được cung cấp trong tiêu đề HTTP
URL sẽ có hiệu lực trong 7 ngày sau khi truy xuất đối tượng hoá đơn này hoặc cho đến khi hoá đơn này được truy xuất lại. |
budgetSummaries[] |
Danh sách thông tin tóm tắt cho từng ngân sách được liên kết với hoá đơn này. Trường này sẽ chỉ được đặt nếu bạn đã đặt cấp chi tiết hoá đơn của hồ sơ thanh toán tương ứng thành "Cấp ngân sách PO". |
nonBudgetMicros |
Tổng số tiền chi phí hoặc mức điều chỉnh không liên quan đến một ngân sách cụ thể, tính theo micro đơn vị tiền tệ của hoá đơn. Ví dụ: nếu |
InvoiceType
Các loại hoá đơn có thể có.
Enum | |
---|---|
INVOICE_TYPE_UNSPECIFIED |
Không được chỉ định hoặc không xác định trong phiên bản này. |
INVOICE_TYPE_CREDIT |
Hoá đơn có số tiền âm. |
INVOICE_TYPE_INVOICE |
Hoá đơn có số tiền dương. |
BudgetSummary
Thông tin tóm tắt về ngân sách chiến dịch riêng lẻ.
Biểu diễn dưới dạng JSON |
---|
{
"externalBudgetId": string,
"prismaCpeCode": {
object ( |
Các trường | |
---|---|
externalBudgetId |
Tương ứng với |
prismaCpeCode |
Mã khách hàng, sản phẩm và mã ước tính có liên quan trên công cụ Mediaocean Prisma. Chỉ áp dụng cho ngân sách chiến dịch có |
preTaxAmountMicros |
Tổng các khoản phí được tính trong ngân sách này trước thuế, tính bằng micro giây theo đơn vị tiền tệ của hoá đơn. Ví dụ: nếu |
taxAmountMicros |
Số tiền thuế áp dụng cho các khoản phí trong phạm vi ngân sách này, tính bằng phần triệu đơn vị tiền tệ của hoá đơn. Ví dụ: nếu |
totalAmountMicros |
Tổng các khoản phí được tính bằng ngân sách này, bao gồm cả thuế, tính bằng micro giây theo đơn vị tiền tệ của hoá đơn. Ví dụ: nếu |