Package google.cloud.gsuiteaddons.v1

इंडेक्स

G SuiteAdOns

यह 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

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 से मेल खाना चाहिए.

डिप्लॉयमेंट

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