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

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.

AddOns

Google Workspace ऐड-ऑन का कॉन्फ़िगरेशन.

फ़ील्ड
common

CommonAddOnManifest

Google Workspace के सभी ऐड-ऑन में कॉन्फ़िगरेशन एक जैसा होता है.
gmail

GmailAddOnManifest

Gmail ऐड-ऑन का कॉन्फ़िगरेशन.
drive

DriveAddOnManifest

Drive ऐड-ऑन का कॉन्फ़िगरेशन.
calendar

CalendarAddOnManifest

कैलेंडर ऐड-ऑन कॉन्फ़िगरेशन.
docs

DocsAddOnManifest

Docs ऐड-ऑन कॉन्फ़िगरेशन.
sheets

SheetsAddOnManifest

Sheets ऐड-ऑन का कॉन्फ़िगरेशन.
slides

SlidesAddOnManifest

Slides ऐड-ऑन का कॉन्फ़िगरेशन.
httpOptions

HttpOptions

ऐड-ऑन एचटीटीपी एंडपॉइंट को अनुरोध भेजने के विकल्प

अनुमति देना

डिप्लॉयमेंट एंडपॉइंट को शुरू करने में इस्तेमाल की जाने वाली अनुमति देने की जानकारी.

फ़ील्ड
name

string

इस संसाधन का पूरा कैननिकल नाम. उदाहरण: projects/123/authorization
serviceAccountEmail

string

ऐड-ऑन कॉलबैक एंडपॉइंट के अनुरोधों की पुष्टि करने के लिए, इस्तेमाल किए जाने वाले सेवा खाते का ईमेल पता.
oauthClientId

string

OAuth क्लाइंट आईडी का इस्तेमाल, ऐड-ऑन की ओर से किसी उपयोगकर्ता के लिए OAuth ऐक्सेस टोकन पाने के लिए किया जाता है.

CreateDeploymentRequest

डिप्लॉयमेंट बनाने के लिए अनुरोध मैसेज.

फ़ील्ड
parent

string

ज़रूरी है. उस प्रोजेक्ट का नाम जिसमें डिप्लॉयमेंट बनाना है.

उदाहरण: projects/my_project.

अनुमति पाने के लिए, दिए गए संसाधन parent पर IAM की यह अनुमति ज़रूरी है:

  • 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 पर IAM की यह अनुमति ज़रूरी है:

  • 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 पर IAM की यह अनुमति ज़रूरी है:

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

डिप्लॉयमेंट पाने के लिए मैसेज का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. जिस डिप्लॉयमेंट को ऐक्सेस करना है उसका पूरा नाम.

उदाहरण: projects/my_project/deployments/my_deployment.

अनुमति पाने के लिए, दिए गए संसाधन name पर IAM की यह अनुमति ज़रूरी है:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

टेस्ट डिप्लॉयमेंट के इंस्टॉल की स्थिति की जानकारी पाने के लिए, मैसेज का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. डिप्लॉयमेंट के संसाधन का पूरा नाम.

उदाहरण: projects/my_project/deployments/my_deployment/installStatus.

अनुमति देने के लिए, बताए गए संसाधन name पर इस IAM अनुमति की ज़रूरत है:

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

टेस्टिंग के लिए डिप्लॉयमेंट इंस्टॉल करने का अनुरोध करने वाला मैसेज.

फ़ील्ड
name

string

ज़रूरी है. इंस्टॉल किए जाने वाले डिप्लॉयमेंट का पूरा नाम.

उदाहरण: projects/my_project/deployments/my_deployment.

अनुमति पाने के लिए, दिए गए संसाधन name पर IAM की यह अनुमति ज़रूरी है:

  • gsuiteaddons.deployments.install

InstallStatus

टेस्ट डिप्लॉयमेंट के इंस्टॉल होने की स्थिति.

फ़ील्ड
name

string

डिप्लॉयमेंट के इंस्टॉल की स्थिति के कैननिकल वर्शन का पूरा संसाधन नाम.

उदाहरण: projects/123/deployments/my_deployment/installStatus.
installed

BoolValue

अगर उपयोगकर्ता के लिए डिप्लॉयमेंट इंस्टॉल किया गया है, तो वैल्यू 'सही' होगी.

ListDeploymentsRequest

किसी प्रोजेक्ट के डिप्लॉयमेंट की सूची बनाने के लिए अनुरोध मैसेज.

फ़ील्ड
parent

string

ज़रूरी है. उस प्रोजेक्ट का नाम जिसमें डिप्लॉयमेंट बनाना है.

उदाहरण: projects/my_project.

अनुमति पाने के लिए, दिए गए संसाधन parent पर IAM की यह अनुमति ज़रूरी है:

  • 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 पर इस IAM अनुमति की ज़रूरत है:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

टेस्ट डिप्लॉयमेंट को अनइंस्टॉल करने के लिए मैसेज का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. इंस्टॉल किए जाने वाले डिप्लॉयमेंट का पूरा नाम.

उदाहरण: projects/my_project/deployments/my_deployment.

अनुमति पाने के लिए, दिए गए संसाधन name पर IAM की यह अनुमति ज़रूरी है:

  • gsuiteaddons.deployments.execute