Package google.cloud.gsuiteaddons.v1

شاخص

GSuiteAddOns

سرویسی برای مدیریت استقرار افزونه های Google Workspace.

CreateDeployment

rpc CreateDeployment( CreateDeploymentRequest ) returns ( Deployment )

یک استقرار با نام و پیکربندی مشخص شده ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

Delete Deployment

rpc DeleteDeployment( DeleteDeploymentRequest ) returns ( Empty )

استقرار با نام داده شده را حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

دریافت مجوز

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

لیست استقرارها

rpc ListDeployments( ListDeploymentsRequest ) returns ( ListDeploymentsResponse )

تمام استقرارها در یک پروژه خاص را فهرست می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

Replace Deployment

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

پیکربندی افزونه تقویم

docs

DocsAddOnManifest

پیکربندی افزونه Docs.

sheets

SheetsAddOnManifest

پیکربندی افزونه Sheets.

slides

SlidesAddOnManifest

پیکربندی افزودنی اسلایدها.

http Options

HttpOptions

گزینه هایی برای ارسال درخواست به نقاط پایانی HTTP افزودنی

مجوز

اطلاعات مجوز مورد استفاده هنگام فراخوانی نقاط پایانی استقرار.

فیلدها
name

string

نام کامل متعارف این منبع. مثال: projects/123/authorization

service Account Email

string

آدرس ایمیل حساب سرویس مورد استفاده برای احراز هویت درخواست‌ها برای نقاط پایانی برگشت به تماس افزودنی.

oauth Client Id

string

شناسه مشتری OAuth برای به دست آوردن نشانه های دسترسی OAuth برای یک کاربر از طرف افزونه استفاده می شود.

CreateDeploymentRequest

درخواست پیام برای ایجاد استقرار.

فیلدها
parent

string

مورد نیاز. نام پروژه ای که در آن استقرار ایجاد می شود.

مثال: projects/my_project .

مجوز نیاز به مجوز IAM زیر در parent منبع مشخص شده دارد:

  • gsuiteaddons.deployments.create
deployment Id

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

تگ استقرار برای حذف. در صورت ارائه، باید با تگ سرور مطابقت داشته باشد.

استقرار

استقرار افزونه Google Workspace

فیلدها
name

string

نام منبع استقرار. مثال: projects/123/deployments/my_deployment .

oauth Scopes[]

string

فهرستی از حوزه‌های Google OAuth که برای درخواست رضایت از کاربر نهایی قبل از اجرای نقطه پایانی افزودنی است.

add Ons

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

اگر Deployment برای کاربر نصب شده باشد درست است.

ListDeploymentsRequest

درخواست پیام برای فهرست استقرارهای یک پروژه.

فیلدها
parent

string

مورد نیاز. نام پروژه ای که در آن استقرار ایجاد می شود.

مثال: projects/my_project .

مجوز نیاز به مجوز IAM زیر در parent منبع مشخص شده دارد:

  • gsuiteaddons.deployments.list
page Size

int32

حداکثر تعداد استقرار برای بازگشت. ممکن است این سرویس کمتر از این مقدار را برگرداند. اگر نامشخص باشد، حداکثر 1000 استقرار برگردانده می شود. حداکثر مقدار ممکن 1000 است. مقادیر بالای 1000 به 1000 تغییر می کند.

page Token

string

یک نشانه صفحه، دریافت شده از تماس قبلی ListDeployments . این را برای بازیابی صفحه بعدی ارائه دهید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به ListDeployments باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.

ListDeploymentsResponse

پیام پاسخ به استقرار فهرست.

فیلدها
deployments[]

Deployment

لیست استقرارها برای پروژه داده شده

next Page Token

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
،

شاخص

GSuiteAddOns

سرویسی برای مدیریت استقرار افزونه های Google Workspace.

CreateDeployment

rpc CreateDeployment( CreateDeploymentRequest ) returns ( Deployment )

یک استقرار با نام و پیکربندی مشخص شده ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

Delete Deployment

rpc DeleteDeployment( DeleteDeploymentRequest ) returns ( Empty )

استقرار با نام داده شده را حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

دریافت مجوز

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

لیست استقرارها

rpc ListDeployments( ListDeploymentsRequest ) returns ( ListDeploymentsResponse )

تمام استقرارها در یک پروژه خاص را فهرست می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

Replace Deployment

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

پیکربندی افزونه جیمیل.

drive

DriveAddOnManifest

پیکربندی افزونه Drive.

calendar

CalendarAddOnManifest

پیکربندی افزونه تقویم

docs

DocsAddOnManifest

پیکربندی افزونه Docs.

sheets

SheetsAddOnManifest

پیکربندی افزونه Sheets.

slides

SlidesAddOnManifest

پیکربندی افزودنی اسلایدها.

http Options

HttpOptions

گزینه هایی برای ارسال درخواست به نقاط پایانی HTTP افزودنی

مجوز

اطلاعات مجوز مورد استفاده هنگام فراخوانی نقاط پایانی استقرار.

فیلدها
name

string

نام کامل متعارف این منبع. مثال: projects/123/authorization

service Account Email

string

آدرس ایمیل حساب سرویس مورد استفاده برای احراز هویت درخواست‌ها برای نقاط پایانی برگشت به تماس افزودنی.

oauth Client Id

string

شناسه مشتری OAuth برای به دست آوردن نشانه های دسترسی OAuth برای یک کاربر از طرف افزونه استفاده می شود.

CreateDeploymentRequest

درخواست پیام برای ایجاد استقرار.

فیلدها
parent

string

مورد نیاز. نام پروژه ای که در آن استقرار ایجاد می شود.

مثال: projects/my_project .

مجوز نیاز به مجوز IAM زیر در parent منبع مشخص شده دارد:

  • gsuiteaddons.deployments.create
deployment Id

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

تگ استقرار برای حذف. در صورت ارائه، باید با تگ سرور مطابقت داشته باشد.

استقرار

استقرار افزونه Google Workspace

فیلدها
name

string

نام منبع استقرار. مثال: projects/123/deployments/my_deployment .

oauth Scopes[]

string

فهرستی از حوزه‌های Google OAuth که برای درخواست رضایت از کاربر نهایی قبل از اجرای نقطه پایانی افزودنی است.

add Ons

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

اگر Deployment برای کاربر نصب شده باشد درست است.

ListDeploymentsRequest

درخواست پیام برای فهرست استقرارهای یک پروژه.

فیلدها
parent

string

مورد نیاز. نام پروژه ای که در آن استقرار ایجاد می شود.

مثال: projects/my_project .

مجوز نیاز به مجوز IAM زیر در parent منبع مشخص شده دارد:

  • gsuiteaddons.deployments.list
page Size

int32

حداکثر تعداد استقرار برای بازگشت. ممکن است این سرویس کمتر از این مقدار را برگرداند. اگر نامشخص باشد، حداکثر 1000 استقرار برگردانده می شود. حداکثر مقدار ممکن 1000 است. مقادیر بالای 1000 به 1000 تغییر می کند.

page Token

string

یک نشانه صفحه، دریافت شده از تماس قبلی ListDeployments . این را برای بازیابی صفحه بعدی ارائه کنید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به ListDeployments باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.

ListDeploymentsResponse

پیام پاسخ به استقرار فهرست.

فیلدها
deployments[]

Deployment

لیست استقرارها برای پروژه داده شده

next Page Token

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