Package google.cloud.gsuiteaddons.v1

الفهرس

GSuiteAddOns

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

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

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

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

تؤدي هذه الوظيفة إلى حذف عملية النشر التي تحمل الاسم المحدّد.

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

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

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

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

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

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

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

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

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

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

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

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

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

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

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.

AddOns

إعدادات إضافة على 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

يتطلّب التفويض إذن IAM التالي على المورد المحدّد 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

يتطلّب التفويض إذن IAM التالي على المورد المحدّد 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

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

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

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

الحقول
name

string

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

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

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

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

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

الحقول
name

string

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

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

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

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

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

الحقول
name

string

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

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

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

  • gsuiteaddons.deployments.install

InstallStatus

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

الحقول
name

string

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

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

BoolValue

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

ListDeploymentsRequest

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

الحقول
parent

string

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

مثال: projects/my_project

يتطلّب التفويض إذن IAM التالي على المورد المحدّد 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

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

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

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

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

الحقول
name

string

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

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

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

  • gsuiteaddons.deployments.execute