Package google.cloud.gsuiteaddons.v1

الفهرس

GSuiteAddOns

هي خدمة لإدارة عمليات نشر إضافات Google Workspace.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

تنشئ عملية نشر بالاسم والإعداد المحدّدين.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

لحذف عملية النشر بالاسم المحدّد

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

تحصل على معلومات التفويض لعمليات النشر في مشروع معيّن.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

تحصل على عملية النشر بالاسم المحدّد.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

يحصل على حالة تثبيت عملية نشر تجريبية.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

تثبيت عملية نشر في حسابك لاختبارها لمزيد من المعلومات، يُرجى الاطّلاع على مقالة اختبار الإضافة.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

يسرد جميع عمليات النشر في مشروع معيّن.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

لإنشاء عملية نشر أو استبدالها بالاسم المحدّد

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

إلغاء تثبيت عملية نشر تجريبية من حساب المستخدم لمزيد من المعلومات، يُرجى الاطّلاع على اختبار الإضافة.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

الإضافات

ضبط إضافة Google Workspace

الحقول
common

CommonAddOnManifest

الإعدادات الشائعة في جميع إضافات Google Workspace
gmail

GmailAddOnManifest

إعدادات إضافة Gmail
drive

DriveAddOnManifest

إعدادات إضافة ميزات Drive
calendar

CalendarAddOnManifest

إعداد إضافة "تقويم Google"
docs

DocsAddOnManifest

إعداد إضافة "مستندات Google"
sheets

SheetsAddOnManifest

إعدادات إضافة "جداول بيانات Google"
slides

SlidesAddOnManifest

إعدادات إضافة "العروض التقديمية من Google"
httpOptions

HttpOptions

خيارات إرسال الطلبات إلى نقاط نهاية HTTP الإضافية

التفويض

معلومات التفويض المستخدَمة عند استدعاء نقاط نهاية النشر

الحقول
name

string

الاسم الكامل الأساسي لهذا المورد. مثلاً: projects/123/authorization
serviceAccountEmail

string

عنوان البريد الإلكتروني لحساب الخدمة المُستخدَم لمصادقة طلبات نقاط نهاية معاودة الاتصال للإضافات.
oauthClientId

string

معرِّف عميل OAuth المستخدَم للحصول على رموز الدخول عبر OAuth لمستخدم معيَّن بالنيابة عن الإضافة.

CreateDeploymentRequest

رسالة طلب لإنشاء عملية نشر

الحقول
parent

string

مطلوب. اسم المشروع الذي تريد إنشاء عملية النشر فيه.

مثال: projects/my_project

يتطلّب التفويض الحصول على إذن إدارة الهوية وإمكانية الوصول التالي للمورد المحدّد parent:

  • gsuiteaddons.deployments.create
deploymentId

string

مطلوب. المعرّف الذي سيتم استخدامه لهذا النشر. سيكون الاسم الكامل للمورد الذي تم إنشاؤه هو projects/<project_number>/deployments/<deployment_id>.
deployment

Deployment

مطلوب. عملية النشر المطلوب إنشاؤها (لا يمكن ضبط deployment.name).

DeleteDeploymentRequest

طلب رسالة لحذف عملية نشر

الحقول
name

string

مطلوب. اسم المورد الكامل للنشر المطلوب حذفه.

مثال: projects/my_project/deployments/my_deployment

يتطلّب التفويض الحصول على إذن إدارة الهوية وإمكانية الوصول التالي للمورد المحدّد name:

  • gsuiteaddons.deployments.delete
etag

string

علامة etag لعملية النشر المطلوب حذفها. في حال توفّر هذا العنصر، يجب أن يتطابق مع علامة etag الخاصة بالخادم.

التفعيل

عملية نشر إضافة على Google Workspace

الحقول
name

string

اسم مورد النشر. مثال: projects/123/deployments/my_deployment
oauthScopes[]

string

قائمة نطاقات Google OAuth التي يمكن طلب موافقة المستخدم النهائي عليها قبل تنفيذ نقطة نهاية للإضافة.
addOns

AddOns

إعدادات إضافة Google Workspace
etag

string

