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

Calendar ऐड-ऑन का कॉन्फ़िगरेशन.
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

मिटाए जाने वाले डिप्लॉयमेंट का 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 पर 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