Reports API: דוח שימוש בישויות

דוח השימוש בישויות מחזיר פעילויות בשירות של Google Workspace שקשורות לישויות ששימשו את המשתמשים בחשבון שלך. אפשר להתאים אישית ולסנן את הדוחות לפי שימוש ספציפי מידע. הנתונים זמינים מ-30 הימים האחרונים.

ניתן להשתמש בדוח השימוש בישויות למטרות חוקיות בלבד בהתאם להסכם הלקוח שלך. הדוחות האלה חלים גם על Google Workspace ו-Education.

אחזור כל פעילויות השימוש בישויות

נכון לעכשיו, סוג הישות היחיד שנתמך על ידי ה-API הזה הוא קהילות ב-Google+. כדי לאחזר דוח על כל הפעילויות הקשורות לישויות של האפליקציה בחשבון שלך, השתמש באפשרויות הבאות בקשת HTTP אחת (GET) וכוללת את אסימון ההרשאה המתואר ב מסמכי ההרשאה. עבור קריאותיות. הדוגמה הבאה מעוצבת עם החזרות שורות:

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

הערך date הוא התאריך שבו נעשה השימוש וחותמת הזמן נמצאת פורמט ISO 8601, yyyy-mm-dd. אנחנו ממליצים לך להשתמש באזור הזמן של החשבון שלך לשם כך. למידע נוסף על הפרמטרים של מחרוזת השאילתה מאפייני תגובה, ראו API הפניה. למידע על הפרמטרים של דוח השימוש בישויות, ראו את פרמטרים של שימוש בישויות .

applicationParameters היא רשימה מופרדת בפסיקים של פרמטרים שרוצים לאחזר. כל פרמטר מופיע בפורמט application:parameter_name, לדוגמה, gplus:community_name. הפרמטרים הזמינים מתועדים פרמטרים של שימוש בישויות . אם לא מציינים פרמטרים, כל הפרמטרים מוחזרים.

parameterFilters היא רשימת מסננים מופרדים בפסיקים שצריך להחיל על התוצאות. כל אחד המסנן מופיע בפורמט application:parameter_name[relational_operator]parameter_value לדוגמה, מסנן gplus:num_total_members>100 מסנן את התוצאות כך שיכילו רק תוצאות כאשר לפרמטר gplus:num_total_members יש ערך גדול מ-100.

maxResults הוא מספר התוצאות המקסימלי שצריך להחזיר באחזור יחיד. אם המספר הכולל מספר התוצאות גדול מזה, התשובה תיחתך היעד nextPageToken ייכלל (יש לעיין ב דוגמה לתגובת JSON שבהמשך).

דוגמאות

בדוגמה הבאה מקבלים דוח שמכיל את כל הפרמטרים לכל gplus_communities הישויות.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11

בדוגמה הבאה מקבלים דוח שמכיל את הפרמטר community_name לכל הישויות של gplus_communities.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11?parameters=gplus:community_name

בדוגמה הבאה מופיע דוח על community_name ועל num_total_members לכל ישות gplus_communities, סינון לפי קהילות המונות יותר מ-100 חברים. דוגמה לתגובת API: דוגמה לתגובת JSON.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11
?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100

GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11

{
 "kind": "reports#usageReports",
 "nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA",
 "usageReports": [
 {
   "kind": "admin#reports#usageReport",
   "date": "2017-12-11",
   "entity": {
    "type": "OBJECT",
    "customerId": "C03az79cb",
    "objectType": "GPLUS_COMMUNITY",
    "objectId": "1234",
   },
   "parameters": [
    {
      "name": "gplus:community_name",
      "stringValue": "My Community"
    },
    {
     "name": "gplus:num_total_members",
     "intValue": 37
    },
    {
     "name": "gplus:num_7day_active_members",
     "intValue": 12
    },
    {
     "name": "gplus:num_30day_active_members",
     "intValue": 17
    },
   ]
  }
 ]
}

{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": "PARTIAL_DATA_AVAILABLE"
      "message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
      "data": [
        {
          "key": "date"
          "value": "2017-12-11"
        }
      ]
    }
  ],
 "usageReports": [],
}