ملاحظة مهمة: لم نعد نقبل عمليات التسجيل الجديدة لواجهة برمجة تطبيقات Play لخدمة إدارة الأجهزة الجوّالة للمؤسسات (EMM).
مزيد من المعلومات
Enterprises
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
للحصول على قائمة بالأساليب لهذا المرجع، يُرجى الاطّلاع على نهاية هذه الصفحة.
تمثيلات الموارد
يمثّل مورد "المشاريع" الربط بين إدارة الخدمات الجوّالة للمؤسسات ومؤسسة معيّنة. يمكن إنشاء مثيل لهذا الربط بإحدى الطريقتَين التاليتَين باستخدام واجهة برمجة التطبيقات هذه:
- بالنسبة إلى عملاء النطاقات المُدارة من Google، تتضمّن العملية استخدام
Enterprises.enroll وEnterprises.setAccount (بالاشتراك مع العناصر التي تم الحصول عليها من "وحدة تحكّم المشرف" و"وحدة تحكّم Google API") وإرسالها إلى إدارة الخدمات الجوّالة للمؤسسات (EMM) من خلال عملية يدوية إلى حدٍ ما. - بالنسبة إلى عملاء حسابات Google Play المُدارة، تتضمّن العملية استخدام
Enterprises.generateSignupUrl وEnterprises.completeSignup مع واجهة مستخدم الاشتراك في Google Play للأعمال (آلية تقدّمها Google) لإنشاء عملية الربط بدون خطوات يدوية.
بصفتك مقدّم خدمة إدارة الخدمات الجوّالة للمؤسسات (EMM)، يمكنك توفير أي من الطريقتَين أو كليهما في وحدة تحكّم إدارة الخدمات الجوّالة للمؤسسات. اطّلِع على إنشاء حساب Enterprise لمعرفة التفاصيل.
{
"kind": "androidenterprise#enterprise",
"id": string,
"primaryDomain": string,
"name": string,
"administrator": [
{
"email": string
}
],
"enterpriseType": string,
"managedGoogleDomainType": string
}
| اسم السمة |
القيمة |
الوصف |
ملاحظات |
administrator[] |
list |
مشرفي المؤسسة لا تتوفّر هذه الميزة إلا للمؤسسات التي تم إنشاؤها من خلال العملية التي تبدأها إدارة الخدمات الجوّالة للمؤسسات.
|
|
administrator[].email |
string |
عنوان البريد الإلكتروني الخاص بالمشرف |
|
enterpriseType |
string |
نوع المؤسسة
القِيَم المقبولة هي:
- "
enterpriseTypeUnspecified"
- "
managedGoogleDomain"
- "
managedGooglePlayAccountsEnterprise"
|
|
id |
string |
المعرّف الفريد للمؤسسة.
|
|
kind |
string |
|
|
managedGoogleDomainType |
string |
نوع نطاق Google المُدار
القِيَم المقبولة هي:
- "
managedGoogleDomainTypeUnspecified"
- "
typeDomain"
- "
typeTeam"
|
|
name |
string |
اسم المؤسسة، مثل "شركة كذا" |
|
primaryDomain |
string |
النطاق الأساسي للمؤسسة، مثل example.com |
|
الطُرق
- acknowledgeNotificationSet
- يُقرّ هذا الإجراء بالإشعارات التي تم استلامها من
Enterprises.PullNotificationSet لمنع المكالمات اللاحقة من عرض
الإشعارات نفسها.
- completeSignup
- يُكمِل عملية الاشتراك من خلال تحديد رمز الاكتمال و
رمز المؤسسة.
يجب عدم استدعاء هذا الطلب عدة مرات لرمز علامتك التجارية في Enterprise.
- createWebToken
- تعرض رمزًا فريدًا للوصول إلى واجهة مستخدم قابلة للتضمين. لإنشاء
واجهة مستخدم على الويب، عليك تمرير الرمز المميَّز الذي تم إنشاؤه إلى واجهة برمجة التطبيقات
لبرنامج JavaScript في Google Play للأعمال. لا يمكن استخدام كل رمز مميّز إلا لبدء جلسة واحدة لواجهة المستخدم. اطّلِع على
مستندات JavaScript API للحصول على مزيد من المعلومات.
- تسجيل
- تسجيل مؤسسة باستخدام خدمة إدارة الخدمات الجوّالة للمؤسسات (EMM) التي تُجري المكالمة
- generateEnterpriseUpgradeUrl
- إنشاء عنوان URL لترقية المؤسسة من أجل ترقية "حسابات Google Play للأعمال" الحالية إلى نطاق Google مُدار
اطّلِع على
دليل ترقية مؤسسة للحصول على مزيد من التفاصيل.
- generateSignupUrl
- إنشاء عنوان URL للاشتراك
- الحصول
- استرداد اسم مؤسسة ونطاقها
- getServiceAccount
- يعرض حساب خدمة وبيانات اعتماد. يمكن ربط حساب الخدمة
بالمؤسسة من خلال استدعاء setAccount. يكون حساب الخدمة
فريدًا لهذا المؤسّسة وإدارة الخدمات الجوّالة للمؤسسات، وسيتم حذفه في حال إلغاء ربط المؤسّسة. تحتوي بيانات الاعتماد على بيانات المفتاح الخاص ولا يتم تخزينها
على الخادم.
لا يمكن استدعاء هذه الطريقة إلا بعد استدعاء methods:
Enterprises.Enroll أو Methods: Enterprises.CompleteSignup، وقبل methods: Enterprises.SetAccount، وفي الأوقات الأخرى ستظهر رسالة خطأ.
ستؤدي الطلبات اللاحقة بعد الطلب الأول إلى إنشاء مجموعة جديدة وفريدة من
بيانات الاعتماد، وإلغاء صلاحية بيانات الاعتماد التي تم إنشاؤها سابقًا.
بعد ربط حساب الخدمة بالمؤسسة، يمكن إدارته
باستخدام مورد serviceAccountKeys.
..
- getStoreLayout
- تعرض تنسيق المتجر للمؤسسة. إذا لم يتم ضبط تنسيق المتجر، يتم عرض "أساسي" كنوع تنسيق المتجر ولا يتم عرض
صفحة رئيسية.
- list
- البحث عن مؤسسة حسب اسم النطاق
لا تتوفّر هذه الميزة إلا للمؤسسات التي تم إنشاؤها من خلال عملية الإنشاء التي تبدأها Google. لا يلزم البحث عن رقم التعريف للمؤسسات التي تم إنشاؤها من خلال
التدفق الذي يبدأه موفِّر إدارة الخدمات الجوّالة للمؤسسات (EMM)، لأنّ موفِّر إدارة الخدمات الجوّالة للمؤسسات (EMM) يتعرّف على رقم تعريف المؤسسة في
الاستدعاء المحدّد في طلب Enterprises.generateSignupUrl.
- pullNotificationSet
- تسترجع هذه الوظيفة مجموعة إشعارات للمؤسسات المرتبطة
بحساب الخدمة الذي تم مصادقة الطلب من أجله. قد تكون مجموعة الإشعارات
فارغة إذا لم تكن هناك إشعارات في انتظار المراجعة.
يجب الردّ على مجموعة الإشعارات التي تم إرجاعها في غضون 20 ثانية
من خلال الاتصال بـ Enterprises.AcknowledgeNotificationSet، ما لم تكن
مجموعة الإشعارات فارغة.
سيتم في النهاية تضمين الإشعارات التي لم يتم تأكيدها خلال 20 ثانية مجددًا في الردّ على طلب آخر من نوع PullNotificationSet
، وسيتم حذف الإشعارات التي لم يتم تأكيدها مطلقًا في نهاية المطاف
وفقًا لسياسة نظام Pub/Sub في Google Cloud Platform.
قد يتم تنفيذ طلبات متعدّدة بشكل متزامن لاسترداد
الإشعارات، وفي هذه الحالة سيتم хувين الإشعارات في انتظار المراجعة (إن وجدت)
بين كل متصل، إن وجد.
في حال عدم توفّر أي إشعارات، يتم عرض قائمة إشعارات فارغة.
قد تؤدي الطلبات اللاحقة إلى عرض المزيد من الإشعارات فور توفّرها.
- sendTestPushNotification
- يُرسِل إشعارًا تجريبيًا للتحقّق من عملية دمج إدارة الخدمات الجوّالة للمؤسسات مع
خدمة Google Cloud Pub/Sub لهذه المؤسسة.
- setAccount
- يضبط الحساب الذي سيتم استخدامه للمصادقة على واجهة برمجة التطبيقات على أنّه
المؤسسة.
- setStoreLayout
- تُستخدَم لضبط تنسيق المتجر للمؤسسة. يكون متغير storeLayoutType
مضبوطًا تلقائيًا على "أساسي" ويتم تفعيل تنسيق المتجر الأساسي. لا يحتوي التنسيق الأساسي
إلا على التطبيقات التي وافق عليها المشرف والتي تمت
إضافتها إلى مجموعة المنتجات المتاحة للمستخدم (باستخدام طلب
setAvailableProductSet). يتم ترتيب التطبيقات على الصفحة حسب قيمة
معرّف المنتج. إذا أنشأت تنسيق متجر مخصّصًا (من خلال ضبط
storeLayoutType = "custom" وضبط صفحة رئيسية)، سيتم إيقاف تنسيق المتجر
الأساسي.
- إلغاء التسجيل
- إلغاء تسجيل مؤسسة من خدمة إدارة الخدمات الجوّالة للمؤسسات (EMM) التي تتصل
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-28 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-28 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\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."]]
