חשוב: אנחנו לא מקבלים יותר רישומים חדשים עבור Play EMM API.
מידע נוסף
Enterprises
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
רשימה של שיטות למשאב הזה מופיעה בסוף הדף.
ייצוגים של משאבים
משאב Enterprises מייצג את הקישור בין מערכת ניהול מכשירים לארגון ספציפי. אפשר ליצור את הקישור הזה באחת משתי דרכים באמצעות ה-API הזה:
- אצל לקוחות עם דומיינים בניהול Google, התהליך כולל שימוש ב-
Enterprises.enroll וב-Enterprises.setAccount (בשילוב עם ארטיפקטים שהתקבלו ממסוף Admin וממסוף Google API) ושליחה ל-EMM בתהליך ידני פחות או יותר. - עבור לקוחות עם חשבונות Google Play מנוהלים, התהליך כולל שימוש ב-
Enterprises.generateSignupUrl וב-Enterprises.completeSignup בשילוב עם ממשק המשתמש להרשמה ל-Google Play המנוהל (מנגנון ש-Google מספקת) כדי ליצור את הקישור בלי שלבים ידניים.
בתור מערכת ניהול מכשירים ניידים, אתם יכולים לתמוך בשתי הגישות או באחת מהן במסוף ה-EMM. פרטים נוספים זמינים במאמר יצירת ארגון.
{
"kind": "androidenterprise#enterprise",
"id": string,
"primaryDomain": string,
"name": string,
"administrator": [
{
"email": string
}
],
"enterpriseType": string,
"managedGoogleDomainType": string
}
| שם הנכס |
ערך |
תיאור |
הערות |
administrator[] |
list |
אדמינים בארגון. האפשרות הזו נתמכת רק לארגונים שנוצרו באמצעות התהליך שמתחיל ב-EMM.
|
|
administrator[].email |
string |
כתובת האימייל של האדמין. |
|
enterpriseType |
string |
סוג הארגון.
הערכים הקבילים הם:
- "
enterpriseTypeUnspecified"
- "
managedGoogleDomain"
- "
managedGooglePlayAccountsEnterprise"
|
|
id |
string |
המזהה הייחודי של הארגון.
|
|
kind |
string |
|
|
managedGoogleDomainType |
string |
הסוג של דומיין Google המנוהל
הערכים הקבילים הם:
- "
managedGoogleDomainTypeUnspecified"
- "
typeDomain"
- "
typeTeam"
|
|
name |
string |
שם הארגון, למשל 'Example, Inc'. |
|
primaryDomain |
string |
הדומיין הראשי של הארגון, למשל example.com. |
|
Methods
- acknowledgeNotificationSet
- ההודעה מאשרת את ההתראות שהתקבלו מ-Enterprises.PullNotificationSet כדי למנוע מקריאות הבאות להחזיר את אותן התראות.
- completeSignup
- משלים את תהליך ההרשמה על ידי ציון אסימון ההשלמה ואסימון הארגון.
אסור להפעיל את הבקשה הזו כמה פעמים עבור אסימון ארגוני נתון.
- createWebToken
- מחזירה אסימון ייחודי לגישה לממשק משתמש שניתן להטמיע. כדי ליצור ממשק משתמש אינטרנטי, מעבירים את הטוקן שנוצר ל-API של JavaScript של Google Play לארגונים. אפשר להשתמש בכל אסימון רק כדי להתחיל סשן אחד של ממשק משתמש. מידע נוסף זמין
במסמכי העזרה של JavaScript API.
- enroll
- רישום ארגון אצל ספק ה-EMM הקורא.
- generateEnterpriseUpgradeUrl
- יצירת כתובת URL לשדרוג ארגוני כדי לשדרג קבוצת חשבונות קיימת של Google Play לארגונים לדומיין מנוהל ב-Google.
פרטים נוספים זמינים
במדריך לשדרוג ארגון.
- 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 הקורא.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-28 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-28 (שעון UTC)."],[[["\u003cp\u003eAn Enterprises resource represents the connection between an EMM and an organization, established through either manual enrollment for Google-managed domains or automated signup for managed Google Play Accounts.\u003c/p\u003e\n"],["\u003cp\u003eEMMs can support either or both enrollment methods, offering flexibility in binding with organizations.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides various methods to manage enterprises, including enrollment, sign-up, retrieval of enterprise details, and more.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eEnterprises\u003c/code\u003e resource includes properties like ID, primary domain, name, and administrators, offering comprehensive information about the enterprise.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can leverage the API's methods to interact with and manage enterprise data, enabling seamless integration with their EMM solutions.\u003c/p\u003e\n"]]],[],null,["# Enterprises\n\n\u003cbr /\u003e\n\nFor a list of [methods](#methods) for this resource, see the end of this page.\n\nResource representations\n------------------------\n\nAn Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows:\n\n- For Google managed domain customers, the process involves using `Enterprises.enroll` and `Enterprises.setAccount` (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process.\n- For managed Google Play Accounts customers, the process involves using `Enterprises.generateSignupUrl` and `Enterprises.completeSignup` in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps.\n\nAs an EMM, you can support either or both approaches in your EMM console. See [Create an Enterprise](/android/work/play/emm-api/create-enterprise) for details. \n\n\u003cbr /\u003e\n\n```text\n{\n \"kind\": \"androidenterprise#enterprise\",\n \"id\": string,\n \"primaryDomain\": string,\n \"name\": string,\n \"administrator\": [\n {\n \"email\": string\n }\n ],\n \"enterpriseType\": string,\n \"managedGoogleDomainType\": string\n}\n```\n\n| Property name | Value | Description | Notes |\n|---------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `administrator[]` | `list` | Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow. | |\n| administrator[].`email` | `string` | The admin's email address. | |\n| `enterpriseType` | `string` | The type of the enterprise. \u003cbr /\u003e Acceptable values are: - \"`enterpriseTypeUnspecified`\" - \"`managedGoogleDomain`\" - \"`managedGooglePlayAccountsEnterprise`\" | |\n| `id` | `string` | The unique ID for the enterprise. | |\n| `kind` | `string` | | |\n| `managedGoogleDomainType` | `string` | The type of managed Google domain \u003cbr /\u003e Acceptable values are: - \"`managedGoogleDomainTypeUnspecified`\" - \"`typeDomain`\" - \"`typeTeam`\" | |\n| `name` | `string` | The name of the enterprise, for example, \"Example, Inc\". | |\n| `primaryDomain` | `string` | The enterprise's primary domain, such as \"example.com\". | |\n\nMethods\n-------\n\n[acknowledgeNotificationSet](/android/work/play/emm-api/v1/enterprises/acknowledgeNotificationSet)\n: Acknowledges notifications that were received from\n Enterprises.PullNotificationSet to prevent subsequent calls from returning\n the same notifications.\n\n[completeSignup](/android/work/play/emm-api/v1/enterprises/completeSignup)\n: Completes the signup flow, by specifying the Completion token and\n Enterprise token.\n This request must not be called multiple times for a given Enterprise\n Token.\n\n[createWebToken](/android/work/play/emm-api/v1/enterprises/createWebToken)\n: Returns a unique token to access an embeddable UI. To generate a\n web UI, pass the generated token into the managed Google Play javascript\n API. Each token may only be used to start one UI session. See the\n [JavaScript API documentation](https://developers.google.com/api-client-library/javascript/apis/androidenterprise/v1) for further information.\n\n[enroll](/android/work/play/emm-api/v1/enterprises/enroll)\n: Enrolls an enterprise with the calling EMM.\n\n[generateEnterpriseUpgradeUrl](/android/work/play/emm-api/v1/enterprises/generateEnterpriseUpgradeUrl)\n: Generates an enterprise upgrade URL to upgrade an existing managed Google\n Play Accounts enterprise to a managed Google domain.\n See [the guide to upgrading an enterprise](/android/work/play/emm-api/upgrade-an-enterprise) for more details.\n\n[generateSignupUrl](/android/work/play/emm-api/v1/enterprises/generateSignupUrl)\n: Generates a sign-up URL.\n\n[get](/android/work/play/emm-api/v1/enterprises/get)\n: Retrieves the name and domain of an enterprise.\n\n[getServiceAccount](/android/work/play/emm-api/v1/enterprises/getServiceAccount)\n: Returns a service account and credentials. The service account\n can be bound to the enterprise by calling setAccount. The service account\n is unique to this enterprise and EMM, and will be deleted if the enterprise\n is unbound. The credentials contain private key data and are not stored\n server-side.\n\n \u003cbr /\u003e\n\n\n This method can only be called after calling\n Enterprises.Enroll or Enterprises.CompleteSignup, and before\n Enterprises.SetAccount; at other times it will return an error.\n\n \u003cbr /\u003e\n\n\n Subsequent calls after the first will generate a new, unique set of\n credentials, and invalidate the previously generated credentials.\n\n \u003cbr /\u003e\n\n\n Once the service account is bound to the enterprise, it can be managed\n using the serviceAccountKeys resource.\n\n \u003cbr /\u003e\n\n\n \u003cbr /\u003e\n\n | **Note:** After you create a key, you might need to wait for 60 seconds or more before you perform another operation with the key. If you try to perform an operation with the key immediately after you create the key, and you receive an error, you can [retry\n | the request with exponential backoff](https://cloud.google.com/iam/docs/retry-strategy)\n\n \u003cbr /\u003e\n\n .\n\n[getStoreLayout](/android/work/play/emm-api/v1/enterprises/getStoreLayout)\n: Returns the store layout for the enterprise. If the store layout\n has not been set, returns \"basic\" as the store layout type and no\n homepage.\n\n[list](/android/work/play/emm-api/v1/enterprises/list)\n: Looks up an enterprise by domain name.\n This is only supported for enterprises created via the Google-initiated\n creation flow. Lookup of the id is not needed for enterprises created via\n the EMM-initiated flow since the EMM learns the enterprise ID in the\n callback specified in the Enterprises.generateSignupUrl call.\n\n[pullNotificationSet](/android/work/play/emm-api/v1/enterprises/pullNotificationSet)\n: Pulls and returns a notification set for the enterprises associated with\n the service account authenticated for the request. The notification set may\n be empty if no notification are pending.\n\n\n A notification set returned needs to be acknowledged within 20 seconds\n by calling Enterprises.AcknowledgeNotificationSet, unless the\n notification set is empty.\n\n\n Notifications that are not acknowledged within the 20 seconds will\n eventually be included again in the response to another PullNotificationSet\n request, and those that are never acknowledged will ultimately be deleted\n according to the Google Cloud Platform Pub/Sub system policy.\n\n\n Multiple requests might be performed concurrently to retrieve\n notifications, in which case the pending notifications (if any) will be\n split among each caller, if any are pending.\n\n\n If no notifications are present, an empty notification list is returned.\n Subsequent requests may return more notifications once they become\n available.\n\n[sendTestPushNotification](/android/work/play/emm-api/v1/enterprises/sendTestPushNotification)\n: Sends a test notification to validate the EMM integration with\n the Google Cloud Pub/Sub service for this enterprise.\n\n[setAccount](/android/work/play/emm-api/v1/enterprises/setAccount)\n: Sets the account that will be used to authenticate to the API as the\n enterprise.\n\n[setStoreLayout](/android/work/play/emm-api/v1/enterprises/setStoreLayout)\n: Sets the store layout for the enterprise. By default, storeLayoutType\n is set to \"basic\" and the basic store layout is enabled. The basic\n layout only contains apps approved by the admin, and that have\n been added to the available product set for a user (using the\n [setAvailableProductSet](/android/work/play/emm-api/v1/users/setAvailableProductSet) call). Apps on the page are sorted in order of\n their product ID value. If you create a custom store layout (by setting\n storeLayoutType = \"custom\" and setting a homepage), the basic store\n layout is disabled.\n\n[unenroll](/android/work/play/emm-api/v1/enterprises/unenroll)\n: Unenrolls an enterprise from the calling EMM."]]
