Method: stats.getIndex

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

הערה: כדי להפעיל את ה-API הזה, נדרש חשבון רגיל של משתמש קצה.

בקשת HTTP

GET https://cloudsearch.googleapis.com/v1/stats/index

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של שאילתה

פרמטרים
fromDate

object (Date)

תאריך ההתחלה של טווח התאריכים שעבורו יש לאחזר את הנתונים הסטטיסטיים. הערך הזה חייב להיות בטווח של עד שנה מהתאריך הנוכחי.

toDate

object (Date)

סוף טווח התאריכים שעבורו יש לאחזר את הנתונים הסטטיסטיים. הערך הזה חייב להיות בטווח של שנה מהתאריך הנוכחי וגדול מ-fromDate.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התגובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON
{
  "stats": [
    {
      object (CustomerIndexStats)
    }
  ],
  "averageIndexedItemCount": string
}
שדות
stats[]

object (CustomerIndexStats)

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

averageIndexedItemCount

string (int64 format)

מספר הפריטים הממוצע בטווח התאריכים הנתון שבו בוצע החיוב.

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של 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

למידע נוסף, ניתן לעיין במדריך ההרשאות.

CustomerIndexStats

צבירה של פריטים לפי קוד סטטוס נכון לתאריך שצוין.

ייצוג JSON
{
  "date": {
    object (Date)
  },
  "itemCountByStatus": [
    {
      object (ItemCountByStatus)
    }
  ]
}
שדות
date

object (Date)

התאריך שעבורו חושבו הנתונים הסטטיסטיים.

itemCountByStatus[]

object (ItemCountByStatus)

מספר הפריטים המצטברים לפי קוד סטטוס.