קבלת נתונים סטטיסטיים של פריטים שנוספו לאינדקס עבור מקור נתונים יחיד.
הערה: כדי להפעיל את ה-API הזה, נדרש חשבון רגיל של משתמש קצה.
בקשת HTTP
GET https://cloudsearch.googleapis.com/v1/stats/index/{name=datasources/*}
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
name |
מזהה המשאב של מקור הנתונים שעבורו יש לאחזר נתונים סטטיסטיים, בפורמט הבא: "datasources/{sourceId}" |
פרמטרים של שאילתה
פרמטרים | |
---|---|
fromDate |
תחילת טווח התאריכים שעבורו יש לאחזר נתונים סטטיסטיים, ב-PST. הערך הזה חייב להיות בטווח של עד שנה מהתאריך הנוכחי. הערך fromDate ו-toDate יכולים להיות זהים כדי לספק נתונים סטטיסטיים עבור יום אחד. אם גם fromDate וגם toDate מוגדרים ליום הנוכחי, יוצגו נתונים סטטיסטיים בזמן אמת לגבי היום הנוכחי. הערה: בקשות לקבלת נתונים סטטיסטיים בזמן אמת ממקורות נתונים גדולים הן יקרות וזמן האחזור שלהן ארוך. |
toDate |
סוף טווח התאריכים שעבורו יש לקבל נתונים סטטיסטיים, ב-PST. הערך הזה חייב להיות בטווח של עד שנה מהתאריך הנוכחי. אם הוא מוגדר לתאריך הנוכחי, מוחזרים נתונים סטטיסטיים בזמן אמת. הערה: בקשות לקבלת נתונים סטטיסטיים בזמן אמת ממקורות נתונים גדולים הן יקרות וזמן האחזור שלהן ארוך. הערך fromDate ו-toDate יכולים להיות זהים כדי לספק נתונים סטטיסטיים עבור יום אחד. אם גם fromDate וגם toDate מוגדרים ליום הנוכחי, יוצגו נתונים סטטיסטיים בזמן אמת לגבי היום הנוכחי. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של GetDataSourceIndexStatsResponse
.
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/cloud_search.stats.indexing
https://www.googleapis.com/auth/cloud_search.stats
https://www.googleapis.com/auth/cloud_search
למידע נוסף, ניתן לעיין במדריך ההרשאות.