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)

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