רשימה של שיטות למשאב הזה מופיעה בסוף הדף הזה.
ייצוגים של משאבים
משאב Enterprises מייצג את הקישור בין מערכת ניהול מכשירים לניהול (EMM) לארגון ספציפי. אפשר ליצור מופע של הקישור הזה באחת משתי דרכים שונות באמצעות ה-API הזה, באופן הבא:
- אצל לקוחות עם דומיינים בניהול Google, התהליך כולל שימוש ב-
Enterprises.enroll
וב-Enterprises.setAccount
(בשילוב עם ארטיפקטים שהתקבלו ממסוף Admin וממסוף Google API) ושליחה ל-EMM בתהליך ידני פחות או יותר. - עבור לקוחות עם חשבונות Google Play מנוהלים, התהליך כולל שימוש ב-
Enterprises.generateSignupUrl
וב-Enterprises.completeSignup
בשילוב עם ממשק המשתמש להרשמה ל-Google Play המנוהל (מנגנון ש-Google מספקת) כדי ליצור את הקישור בלי שלבים ידניים.
{ "kind": "androidenterprise#enterprise", "id":string , "primaryDomain":string , "name":string , "administrator": [ { "email":string } ], "enterpriseType":string , "managedGoogleDomainType":string }
שם הנכס | ערך | תיאור | הערות |
---|---|---|---|
administrator[] |
list |
אדמינים בארגון. האפשרות הזו נתמכת רק לארגונים שנוצרו באמצעות התהליך שמתחיל ב-EMM. |
|
administrator[].email |
string |
כתובת האימייל של האדמין. | |
enterpriseType |
string |
סוג הארגון.
הערכים הקבילים הם:
|
|
id |
string |
המזהה הייחודי של הארגון. |
|
kind |
string |
||
managedGoogleDomainType |
string |
הסוג של דומיין Google המנוהל
הערכים הקבילים הם:
|
|
name |
string |
שם הארגון, למשל 'Example, Inc'. | |
primaryDomain |
string |
הדומיין הראשי של הארגון, למשל example.com. |
Methods
- acknowledgeNotificationSet
- ההודעה מאשרת את ההתראות שהתקבלו מ-Enterprises.PullNotificationSet כדי למנוע מקריאות הבאות להחזיר את אותן התראות.
- completeSignup
- משלים את תהליך ההרשמה על ידי ציון אסימון ההשלמה ואסימון הארגון. אסור להפעיל את הבקשה הזו כמה פעמים עבור אסימון Enterprise נתון.
- createWebToken
- מחזירה אסימון ייחודי לגישה לממשק משתמש שניתן להטמיע. כדי ליצור ממשק משתמש אינטרנטי, מעבירים את הטוקן שנוצר ל-API של JavaScript של Google Play לארגונים. אפשר להשתמש בכל אסימון רק כדי להתחיל סשן אחד בממשק המשתמש. מידע נוסף זמין במסמכי העזרה של JavaScript API.
- enroll
- רישום ארגון אצל ספק ה-EMM הקורא.
- generateSignupUrl
- יצירת כתובת URL להרשמה.
- get
- אחזור השם והדומיין של ארגון.
- getServiceAccount
- מחזירה חשבון שירות ופרטי כניסה. אפשר לשייך את חשבון השירות לארגון באמצעות קריאה ל-setAccount. חשבון השירות ייחודי לארגון ול-EMM הזה, והוא יימחק אם הקישור לארגון יבוטל. פרטי הכניסה מכילים נתוני מפתח פרטי ולא מאוחסנים בצד השרת.
אפשר להפעיל את השיטה הזו רק אחרי שמפעילים את השיטה Methods.Enroll או Methods.CompleteSignup, ולפני שמפעילים את השיטה Methods.SetAccount. במקרים אחרים, תוחזר שגיאה.
קריאות נוספות אחרי הקריאה הראשונה ייצרו קבוצה חדשה וייחודית של פרטי כניסה, ויבטלו את פרטי הכניסה שנוצרו קודם.
אחרי שמקשרים את חשבון השירות לארגון, אפשר לנהל אותו באמצעות המשאב serviceAccountKeys. - getStoreLayout
- החזרת הפריסה של החנות לארגון. אם לא הוגדר פריסה של החנות, המערכת תחזיר את הערך 'בסיסי' כסוג הפריסה של החנות, ולא תציג דף בית.
- list
- חיפוש ארגון לפי שם דומיין. התכונה הזו נתמכת רק בארגונים שנוצרו דרך תהליך היצירה של Google. אין צורך לחפש את המזהה בארגונים שנוצרו באמצעות התהליך שמופעל על ידי EMM, כי ה-EMM לומד את מזהה הארגון בקריאה החוזרת (callback) שצוינה בקריאה Enterprises.generateSignupUrl.
- pullNotificationSet
- משיכה והחזרה של קבוצת התראות לארגונים שמשויכים לחשבון השירות שאומת עבור הבקשה. קבוצת ההתראות עשויה להיות ריקה אם אין התראות בהמתנה.
אם קבוצת ההתראות חזרה, צריך לאשר אותה תוך 20 שניות על ידי קריאה ל-Enterprises.AcknowledgeNotificationSet, אלא אם קבוצת ההתראות ריקה.
התראות שלא אושרו תוך 20 שניות ייכללו שוב בתגובה לבקשה אחרת של PullNotificationSet, והתראות שלא אושרו אף פעם יימחקו בסופו של דבר בהתאם למדיניות המערכת של Pub/Sub ב-Google Cloud Platform.
יכול להיות שיתבצעו כמה בקשות בו-זמנית כדי לאחזר התראות, ובמקרה כזה ההתראות בהמתנה (אם יש כאלה) יתחלקו בין כל מבצע הקריאה החוזרת, אם יש כאלה.
אם אין התראות, המערכת מחזירה רשימת התראות ריקה. בקשות נוספות עשויות להחזיר התראות נוספות ברגע שהן יהיו זמינות. - sendTestPushNotification
- שליחת התראה לבדיקה כדי לאמת את השילוב של ה-EMM עם שירות Google Cloud Pub/Sub לארגון הזה.
- setAccount
- הגדרת החשבון שישמש לאימות ב-API בתור הארגון.
- setStoreLayout
- הגדרת הפריסה של החנות לארגון. כברירת מחדל, הערך של storeLayoutType מוגדר ל-'basic' ועיצוב החנות הבסיסי מופעל. הפריסה הבסיסית מכילה רק אפליקציות שאושרו על ידי האדמין ונוספו לקבוצת המוצרים הזמינה למשתמש (באמצעות הקריאה setAvailableProductSet). האפליקציות בדף ממוינות לפי הערך של מזהה המוצר. אם יוצרים פריסה מותאמת אישית של החנות (על ידי הגדרת storeLayoutType = "custom" והגדרת דף בית), הפריסה הבסיסית של החנות מושבתת.
- ביטול ההרשמה
- ביטול ההרשמה של ארגון מ-EMM הקורא.