Package google.cloud.gsuiteaddons.v1

सूची

G Suite ऐड-ऑन

Google Workspace ऐड-ऑन डिप्लॉयमेंट को मैनेज करने की सेवा.

डिप्लॉयमेंट बनाएं

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

दिए गए नाम और कॉन्फ़िगरेशन के ज़रिए डिप्लॉयमेंट बनाता है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

डिप्लॉयमेंट मिटाएं

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

दिए गए नाम वाले डिप्लॉयमेंट को मिटाता है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

अनुमतियां पाएं

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

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

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

डिप्लॉयमेंट की सुविधा पाएं

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

तय किए गए नाम से डिप्लॉयमेंट की सुविधा मिलती है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

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

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

डिप्लॉयमेंट इंस्टॉल करना

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

जांच के लिए आपके खाते का डिप्लॉयमेंट इंस्टॉल करता है. ज़्यादा जानकारी के लिए, अपने ऐड-ऑन की जांच करना देखें

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

लिस्ट डिप्लॉयमेंट

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

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

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

डिप्लॉयमेंट बदलें

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

किसी डिप्लॉयमेंट को तय किए गए नाम से बनाता या बदलता है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

अनइंस्टॉल करने का डिप्लॉयमेंट

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

उपयोगकर्ता के खाते से टेस्ट डिप्लॉयमेंट को अनइंस्टॉल करता है. ज़्यादा जानकारी के लिए, ऐड-ऑन को आज़माना देखें.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

ऐड-ऑन

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

फ़ील्ड
common

CommonAddOnManifest

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

gmail

GmailAddOnManifest

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

drive

DriveAddOnManifest

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

calendar

CalendarAddOnManifest

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

docs

DocsAddOnManifest

'दस्तावेज़' ऐड-ऑन.

sheets

SheetsAddOnManifest

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

slides

SlidesAddOnManifest

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

httpOptions

HttpOptions

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

अनुमति देना

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

फ़ील्ड
name

string

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

serviceAccountEmail

string

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

oauthClientId

string

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

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

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

फ़ील्ड
parent

string

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

उदाहरण: projects/my_project.

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

  • gsuiteaddons.deployments.create
deploymentId

string

ज़रूरी है. इस डिप्लॉयमेंट के लिए इस्तेमाल किया जाने वाला आईडी. बनाए गए संसाधन का पूरा नाम projects/<project_number>/deployments/<deployment_id> होगा.

deployment

Deployment

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

डिप्लॉयमेंट अनुरोध मिटाएं

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

फ़ील्ड
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

इस वैल्यू का हिसाब, सर्वर से डिप्लॉयमेंट के वर्शन के आधार पर लगाया जाता है. साथ ही, इसे अपडेट करने और मिटाए जाने के लिए भेजा जा सकता है, ताकि यह पक्का हो सके कि क्लाइंट के पास अप-टू-डेट वैल्यू है, ताकि आगे बढ़ा जा सके.

ऑथराइज़ेशन अनुरोध

Google Workspace ऐड-ऑन को अनुमति देने के बारे में जानने के लिए, मैसेज का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. उस प्रोजेक्ट का नाम जिसके लिए, Google Workspace ऐड-ऑन से अनुमति लेने की जानकारी मिली है.

उदाहरण: projects/my_project/authorization.

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

  • gsuiteaddons.authorizations.get

डिप्लॉयडिप्लॉयमेंट अनुरोध

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

फ़ील्ड
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

Installडिप्लॉयमेंट अनुरोध

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

फ़ील्ड
name

string

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

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

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

  • gsuiteaddons.deployments.install

इंस्टॉल की स्थिति

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

फ़ील्ड
name

string

डिप्लॉयमेंट इंस्टॉल करने का पूरा संसाधन नाम.

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

installed

BoolValue

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

Listडिप्लॉयमेंट का अनुरोध

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

फ़ील्ड
parent

string

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

उदाहरण: projects/my_project.

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

  • gsuiteaddons.deployments.list
pageSize

int32

लौटाए जाने वाले डिप्लॉयमेंट की ज़्यादा से ज़्यादा संख्या. सेवा इस मान से कम वैल्यू दे सकती है. अगर इसे तय न किया गया हो, तो ज़्यादा से ज़्यादा 1,000 डिप्लॉयमेंट दिखाए जाते हैं. वैल्यू ज़्यादा से ज़्यादा 1,000 हो सकती है; 1,000 से ज़्यादा वैल्यू 1,000 में बदल जाती हैं.

pageToken

string

किसी पिछले ListDeployments कॉल से मिला पेज टोकन. अगले पेज को वापस पाने के लिए इसे उपलब्ध कराएं.

पेजों को क्रम में लगाने पर, ListDeployments को दिए गए अन्य सभी पैरामीटर, पेज के टोकन के साथ मिले कॉल से मेल खाने चाहिए.

Listडिप्लॉयमेंट का जवाब

डिप्लॉयमेंट की सूची के लिए जवाब का मैसेज.

फ़ील्ड
deployments[]

Deployment

दिए गए प्रोजेक्ट के डिप्लॉयमेंट की सूची.

nextPageToken

string

टोकन, जिसे अगले पेज का ऐक्सेस पाने के लिए page_token के तौर पर भेजा जा सकता है. अगर इस फ़ील्ड को खाली छोड़ा जाता है, तो इसके बाद कोई पेज नहीं होगा.

डिप्लॉयमेंट अनुरोध बदलें

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

फ़ील्ड
deployment

Deployment

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

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

  • gsuiteaddons.deployments.update

अनइंस्टॉलडिप्लॉयमेंट अनुरोध

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

फ़ील्ड
name

string

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

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

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

  • gsuiteaddons.deployments.execute