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