يحسب الخادم هذه القيمة استنادًا إلى إصدار عملية النشر في مساحة التخزين، وقد يتم إرسالها عند طلبات التعديل والحذف لضمان حصول العميل على قيمة محدّثة قبل المتابعة.

GetAuthorizationRequest

اطلب رسالة للحصول على معلومات تفويض إضافة Google Workspace.

الحقول
name

string

مطلوب. اسم المشروع الذي سيتم الحصول على معلومات تفويض إضافة Google Workspace له.

مثال: projects/my_project/authorization

يتطلّب التفويض الحصول على إذن إدارة الهوية وإمكانية الوصول التالي للمورد المحدّد name:

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

رسالة طلب للحصول على عملية نشر

الحقول
name

string

مطلوب. اسم المورد الكامل لعملية النشر التي تريد الحصول عليها.

مثال: projects/my_project/deployments/my_deployment

يتطلّب التفويض الحصول على إذن إدارة الهوية وإمكانية الوصول التالي للمورد المحدّد name:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

رسالة طلب للحصول على حالة تثبيت عملية النشر التجريبية

الحقول
name

string

مطلوب. اسم المورد الكامل لعملية النشر.

مثال: projects/my_project/deployments/my_deployment/installStatus

يتطلّب التفويض الحصول على إذن إدارة الهوية وإمكانية الوصول التالي للمورد المحدّد name:

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

طلب رسالة لتثبيت عملية نشر من أجل الاختبار

الحقول
name

string

مطلوب. اسم المورد الكامل للنشر المطلوب تثبيته.

مثال: projects/my_project/deployments/my_deployment

يتطلّب التفويض الحصول على إذن إدارة الهوية وإمكانية الوصول التالي للمورد المحدّد name:

  • gsuiteaddons.deployments.install

InstallStatus

حالة تثبيت عملية نشر تجريبية

الحقول
name

string

اسم المورد الكامل الأساسي لحالة تثبيت عملية النشر

مثال: projects/123/deployments/my_deployment/installStatus
installed

BoolValue

صحيح إذا تم تثبيت عملية النشر للمستخدم.

ListDeploymentsRequest

رسالة طلب لعرض عمليات النشر لمشروع

الحقول
parent

string

مطلوب. اسم المشروع الذي تريد إنشاء عملية النشر فيه.

مثال: projects/my_project

يتطلب التفويض إذن إدارة الهوية وإمكانية الوصول التالي على المورد المحدّد parent:

  • gsuiteaddons.deployments.list
pageSize

int32

الحد الأقصى لعدد عمليات النشر المطلوب عرضها قد تعرض الخدمة أقل من هذه القيمة. وفي حال عدم تحديد ذلك، يتم إرجاع 1,000 عملية نشر كحدّ أقصى. الحدّ الأقصى للقيمة الممكنة هو 1,000، ويتمّ تغيير القيم الأعلى من 1,000 إلى 1,000.
pageToken

string

رمز مميّز للصفحة، تم تلقّيه من مكالمة ListDeployments سابقة قدِّم هذا المرجع لاسترداد الصفحة اللاحقة.

عند تقسيم الصفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى ListDeployments مع الطلب الذي قدّم الرمز المميّز للصفحة.

ListDeploymentsResponse

رسالة ردّ لقائمة عمليات النشر

الحقول
deployments[]

Deployment

قائمة عمليات النشر للمشروع المحدّد
nextPageToken

string

رمز مميّز يمكن إرساله على شكل page_token لاسترداد الصفحة التالية. في حال إسقاط هذا الحقل، لن تظهر أي صفحات لاحقة.

ReplaceDeploymentRequest

طلب رسالة لإنشاء عملية نشر أو استبدالها

الحقول
deployment

Deployment

مطلوب. عملية النشر المراد إنشاؤها أو استبدالها

يتطلب التفويض إذن إدارة الهوية وإمكانية الوصول التالي على المورد المحدّد deployment:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

طلب رسالة لإلغاء تثبيت عملية نشر تجريبية

الحقول
name

string

مطلوب. اسم المورد الكامل للنشر المطلوب تثبيته.

مثال: projects/my_project/deployments/my_deployment

يتطلّب التفويض الحصول على إذن إدارة الهوية وإمكانية الوصول التالي للمورد المحدّد name:

  • gsuiteaddons.deployments.execute