Method: advertisers.invoices.list

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

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v1/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.

טיפוסים בני מנייה (enums)
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

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

עשוי להופיע בקובץ 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

סוגים אפשריים של חשבוניות.

טיפוסים בני מנייה (enums)
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 הוא דולר ארה"ב אחד.