רשימה של ה-methods במשאב הזה מופיעה בסוף הדף.
ייצוגי משאבים
מייצג שאילתה.
{
"kind": "doubleclickbidmanager#query",
"queryId": long,
"metadata": {
"title": string,
"dataRange": string,
"format": string,
"running": boolean,
"reportCount": integer,
"googleCloudStoragePathForLatestReport": string,
"latestReportRunTimeMs": long,
"googleDrivePathForLatestReport": string,
"sendNotification": boolean,
"shareEmailAddress": [
string
],
"locale": string
},
"params": {
"type": string,
"groupBys": [
string
],
"filters": [
{
"type": string,
"value": string
}
],
"metrics": [
string
],
"includeInviteData": boolean
},
"schedule": {
"frequency": string,
"endTimeMs": long,
"nextRunMinuteOfDay": integer,
"nextRunTimezoneCode": string
},
"reportDataStartTimeMs": long,
"reportDataEndTimeMs": long,
"timezoneCode": string
}| שם הנכס | ערך | תיאור | הערות |
|---|---|---|---|
kind |
string |
מזהה את סוג המשאב הזה. ערך: המחרוזת הקבועה "doubleclickbidmanager#query". |
|
metadata |
nested object |
מטא-נתונים של שאילתה. | |
metadata.dataRange |
string |
הטווח של נתוני הדוח.
הערכים הקבילים הם:
|
|
metadata.format |
string |
הפורמט של הדוח שנוצר.
הערכים הקבילים הם:
|
|
metadata.googleCloudStoragePathForLatestReport |
string |
הנתיב למיקום ב-Google Cloud Storage שבו שמור הדוח העדכני ביותר. | |
metadata.googleDrivePathForLatestReport |
string |
הנתיב ב-Google Drive לדוח העדכני. | |
metadata.latestReportRunTimeMs |
long |
השעה שבה התחילה הרצת הדוח האחרון. | |
metadata.locale |
string |
הלוקאל של הדוחות שנוצרים. הערכים הקבילים הם:
מחרוזת לוקאל שלא מופיעה ברשימה שלמעלה תפיק דוחות באנגלית. |
|
metadata.reportCount |
integer |
מספר הדוחות שהופקו עבור השאילתה. | |
metadata.running |
boolean |
האם הדוח האחרון מופעל כרגע. | |
metadata.sendNotification |
boolean |
הגדרה שקובעת אם לשלוח התראה באימייל כשהדוח מוכן. ברירת המחדל היא False. | |
metadata.shareEmailAddress[] |
list |
רשימת כתובות אימייל שאליהן נשלחות התראות באימייל כשהדוח מסתיים. הפרדה מ-sendNotification. |
|
metadata.title |
string |
כותרת השאילתה. הוא משמש למתן שמות לדוחות שנוצרו מהשאילתה הזו. | |
params |
nested object |
פרמטרים של שאילתה. | |
params.filters[] |
list |
מסננים שמשמשים להתאמת נתוני התנועה בדוח. | |
params.filters[].type |
string |
סוג המסנן.
הערכים הקבילים הם:
|
|
params.filters[].value |
string |
ערך המסנן. | |
params.groupBys[] |
list |
הנתונים מקובצים לפי המסננים המפורטים בשדה הזה. | |
params.includeInviteData |
boolean |
הוצא משימוש. השדה הזה כבר לא בשימוש. | |
params.metrics[] |
list |
מדדים שייכללו כעמודות בדוח. | |
params.type |
string |
סוג הדוח. מגבלות ספציפיות לסוג:
הערכים הקבילים הם:
|
|
queryId |
long |
מזהה השאילתה. | |
reportDataEndTimeMs |
long |
מועד הסיום של הנתונים שמוצגים בדוח. הערה: הפרמטר reportDataEndTimeMs נדרש אם הערך של metadata.dataRange הוא CUSTOM_DATES, והמערכת תתעלם ממנו אחרת. |
|
reportDataStartTimeMs |
long |
שעת ההתחלה של הנתונים שמוצגים בדוח. הערה: הפרמטר reportDataStartTimeMs נדרש אם הערך של metadata.dataRange הוא CUSTOM_DATES, והמערכת תתעלם ממנו אחרת. |
|
schedule |
nested object |
מידע על התדירות והשעות להרצת שאילתה. | |
schedule.endTimeMs |
long |
התאריך והשעה שבהם ברצונך להריץ את השאילתה באופן תקופתי עד לתאריך. | |
schedule.frequency |
string |
באיזו תדירות השאילתה רצה.
הערכים הקבילים הם:
|
|
schedule.nextRunMinuteOfDay |
integer |
הוצא משימוש. לשדה הזה אין השפעה. | |
schedule.nextRunTimezoneCode |
string |
קוד אזור זמן קנוני של מועד יצירת הדוח. ברירת המחדל היא America/New_York. |
|
timezoneCode |
string |
קוד קנוני של אזור זמן לציון מועד נתוני הדוח. ברירת המחדל היא America/New_York. |
שיטות
- createquery
- יצירת שאילתה.
- deletequery
- מוחק שאילתה שמורה וגם את הדוחות השמורים המשויכים.
- getquery
- מאחזר שאילתה שמורה.
- listqueries
- מאחזר שאילתות שמורות.
- runquery
- מריץ שאילתה שמורה כדי ליצור דוח.