Package google.cloud.gsuiteaddons.v1

الفهرس

إضافات G Suite

هي خدمة لإدارة عمليات نشر إضافة 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

لمزيد من المعلومات، راجِع دليل التفويض.

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

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

  • gsuiteaddons.deployments.create
deploymentId

string

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

Deployment

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

DeleteDeploymentRequest

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

الحقول
name

string

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

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

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

  • gsuiteaddons.deployments.delete
etag

string

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

التفعيل

نشر إضافة 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 عملية نشر كحد أقصى. الحد الأقصى للقيمة الممكنة هو 1000؛ القيم التي تزيد عن 1000 تتغير إلى 1000.
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