Google Workspace add-ons API
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
الخدمة: gsuiteaddons.googleapis.com
لطلب هذه الخدمة، ننصحك باستخدام مكتبات البرامج التي توفّرها Google. إذا كان تطبيقك يحتاج إلى استخدام مكتباتك الخاصة لاستدعاء هذه الخدمة، استخدِم المعلومات التالية عند تقديم طلبات واجهة برمجة التطبيقات.
مستند Discovery
مستند الاكتشاف هو مواصفة يمكن للآلة قراءتها لوصف واجهات برمجة تطبيقات REST واستخدامها. يُستخدم في إنشاء مكتبات للعملاء، ومكونات IDE الإضافية، وأدوات أخرى تتفاعل مع Google APIs. قد توفّر خدمة واحدة مستندات استكشاف متعددة. توفّر هذه الخدمة مستند Discovery التالي:
نقطة نهاية الخدمة
نقطة نهاية الخدمة هي عنوان URL أساسي يحدّد عنوان الشبكة لخدمة واجهة برمجة التطبيقات. قد تحتوي خدمة واحدة على عدة نقاط نهاية للخدمة. تشتمل هذه الخدمة على نقطة نهاية الخدمة التالية، وترتبط جميع معرّفات الموارد المنتظمة (URI) أدناه بنقطة نهاية الخدمة هذه:
https://gsuiteaddons.googleapis.com
| الطُرق |
getAuthorization |
GET /v1/{name=projects/*/authorization}
يحصل على معلومات التفويض لعمليات النشر في مشروع معيّن. |
| الطُرق |
create |
POST /v1/{parent=projects/*}/deployments
تنشئ عملية نشر بالاسم والضبط المحدّدين. |
delete |
DELETE /v1/{name=projects/*/deployments/*}
لحذف عملية النشر بالاسم المحدّد |
get |
GET /v1/{name=projects/*/deployments/*}
الحصول على عملية النشر بالاسم المحدّد |
getInstallStatus |
GET /v1/{name=projects/*/deployments/*/installStatus}
يحصل على حالة تثبيت عملية نشر تجريبية. |
install |
POST /v1/{name=projects/*/deployments/*}:install
تثبيت عملية نشر في حسابك للاختبار |
list |
GET /v1/{parent=projects/*}/deployments
يسرد جميع عمليات النشر في مشروع معيّن. |
replaceDeployment |
PUT /v1/{deployment.name=projects/*/deployments/*}
تنشئ عملية نشر أو تستبدلها بالاسم المحدّد. |
uninstall |
POST /v1/{name=projects/*/deployments/*}:uninstall
إلغاء تثبيت نشر تجريبي من حساب المستخدم. |
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eThis service, \u003ccode\u003egsuiteaddons.googleapis.com\u003c/code\u003e, provides REST APIs for managing Google Workspace Add-ons deployments.\u003c/p\u003e\n"],["\u003cp\u003eYou can use Google-provided client libraries or your own libraries with the provided discovery document and service endpoint information to interact with the APIs.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ev1.projects\u003c/code\u003e resource allows you to retrieve authorization details for add-on deployments in a project.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ev1.projects.deployments\u003c/code\u003e resource offers methods to create, delete, retrieve, install, list, replace, and uninstall add-on deployments.\u003c/p\u003e\n"],["\u003cp\u003eUse the service endpoint \u003ccode\u003ehttps://gsuiteaddons.googleapis.com\u003c/code\u003e as the base URL for all API requests.\u003c/p\u003e\n"]]],["The `gsuiteaddons.googleapis.com` service provides REST resources for managing projects and their deployments. Key actions for `v1.projects.deployments` include creating, deleting, getting, listing, and replacing deployments, and getting the install status. Additionally, deployments can be installed or uninstalled. The `v1.projects` resource supports retrieving authorization information for deployments. The API utilizes a base URL `https://gsuiteaddons.googleapis.com` and offers a Discovery Document for machine-readable specifications.\n"],null,["# Google Workspace add-ons API\n\n- [REST Resource: v1.projects](#v1.projects)\n- [REST Resource: v1.projects.deployments](#v1.projects.deployments)\n\nService: gsuiteaddons.googleapis.com\n------------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:\n\n- \u003chttps://gsuiteaddons.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://gsuiteaddons.googleapis.com`\n\nREST Resource: [v1.projects](/workspace/add-ons/reference/rest/v1/projects)\n---------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|\n| [getAuthorization](/workspace/add-ons/reference/rest/v1/projects/getAuthorization) | `GET /v1/{name=projects/*/authorization}` Gets the authorization information for deployments in a given project. |\n\nREST Resource: [v1.projects.deployments](/workspace/add-ons/reference/rest/v1/projects.deployments)\n---------------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|\n| [create](/workspace/add-ons/reference/rest/v1/projects.deployments/create) | `POST /v1/{parent=projects/*}/deployments` Creates a deployment with the specified name and configuration. |\n| [delete](/workspace/add-ons/reference/rest/v1/projects.deployments/delete) | `DELETE /v1/{name=projects/*/deployments/*}` Deletes the deployment with the given name. |\n| [get](/workspace/add-ons/reference/rest/v1/projects.deployments/get) | `GET /v1/{name=projects/*/deployments/*}` Gets the deployment with the specified name. |\n| [getInstallStatus](/workspace/add-ons/reference/rest/v1/projects.deployments/getInstallStatus) | `GET /v1/{name=projects/*/deployments/*/installStatus}` Gets the install status of a test deployment. |\n| [install](/workspace/add-ons/reference/rest/v1/projects.deployments/install) | `POST /v1/{name=projects/*/deployments/*}:install` Installs a deployment to your account for testing. |\n| [list](/workspace/add-ons/reference/rest/v1/projects.deployments/list) | `GET /v1/{parent=projects/*}/deployments` Lists all deployments in a particular project. |\n| [replaceDeployment](/workspace/add-ons/reference/rest/v1/projects.deployments/replaceDeployment) | `PUT /v1/{deployment.name=projects/*/deployments/*}` Creates or replaces a deployment with the specified name. |\n| [uninstall](/workspace/add-ons/reference/rest/v1/projects.deployments/uninstall) | `POST /v1/{name=projects/*/deployments/*}:uninstall` Uninstalls a test deployment from the user's account. |"]]
