Method: advertisers.invoices.list

רשימה של חשבוניות שפורסמו עבור מפרסם בחודש נתון.

חשבוניות שנוצרות על ידי פרופילי חיוב אצל 'שותף' לא ניתן לאחזר את רמת החשבונית באמצעות השיטה הזו.

בקשת HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/invoices

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
advertiserId

string (int64 format)

חובה. המזהה של המפרסם שעבורו רוצים להציג את החשבוניות.

פרמטרים של שאילתה

פרמטרים
issueMonth

string

החודש הרצוי להצגת החשבוניות. אם היא לא מוגדרת, הבקשה תאחזר את החשבוניות של החודש הקודם.

חייב להיות בפורמט YYYYMM.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

יש לבחור את סוג החשבונית לייצוא למפרסמים שמשתמשים ב-Loi Sapin.

רלוונטי רק למפרסמים מסוג Loi Sapin. אחרת המערכת תתעלם ממנו.
pageSize

integer

גודל הדף המבוקש. חייב להיות בין 1 ל-200. אם לא צויין ערך, ברירת המחדל תהיה 100. הפונקציה מחזירה את קוד השגיאה INVALID_ARGUMENT אם צוין ערך לא חוקי.
pageToken

string

אסימון שמזהה דף תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת ל-method 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 מייצג דולר ארה"ב אחד.
totalTaxAmountMicros

string (int64 format)

הסכום של כל המיסים בחשבונית, במיליוניות השנייה של מטבע החשבונית.

לדוגמה, אם currencyCode הוא USD, אז 1000000 מייצג דולר ארה"ב אחד.
totalAmountMicros

string (int64 format)

הסכום הכולל של החשבונית, במיליוניות השנייה של מטבע החשבונית.

לדוגמה, אם currencyCode הוא USD, אז 1000000 מייצג דולר ארה"ב אחד.
purchaseOrderNumber

string

מספר הזמנת הרכש שמשויך לחשבונית.
budgetInvoiceGroupingId

string

מזהה קבוצת התקציב של החשבונית הזו.

השדה הזה יוגדר רק אם רמת החשבונית של פרופיל החיוב המתאים הוגדרה בתור 'מזהה קיבוץ חשבוניות לפי תקציב'.
invoiceType

enum (InvoiceType)

הסוג של מסמך החשבונית.
correctedInvoiceId

string

המזהה של החשבונית המקורית שעובר התאמה בחשבונית הזו, אם רלוונטי.

יכול להופיע בקובץ ה-PDF של החשבונית כ-Reference invoice number.

אם המדיניות replacedInvoiceIds מוגדרת, השדה הזה יהיה ריק.
replacedInvoiceIds[]

string

המזהים של כל חשבונית שהונפקה על ידי Google ומתבטלת על ידי החשבונית הזו, אם רלוונטי. אם החשבוניות האלה אוחדו לחשבונית אחת, ייתכן שיופיעו כמה חשבוניות בחשבון.

יכול להיות שהחשבונית תופיע בקובץ ה-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)

רשימת הפרטים המסוכמים של כל תקציב שמשויך לחשבונית הזו.

השדה הזה יוגדר רק אם רמת הפרטים בחשבונית של פרופיל החיוב המתאים הוגדרה בתור 'הזמנת רכש ברמת התקציב'.
nonBudgetMicros

string (int64 format)

הסכום הכולל של עלויות או התאמות שלא קשורות לתקציב מסוים, במיקרו-מטבע של החשבונית.

לדוגמה, אם currencyCode הוא USD, אז 1000000 מייצג דולר ארה"ב אחד.

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 מייצג דולר ארה"ב אחד.
taxAmountMicros

string (int64 format)

סכום המס שחל על חיובים במסגרת תקציב זה, במיליוניות השנייה של מטבע החשבונית.

לדוגמה, אם currencyCode הוא USD, אז 1000000 מייצג דולר ארה"ב אחד.
totalAmountMicros

string (int64 format)

הסכום הכולל של חיובים שבוצעו במסגרת תקציב זה, כולל מס, במיקרו של מטבע החשבונית.

לדוגמה, אם currencyCode הוא USD, אז 1000000 מייצג דולר ארה"ב אחד.