- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- LoiSapinInvoiceType
- חשבונית
- InvoiceType
- BudgetSummary
- רוצים לנסות?
בתיבת הדו-שיח הזו מפורטים החשבוניות שפורסמו עבור מפרסם בחודש נתון.
לא ניתן לאחזר בשיטה הזו חשבוניות שנוצרו באמצעות פרופילי חיוב עם רמת חשבונית "שותף".
בקשת HTTP
GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/invoices
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
advertiserId |
חובה. המזהה של המפרסם שצריך לרשום את החשבוניות שלו. |
פרמטרים של שאילתה
פרמטרים | |
---|---|
issueMonth |
החודש שעבורו צריך לרשום את החשבוניות. אם היא לא מוגדרת, הבקשה תאחזר חשבוניות של החודש הקודם. חייב להיות בפורמט YYYYMM. |
loiSapinInvoiceType |
יש לבחור את סוג החשבונית שברצונך לאחזר עבור מפרסמים של Loi Sapin. רלוונטי רק למפרסמים הקשורים ל-Loi Sapin. אחרת, המערכת תתעלם מהם. |
pageSize |
גודל הדף המבוקש. חייב להיות בין |
pageToken |
אסימון שמזהה דף של תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"invoices": [
{
object ( |
שדות | |
---|---|
invoices[] |
רשימת החשבוניות. אם הרשימה ריקה, היא לא תופיע. |
nextPageToken |
אסימון לאחזור של דף התוצאות הבא. צריך להעביר את הערך הזה בשדה האסימון הזה חסר אם אין יותר המרות מסוג |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של 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 ( |
שדות | |
---|---|
name |
שם המשאב של החשבונית. |
invoiceId |
המזהה הייחודי של החשבונית. |
displayName |
השם המוצג של החשבונית. |
paymentsProfileId |
המספר של פרופיל התשלומים שאליו שייכת החשבונית. מופיע בקובץ ה-PDF של החשבונית בתור |
paymentsAccountId |
מספר חשבון התשלומים שאליו שייכת החשבונית. מופיע בקובץ ה-PDF של החשבונית בתור |
issueDate |
תאריך הפקת החשבונית. |
dueDate |
התאריך שבו יש לשלם את החשבונית. |
serviceDateRange |
תאריכי ההתחלה והסיום של השירות שכלולים בחשבונית הזו. |
currencyCode |
המטבע שמצוין בחשבונית בפורמט ISO 4217. |
subtotalAmountMicros |
סכום הביניים לפני מס, במיליוניות השנייה של מטבע החשבונית. לדוגמה, אם הערך של |
totalTaxAmountMicros |
סכום כל המיסים בחשבונית, במיליוניות השנייה של מטבע החשבונית. לדוגמה, אם הערך של |
totalAmountMicros |
סכום החשבונית הכולל, במיליוניות השנייה של מטבע החשבונית. לדוגמה, אם הערך של |
purchaseOrderNumber |
מספר הזמנת הרכש שמשויך לחשבונית. |
budgetInvoiceGroupingId |
מזהה קיבוץ התקציבים בחשבונית הזו. השדה הזה יוגדר רק אם רמת החשבונית של פרופיל החיוב התואם הוגדרה כ'מזהה קיבוץ חשבוניות תקציב'. |
invoiceType |
הסוג של מסמך החשבונית. |
correctedInvoiceId |
המזהה של החשבונית המקורית שעוברת התאמה בעקבות החשבונית הזו, אם רלוונטי. יכול להופיע בקובץ ה-PDF של החשבונית בתור אם מגדירים את |
replacedInvoiceIds[] |
המזהים של כל חשבונית שהונפקה במקור ושבוטלה על ידי החשבונית הזו, אם רלוונטי. אפשר להציג כמה חשבוניות אם החשבוניות אוחדו לחשבונית אחת. יכול להופיע בקובץ PDF של החשבונית בתור אם מגדירים את |
pdfUrl |
כתובת ה-URL להורדת עותק PDF של החשבונית. כתובת ה-URL הזו ספציפית למשתמש וכדי לגשת אליה נדרש אסימון גישה חוקי מסוג OAuth 2.0. יש לספק את אסימון הגישה בכותרת HTTP של
כתובת ה-URL תהיה בתוקף למשך 7 ימים לאחר אחזור האובייקט של החשבונית או עד שהחשבונית תאוחזר שוב. |
budgetSummaries[] |
רשימת הסיכום של כל תקציב שמשויך לחשבונית הזו. השדה הזה יוגדר רק אם רמת פרטי החשבונית של פרופיל החיוב התואם הוגדרה כ'הזמנת רכש ברמת התקציב'. |
nonBudgetMicros |
הסכום הכולל של העלויות או ההתאמות שלא קשורות לתקציב מסוים, במיליוניות השנייה של המטבע בחשבונית. לדוגמה, אם הערך של |
InvoiceType
סוגים אפשריים של חשבוניות.
טיפוסים בני מנייה (enums) | |
---|---|
INVOICE_TYPE_UNSPECIFIED |
לא צוין או לא ידוע בגרסה הזו. |
INVOICE_TYPE_CREDIT |
בחשבונית יש סכום שלילי. |
INVOICE_TYPE_INVOICE |
בחשבונית יש סכום חיובי. |
BudgetSummary
מידע מסוכם על תקציב של קמפיין אחד.
ייצוג JSON |
---|
{
"externalBudgetId": string,
"prismaCpeCode": {
object ( |
שדות | |
---|---|
externalBudgetId |
תואם ל- |
prismaCpeCode |
קודים רלוונטיים של לקוחות, מוצרים והערכות מכלי Mediaocean Prisma. רלוונטי רק לתקציבים של קמפיינים עם |
preTaxAmountMicros |
סכום החיובים שבוצעו במסגרת התקציב הזה לפני מיסים, במיליוניות השנייה של המטבע בחשבונית. לדוגמה, אם הערך של |
taxAmountMicros |
סכום המס שחל על החיובים במסגרת התקציב הזה, במיליוניות השנייה של מטבע החשבונית. לדוגמה, אם הערך של |
totalAmountMicros |
הסכום הכולל של החיובים שבוצעו במסגרת התקציב הזה, כולל מס, במיליוניות השנייה של המטבע בחשבונית. לדוגמה, אם הערך של |