EventObject

EventObject

Google ऐड-ऑन इंटरैक्शन इवेंट में, होस्ट ऐप्लिकेशन में ऐड-ऑन के साथ उपयोगकर्ता के इंटरैक्शन का डेटा शामिल होता है.

जब कोई उपयोगकर्ता किसी होस्ट ऐप्लिकेशन में ऐड-ऑन के साथ इंटरैक्ट करता है, तो इवेंट ऑब्जेक्ट को JSON के तौर पर ऐड-ऑन के कॉलबैक फ़ंक्शन या ट्रिगर (AppsScript के लिए) या https एंडपॉइंट (एचटीटीपी के लिए) को पास किया जाता है. इवेंट ऑब्जेक्ट, हर होस्ट ऐप्लिकेशन के तय किए गए होस्ट ऐप्लिकेशन इवेंट ऑब्जेक्ट को सेव करता है. साथ ही, यह एक सामान्य इवेंट ऑब्जेक्ट को सेव करता है जिसमें इवेंट से जुड़े कुछ सामान्य फ़ील्ड होते हैं.

ज़्यादा जानकारी के लिए, इवेंट ऑब्जेक्ट देखें.

JSON के काेड में दिखाना
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
फ़ील्ड
commonEventObject

object (CommonEventObject)

यह एक ऐसा ऑब्जेक्ट है जिसमें सभी इवेंट ऑब्जेक्ट की सामान्य जानकारी होती है. भले ही, होस्ट ऐप्लिकेशन कोई भी हो.

authorizationEventObject

object (AuthorizationEventObject)

इसे सिर्फ़ एचटीटीपी एंडपॉइंट के अनुरोधों के लिए सेट किया जाता है

यहां उन फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
calendar

object (CalendarEventObject)

यह जानकारी सिर्फ़ तब दिखती है, जब कॉल करने वाला होस्ट Google Calendar हो. एक ऐसा ऑब्जेक्ट जिसमें कैलेंडर और इवेंट की जानकारी शामिल हो.

drive

object (DriveEventObject)

यह सिर्फ़ तब मौजूद होता है, जब कॉल करने वाला होस्ट Google Drive हो. एक ऐसा ऑब्जेक्ट जिसमें Drive की जानकारी शामिल हो.

gmail

object (GmailEventObject)

यह सिर्फ़ तब मौजूद होता है, जब कॉल करने वाला होस्ट Gmail हो. Gmail की जानकारी वाला ऑब्जेक्ट.

sheets

object (SheetsEventObject)

यह सिर्फ़ तब मौजूद होता है, जब कॉल करने वाला होस्ट Google Sheets हो. Sheets की जानकारी वाला ऑब्जेक्ट.

slides

object (SlidesEventObject)

यह जानकारी सिर्फ़ तब दिखती है, जब कॉल करने वाला होस्ट Google Slides हो. Slides की जानकारी वाला ऑब्जेक्ट.

docs

object (DocsEventObject)

यह सिर्फ़ तब मौजूद होता है, जब कॉल करने वाला होस्ट Google Docs हो. ऐसा ऑब्जेक्ट जिसमें Docs की जानकारी शामिल हो.

chat

object (ChatEventObject)

यह सिर्फ़ तब दिखता है, जब कॉल करने वाला होस्ट Google Chat हो. ऐसा ऑब्जेक्ट जिसमें चैट की जानकारी शामिल हो.

workflow

object (WorkflowEventObject)

यह सिर्फ़ तब मौजूद होता है, जब कॉल करने वाला होस्ट Google Workspace Studio हो. वर्कफ़्लो की जानकारी वाला ऑब्जेक्ट.

एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

CommonEventObject

कॉमन इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जो उपयोगकर्ता के क्लाइंट से ऐड-ऑन तक सामान्य और होस्ट से अलग जानकारी पहुंचाता है. इस जानकारी में, उपयोगकर्ता की जगह, होस्ट ऐप्लिकेशन, और प्लैटफ़ॉर्म जैसी जानकारी शामिल होती है.

होम पेज और काम के ट्रिगर के अलावा, ऐड-ऑन इवेंट ऑब्जेक्ट बनाते हैं और उन्हें ऐक्शन कॉलबैक फ़ंक्शन को पास करते हैं. ऐसा तब होता है, जब उपयोगकर्ता विजेट के साथ इंटरैक्ट करता है. आपके ऐड-ऑन का कॉलबैक फ़ंक्शन, सामान्य इवेंट ऑब्जेक्ट से क्वेरी कर सकता है. इससे उपयोगकर्ता के क्लाइंट में खुले विजेट के कॉन्टेंट का पता लगाया जा सकता है. उदाहरण के लिए, आपका ऐड-ऑन उस टेक्स्ट का पता लगा सकता है जिसे किसी उपयोगकर्ता ने eventObject.commentEventObject.formInputs ऑब्जेक्ट में TextInput विजेट में डाला है.

Chat ऐप्लिकेशन के लिए, उस फ़ंक्शन का नाम जिसे उपयोगकर्ता ने किसी विजेट से इंटरैक्ट करते समय इस्तेमाल किया था.

JSON के काेड में दिखाना
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
फ़ील्ड
userLocale

string

डिफ़ॉल्ट रूप से बंद है. उपयोगकर्ता की भाषा और देश/इलाके का आइडेंटिफ़ायर. यह ISO 639 भाषा कोड-ISO 3166 देश/इलाके के कोड के फ़ॉर्मैट में होता है. उदाहरण के लिए, en-US.

इस फ़ील्ड को चालू करने के लिए, आपको अपने ऐड-ऑन के मेनिफ़ेस्ट में addOns.common.useLocaleFromApp को true पर सेट करना होगा. आपके ऐड-ऑन के स्कोप की सूची में https://www.googleapis.com/auth/script.locale भी शामिल होना चाहिए. ज़्यादा जानकारी के लिए, उपयोगकर्ता की भाषा और टाइमज़ोन को ऐक्सेस करना लेख पढ़ें.

hostApp

enum (HostApp)

इससे पता चलता है कि इवेंट ऑब्जेक्ट जनरेट होने पर, ऐड-ऑन किस होस्ट ऐप्लिकेशन में चालू है. इनमें ये वैल्यू शामिल हो सकती हैं:

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

प्लैटफ़ॉर्म enum, जो उस प्लैटफ़ॉर्म के बारे में बताता है जहां इवेंट शुरू होता है (WEB, IOS या ANDROID). Chat ऐप्लिकेशन के साथ काम नहीं करता.

timeZone

object (TimeZone)

डिफ़ॉल्ट रूप से बंद है. टाइमज़ोन आईडी और कोऑर्डिनेटेड यूनिवर्सल टाइम (यूटीसी) से ऑफ़सेट. इस फ़ील्ड को चालू करने के लिए, आपको अपने ऐड-ऑन के मेनिफ़ेस्ट में addOns.common.useLocaleFromApp को true पर सेट करना होगा. आपके ऐड-ऑन के स्कोप की सूची में https://www.googleapis.com/auth/script.locale भी शामिल होना चाहिए. ज़्यादा जानकारी के लिए, उपयोगकर्ता की स्थानीय भाषा और टाइमज़ोन को ऐक्सेस करना लेख पढ़ें.

यह सिर्फ़ CARD_CLICKED और SUBMIT_DIALOG टाइप के इवेंट के लिए काम करता है.

formInputs

map (key: string, value: object (Inputs))

एक मैप, जिसमें दिखाए गए कार्ड में विजेट की मौजूदा वैल्यू शामिल हों. मैप की कुंजियां, हर इनपुट विजेट (जैसे, TextInput.name, SelectionInput.name, DateTimePicker.name या DecoratedText.SwitchControl.name) को असाइन की गई स्ट्रिंग name वैल्यू होती हैं.

मैप वैल्यू ऑब्जेक्ट का स्ट्रक्चर, विजेट के टाइप पर निर्भर करता है:

ध्यान दें: यहां दिए गए उदाहरण, Apps Script के V8 रनटाइम के लिए फ़ॉर्मैट किए गए हैं. अगर Rhino रनटाइम का इस्तेमाल किया जा रहा है, तो आपको वैल्यू के बाद [""] जोड़ना होगा. उदाहरण के लिए, इवेंट ऑब्जेक्ट को e.commonEventObject.formInputs.employeeName.stringInputs.value[0] के बजाय e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0] के तौर पर फ़ॉर्मैट करें. Apps Script में रनटाइम के बारे में ज़्यादा जानने के लिए, V8 रनटाइम की खास जानकारी देखें.

  • एक वैल्यू वाले विजेट (उदाहरण के लिए, TextInput विजेट या DROPDOWN या RADIO_BUTTON टाइप का SelectionInput विजेट): एक StringInputs ऑब्जेक्ट, जिसमें एक एलिमेंट वाली सूची शामिल होती है. अगर कोई विकल्प नहीं चुना जाता है, तो सूची खाली होती है.

उदाहरण: टेक्स्ट इनपुट विजेट के लिए, employeeName को name के तौर पर सेट करें. इसके बाद, टेक्स्ट इनपुट वैल्यू को e.commonEventObject.formInputs.employeeName.stringInputs.value[0] से ऐक्सेस करें.

  • एक से ज़्यादा वैल्यू वाले विजेट (उदाहरण के लिए, CHECK_BOX, SWITCH या MULTI_SELECT टाइप का SelectionInput विजेट): चुने गए आइटम value स्ट्रिंग की सूची वाला StringInputs ऑब्जेक्ट.

उदाहरण: एक से ज़्यादा वैल्यू वाले ऐसे विजेट के लिए जिसकी name participants है, वैल्यू ऐरे को ऐक्सेस करने के लिए, e.commonEventObject.formInputs.participants.stringInputs.value का इस्तेमाल करें.

  • DecoratedText.SwitchControl विजेट: StringInputs ऑब्जेक्ट. जब selected, true होता है, तब stringInputs.value में स्विच का value फ़ील्ड शामिल होता है. अगर value की जानकारी नहीं दी गई है, तो "" शामिल होता है. अगर एक से ज़्यादा स्विच एक ही name शेयर करते हैं, तो चुने गए हर स्विच का value सूची में शामिल होता है. selected के false होने पर, स्विच के value को stringInputs.value से हटा दिया जाता है.

  • तारीख और समय चुनने वाला टूल (DateTimePickerType.DATE_AND_TIME): यह एक DateTimeInput object है.

उदाहरण: myDTPicker के name वाले पिकर के लिए, e.commonEventObject.formInputs.myDTPicker.dateTimeInput का इस्तेमाल करके DateTimeInput ऑब्जेक्ट को ऐक्सेस करें.

  • सिर्फ़ तारीख चुनने वाला पिकर (DateTimePickerType.DATE_ONLY): यह एक DateInput object है.

उदाहरण: myDatePicker के name वाले पिकर के लिए, e.commonEventObject.formInputs.myDatePicker.dateInput का इस्तेमाल करके DateInput ऑब्जेक्ट को ऐक्सेस करें.

  • सिर्फ़ समय चुनने वाला पिकर (DateTimePickerType.TIME_ONLY): TimeInput object.

उदाहरण: myTimePicker के name वाले पिकर के लिए, e.commonEventObject.formInputs.myTimePicker.timeInput का इस्तेमाल करके TimeInput ऑब्जेक्ट को ऐक्सेस करें.

एक ऑब्जेक्ट, जिसमें "key": value जोड़ों की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

parameters

map (key: string, value: string)

actionParameters या Action.setParameters() का इस्तेमाल करके, किसी कार्रवाई के लिए दिए गए अतिरिक्त पैरामीटर.

डेवलपर के लिए झलक: Google Chat की सुविधाओं को बेहतर बनाने वाले ऐड-ऑन के लिए, कई आइटम चुनने की सुविधा देने वाले मेन्यू में, उपयोगकर्ताओं के टाइप किए गए टेक्स्ट के आधार पर आइटम के सुझाव देने के लिए, "autocomplete_widget_query" कुंजी (event.commonEventObject.parameters["autocomplete_widget_query"]) की वैल्यू का इस्तेमाल करें. इस वैल्यू का इस्तेमाल करके, डेटाबेस से क्वेरी की जा सकती है. साथ ही, उपयोगकर्ताओं को टाइप करते समय, चुने जा सकने वाले आइटम के सुझाव दिए जा सकते हैं. ज़्यादा जानकारी के लिए, Google Chat के उपयोगकर्ताओं की जानकारी इकट्ठा और प्रोसेस करना लेख पढ़ें.

एक ऑब्जेक्ट, जिसमें "key": value जोड़ों की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

कॉल किए जाने वाले फ़ंक्शन का नाम.

यह फ़ील्ड, Google Chat की सुविधाओं को बढ़ाने वाले Google Workspace ऐड-ऑन के लिए नहीं भरा जाता. इसके बजाय, आइडेंटिफ़ायर जैसे फ़ंक्शन डेटा को पाने के लिए, Chat की सुविधाओं को बढ़ाने वाले ऐड-ऑन को parameters फ़ील्ड का इस्तेमाल करना चाहिए. Chat ऐप्लिकेशन के लिए इंटरैक्टिव इंटरफ़ेस बनाना लेख पढ़ें.

HostApp

Google Workspace ऐड-ऑन या Google Chat ऐप्लिकेशन के लिए Google Workspace ऐप्लिकेशन.

ऐड-ऑन के लिए, Workspace का वह ऐप्लिकेशन जिससे Google Workspace ऐड-ऑन लॉन्च होता है. चैट ऐप्लिकेशन के लिए, होस्ट ऐप्लिकेशन हमेशा CHAT होता है.

Enums
UNSPECIFIED_HOST_APP Google, होस्ट ऐप्लिकेशन की पहचान नहीं कर सकता.
GMAIL ऐड-ऑन, Gmail से लॉन्च होता है.
CALENDAR ऐड-ऑन, Google Calendar से लॉन्च होता है.
DRIVE ऐड-ऑन, Google Drive से लॉन्च होता है.
DEMO इस्तेमाल नहीं किया गया.
DOCS ऐड-ऑन, Google Docs से लॉन्च होता है.
MEET ऐड-ऑन, Google Meet से लॉन्च होता है.
SHEETS ऐड-ऑन, Google Sheets से लॉन्च होता है.
SLIDES ऐड-ऑन, Google Slides से लॉन्च होता है.
DRAWINGS ऐड-ऑन, Google Drawings से लॉन्च होता है.
CHAT Google Chat ऐप्लिकेशन.

प्लैटफ़ॉर्म

इससे पता चलता है कि यह कॉल किस प्लैटफ़ॉर्म से किया गया है.

Enums
UNKNOWN_PLATFORM
WEB
IOS
ANDROID

TimeZone

टाइमज़ोन आईडी और कोऑर्डिनेटेड यूनिवर्सल टाइम (यूटीसी) से ऑफ़सेट. यह सिर्फ़ CARD_CLICKED और SUBMIT_DIALOG टाइप के इवेंट के लिए काम करता है.

JSON के काेड में दिखाना
{
  "id": string,
  "offset": integer
}
फ़ील्ड
id

string

IANA TZ टाइम ज़ोन डेटाबेस कोड, जैसे कि "America/Toronto".

offset

integer

कोऑर्डिनेटेड यूनिवर्सल टाइम (यूटीसी) से उपयोगकर्ता के टाइमज़ोन ऑफ़सेट, मिलीसेकंड में.

इनपुट

डेटा के टाइप, जिन्हें उपयोगकर्ता कार्ड या डायलॉग में इनपुट कर सकते हैं. इनपुट टाइप, इस बात पर निर्भर करता है कि विजेट किस तरह की वैल्यू स्वीकार करता है.

JSON के काेड में दिखाना
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
फ़ील्ड
यहां उन फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
stringInputs

object (StringInputs)

स्ट्रिंग की एक सूची, जो किसी विजेट में उपयोगकर्ता के डाले गए इनपुट की वैल्यू दिखाती है.

अगर विजेट सिर्फ़ एक वैल्यू स्वीकार करता है, जैसे कि TextInput विजेट, तो सूची में एक स्ट्रिंग ऑब्जेक्ट होता है. अगर विजेट में एक से ज़्यादा वैल्यू डाली जा सकती हैं, जैसे कि चेकबॉक्स का SelectionInput विजेट, तो सूची में हर उस वैल्यू के लिए एक स्ट्रिंग ऑब्जेक्ट होता है जिसे उपयोगकर्ता डालता है या चुनता है.

dateTimeInput

object (DateTimeInput)

DateTimePicker विजेट से तारीख और समय की इनपुट वैल्यू. यह विजेट, तारीख और समय, दोनों को स्वीकार करता है.

dateInput

object (DateInput)

DateTimePicker विजेट से तारीख की इनपुट वैल्यू, जो सिर्फ़ तारीख की वैल्यू स्वीकार करता है.

timeInput

object (TimeInput)

DateTimePicker विजेट से समय की इनपुट वैल्यू. यह विजेट सिर्फ़ समय की वैल्यू स्वीकार करता है.

एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

StringInputs

सामान्य विजेट के लिए इनपुट पैरामीटर. एक वैल्यू वाले विजेट के लिए, यह एक वैल्यू वाली सूची होती है. एक से ज़्यादा वैल्यू वाले विजेट, जैसे कि चेकबॉक्स के लिए सभी वैल्यू दिखती हैं.

JSON के काेड में दिखाना
{
  "value": [
    string
  ]
}
फ़ील्ड
value[]

string

उपयोगकर्ता की ओर से डाली गई स्ट्रिंग की सूची.

DateTimeInput

तारीख और समय की इनपुट वैल्यू.

JSON के काेड में दिखाना
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
फ़ील्ड
msSinceEpoch

string (int64 format)

इपॉक टाइम के बाद का समय, मिलीसेकंड में.

hasDate

boolean

datetime इनपुट में कैलेंडर की तारीख शामिल है या नहीं.

hasTime

boolean

क्या datetime इनपुट में टाइमस्टैंप शामिल है.

DateInput

तारीख की इनपुट वैल्यू.

JSON के काेड में दिखाना
{
  "msSinceEpoch": string
}
फ़ील्ड
msSinceEpoch

string (int64 format)

इपॉक टाइम के बाद का समय, मिलीसेकंड में.

TimeInput

समय की इनपुट वैल्यू.

JSON के काेड में दिखाना
{
  "hours": integer,
  "minutes": integer
}
फ़ील्ड
hours

integer

24 घंटे वाली घड़ी के हिसाब से घंटा.

minutes

integer

घंटे के बाद के मिनट की संख्या. मान्य वैल्यू 0 से 59 तक हैं.

AuthorizationEventObject

ऐड-ऑन के अनुरोध के लिए, अनुमति की जानकारी को शामिल करता है

JSON के काेड में दिखाना
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
फ़ील्ड
userOAuthToken

string

असली उपयोगकर्ता का OAuth ऐक्सेस टोकन, जिसे अनुरोध किए गए दायरों के साथ अनुमति दी गई है. (OAuth सहमति को अनबंडल करने के बाद, इसे असली उपयोगकर्ता की अनुमति वाले स्कोप के साथ अनुमति दी जाएगी)

userIdToken

string

असली उपयोगकर्ता का आईडी टोकन, अगर सही आईडी स्कोप का अनुरोध किया गया है

systemIdToken

string

इस डिप्लॉयमेंट के लिए, G Suite ऐड-ऑन सेवा खाते का आईडी टोकन

authorizedScopes[]

string

उपयोगकर्ता की अनुमति वाले OAuth स्कोप की सूची.

CalendarEventObject

Calendar इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के कैलेंडर और कैलेंडर इवेंट की जानकारी होती है. यह सिर्फ़ तब किसी इवेंट ऑब्जेक्ट में मौजूद होता है, जब होस्ट ऐप्लिकेशन Google Calendar हो.

इस टेबल में, किसी इवेंट ऑब्जेक्ट के calendar फ़ील्ड में मौजूद फ़ील्ड की सूची दी गई है. उपयोगकर्ता से जनरेट किए गए डेटा के तौर पर मार्क किए गए फ़ील्ड, इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होते हैं, जब डेटा कैलेंडर इवेंट में मौजूद हो और ऐड-ऑन अपने addOns.calendar.currentEventAccess मेनिफ़ेस्ट फ़ील्ड को READ या READ_WRITE पर सेट करता हो.

JSON के काेड में दिखाना
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
फ़ील्ड
id

string

इवेंट का आईडी.

recurringEventId

string

बार-बार होने वाले इवेंट का आईडी.

calendarId

string

कैलेंडर आईडी.

organizer

object (Organizer)

इवेंट के आयोजक को दिखाने वाला ऑब्जेक्ट.

attendees[]

object (Attendee)

यूज़र जनरेटेड डेटा. कैलेंडर इवेंट में शामिल होने वाले लोगों की सूची.

conferenceData

object (ConferenceData)

यूज़र जनरेटेड डेटा. इस इवेंट से जुड़े किसी भी कॉन्फ़्रेंस डेटा को दिखाने वाला ऑब्जेक्ट, जैसे कि Google Meet कॉन्फ़्रेंस की जानकारी.

capabilities

object (Capabilities)

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

आयोजक

JSON के काेड में दिखाना
{
  "email": string
}
फ़ील्ड
email

string

इवेंट के आयोजक का ईमेल पता.

मेहमान

Attendee ऑब्जेक्ट में, Google Calendar इवेंट में शामिल होने वाले अलग-अलग मेहमानों की जानकारी होती है. यह जानकारी इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होती है, जब डेटा Calendar इवेंट में मौजूद हो और ऐड-ऑन अपने addOns.calendar.currentEventAccess मेनिफ़ेस्ट फ़ील्ड को READ या READ_WRITE पर सेट करता हो.

JSON के काेड में दिखाना
{
  "email": string,
  "displayName": string,
  "organizer": boolean,
  "self": boolean,
  "resource": boolean,
  "optional": boolean,
  "responseStatus": string,
  "comment": string,
  "additionalGuests": integer
}
फ़ील्ड
email

string

मेहमान का ईमेल पता.

displayName

string

मेहमान का डिसप्ले नेम.

organizer

boolean

अगर मेहमान इस इवेंट का आयोजक है, तो true.

self

boolean

अगर यह मेहमान उस कैलेंडर को दिखाता है जिसमें यह इवेंट दिखता है, तो true; अगर ऐसा नहीं है, तो false.

resource

boolean

अगर मेहमान किसी संसाधन को दिखाता है, जैसे कि कमरा या उपकरण, तो true; नहीं तो false.

optional

boolean

अगर इस मेहमान की मौजूदगी को 'ज़रूरी नहीं' के तौर पर मार्क किया गया है, तो true; अगर ऐसा नहीं है, तो false.

responseStatus

string

मेहमान के जवाब की स्थिति. इनमें ये वैल्यू शामिल हो सकती हैं:

  • accepted: मेहमान ने इवेंट का न्योता स्वीकार कर लिया है.
  • declined: मेहमान ने इवेंट का न्योता अस्वीकार कर दिया है.
  • needsAction: मेहमान ने इवेंट के न्योते का जवाब नहीं दिया है.
  • tentative: मेहमान ने इवेंट का न्योता स्वीकार कर लिया है. हालांकि, वह पक्के तौर पर नहीं बता सकता कि वह इवेंट में शामिल होगा या नहीं.
comment

string

मेहमान का जवाब, अगर कोई हो.

additionalGuests

integer

मेहमान ने जितने अतिरिक्त मेहमानों को लाने की जानकारी दी है उनकी संख्या. डिफ़ॉल्ट तौर पर, यह वैल्यू शून्य पर सेट होती है.

ConferenceData

कॉन्फ़्रेंस डेटा ऑब्जेक्ट में, Google Calendar इवेंट से जुड़ी कॉन्फ़्रेंस की जानकारी होती है. ये Google के कॉन्फ़्रेंसिंग के विकल्प हो सकते हैं, जैसे कि Google Meet या तीसरे पक्ष के कॉन्फ़्रेंसिंग के विकल्प. यह जानकारी इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होती है, जब डेटा Calendar इवेंट में मौजूद हो और ऐड-ऑन अपने addOns.calendar.currentEventAccess मेनिफ़ेस्ट फ़ील्ड को READ या READ_WRITE पर सेट करता हो.

JSON के काेड में दिखाना
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
फ़ील्ड
conferenceId

string

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

conferenceSolution

object (ConferenceSolution)

कॉन्फ़्रेंसिंग के विकल्प को दिखाने वाला ऑब्जेक्ट, जैसे कि Hangouts या Google Meet.

entryPoints[]

object (EntryPoint)

कॉन्फ़्रेंस में शामिल होने के लिए एंट्री पॉइंट की सूची, जैसे कि यूआरएल या फ़ोन नंबर.

notes

string

कॉन्फ़्रेंस के बारे में अतिरिक्त जानकारी, जैसे कि डोमेन एडमिन के निर्देश या कानूनी नोटिस, जो उपयोगकर्ता को दिखाए जाएंगे. इसमें एचटीएमएल शामिल हो सकता है. इसमें ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.

parameters

object (Parameters)

एक ऐसा ऑब्जेक्ट जिसमें तय किए गए पैरामीटर डेटा का मैप शामिल होता है. इसका इस्तेमाल ऐड-ऑन करता है.

ConferenceSolution

JSON के काेड में दिखाना
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
फ़ील्ड
iconUri

string

इस कॉन्फ़्रेंसिंग के विकल्प को दिखाने वाले आइकॉन का यूआरआई, जो उपयोगकर्ता को दिखता है.

key

object (Key)

वह कुंजी जो इस इवेंट के लिए, कॉन्फ़्रेंसिंग के विकल्प की खास तौर पर पहचान करती है.

name

string

कॉन्फ़्रेंसिंग के इस विकल्प का नाम, जो उपयोगकर्ता को दिखता है. यह नाम, स्थानीय भाषा के हिसाब से नहीं होता.

कुंजी

JSON के काेड में दिखाना
{
  "type": string
}
फ़ील्ड
type

string

कॉन्फ़्रेंसिंग के विकल्प का टाइप. इनमें ये वैल्यू शामिल हो सकती हैं:

  • उपभोक्ताओं के लिए Hangouts (http://hangouts.google.com) के लिए eventHangout.
  • eventNamedHangout: Google Workspace के उपयोगकर्ताओं के लिए, Hangouts के क्लासिक वर्शन (http://hangouts.google.com) के लिए.
  • Google Meet (http://meet.google.com) के लिए hangoutsMeet.
  • तीसरे पक्ष के कॉन्फ़्रेंसिंग के विकल्पों के लिए addOn.

EntryPoint

एंट्री पॉइंट ऑब्जेक्ट में, किसी कॉन्फ़्रेंस को ऐक्सेस करने के लिए तय किए गए तरीकों की जानकारी होती है. जैसे, फ़ोन या वीडियो से. यह जानकारी इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होती है, जब डेटा Calendar इवेंट में मौजूद हो और ऐड-ऑन अपने addOns.calendar.currentEventAccess मेनिफ़ेस्ट फ़ील्ड को READ या READ_WRITE पर सेट करता हो.

JSON के काेड में दिखाना
{
  "accessCode": string,
  "entryPointType": string,
  "label": string,
  "meetingCode": string,
  "passcode": string,
  "password": string,
  "pin": string,
  "uri": string,
  "regionCode": string,
  "entryPointFeatures": [
    string
  ]
}
फ़ील्ड
accessCode

string

कॉन्फ़्रेंस को ऐक्सेस करने के लिए इस्तेमाल किया गया ऐक्सेस कोड. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनियां, आम तौर पर कॉन्फ़्रेंस का ऐक्सेस देने के लिए, {accessCode, meetingCode, passcode, password, pin} के सबसेट का ही इस्तेमाल करती हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनी के इस्तेमाल किए जाने वाले फ़ील्ड से मैच करें और सिर्फ़ उन्हें दिखाएं.

entryPointType

string

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

  • more: कॉन्फ़्रेंस में शामिल होने के लिए अन्य निर्देश, जैसे कि वैकल्पिक फ़ोन नंबर. किसी कॉन्फ़्रेंस में सिर्फ़ एक more एंट्री पॉइंट हो सकता है. अगर यह मौजूद है, तो कम से कम एक अन्य तरह का एंट्री पॉइंट भी ज़रूरी है.
  • phone: फ़ोन नंबर से कॉन्फ़्रेंस में शामिल हों. किसी कॉन्फ़्रेंस में शून्य या उससे ज़्यादा फ़ोन एंट्री पॉइंट हो सकते हैं. Google Calendar, फ़ोन से मीटिंग में शामिल होने के लिए सिर्फ़ पहले दो एंट्री पॉइंट दिखाता है. ऐसा, वर्णमाला के क्रम में फ़ॉर्मैट और क्रम से लगाने के बाद होता है.
  • sip: एसआईपी का इस्तेमाल करके कॉन्फ़्रेंस में शामिल हों. किसी कॉन्फ़्रेंस में ज़्यादा से ज़्यादा एक sip एंट्री पॉइंट हो सकता है.
  • video: एचटीटीपी का इस्तेमाल करके कॉन्फ़्रेंस में शामिल हों. किसी कॉन्फ़्रेंस में ज़्यादा से ज़्यादा एक वीडियो एंट्री पॉइंट हो सकता है.
label

string

एंट्री पॉइंट यूआरआई के लिए, उपयोगकर्ता को दिखने वाला लेबल (स्थानीय भाषा में नहीं).

meetingCode

string

कॉन्फ़्रेंस में शामिल होने के लिए इस्तेमाल किया गया मीटिंग कोड. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनियां, आम तौर पर कॉन्फ़्रेंस का ऐक्सेस देने के लिए, {accessCode, meetingCode, passcode, password, pin} के सबसेट का ही इस्तेमाल करती हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनी के इस्तेमाल किए जाने वाले फ़ील्ड से मैच करें और सिर्फ़ उन्हें दिखाएं.

passcode

string

कॉन्फ़्रेंस को ऐक्सेस करने के लिए इस्तेमाल किया जाने वाला पासवर्ड. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनियां, आम तौर पर कॉन्फ़्रेंस का ऐक्सेस देने के लिए, {accessCode, meetingCode, passcode, password, pin} के सबसेट का ही इस्तेमाल करती हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनी के इस्तेमाल किए जाने वाले फ़ील्ड से मैच करें और सिर्फ़ उन्हें दिखाएं.

password

string

कॉन्फ़्रेंस को ऐक्सेस करने के लिए इस्तेमाल किया जाने वाला पासवर्ड. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनियां, आम तौर पर कॉन्फ़्रेंस का ऐक्सेस देने के लिए, {accessCode, meetingCode, passcode, password, pin} के सबसेट का ही इस्तेमाल करती हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनी के इस्तेमाल किए जाने वाले फ़ील्ड से मैच करें और सिर्फ़ उन्हें दिखाएं.

pin

string

कॉन्फ़्रेंस को ऐक्सेस करने के लिए इस्तेमाल किया गया पिन. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनियां, आम तौर पर कॉन्फ़्रेंस का ऐक्सेस देने के लिए, {accessCode, meetingCode, passcode, password, pin} के सबसेट का ही इस्तेमाल करती हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनी के इस्तेमाल किए जाने वाले फ़ील्ड से मैच करें और सिर्फ़ उन्हें दिखाएं.

uri

string

एंट्री पॉइंट का यूआरआई. ज़्यादा से ज़्यादा 1,300 वर्ण इस्तेमाल किए जा सकते हैं. फ़ॉर्मैटिंग, एंट्री पॉइंट के टाइप पर निर्भर करती है:

  • more: http: या https: स्कीमा ज़रूरी है.
  • phone: इसके लिए, tel: स्कीमा ज़रूरी है. यूआरआई में पूरा डायल सीक्वेंस शामिल होना चाहिए. उदाहरण के लिए, "tel:+12345678900,,,12345678;1234".
  • sip: इसके लिए, sip: या sips: स्कीमा ज़रूरी है. उदाहरण के लिए, "sip:12345678@myprovider.com".
  • video: इसके लिए, http: या https: स्कीमा ज़रूरी है.
regionCode

string

फ़ोन नंबर का रीजन कोड. अगर यूआरआई में देश का कोड शामिल नहीं है, तो उपयोगकर्ताओं को इसकी ज़रूरत होती है. वैल्यू, देश/इलाके के कोड की सार्वजनिक CLDR सूची के आधार पर तय की जाती हैं.

entryPointFeatures[]

string

एंट्री पॉइंट की सुविधाएं. फ़िलहाल, ये सुविधाएं सिर्फ़ फ़ोन एंट्री पॉइंट पर लागू होती हैं:

  • toll: एंट्री पॉइंट, टोल फ़ोन कॉल है.
  • toll_free: एंट्री पॉइंट, टोल-फ़्री फ़ोन कॉल है.

पैरामीटर

JSON के काेड में दिखाना
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
फ़ील्ड
addOnParameters

object (AddOnParameters)

पैरामीटर स्ट्रिंग की कुंजियों और वैल्यू का मैप. इन कुंजियों और वैल्यू को ऐड-ऑन डेवलपर तय करता है, ताकि ऐड-ऑन के इस्तेमाल के लिए किसी खास कॉन्फ़्रेंस में जानकारी अटैच की जा सके.

AddOnParameters

JSON के काेड में दिखाना
{
  "parameters": {
    string: string,
    ...
  }
}
फ़ील्ड
parameters

map (key: string, value: string)

एक ऑब्जेक्ट, जिसमें "key": value जोड़ों की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

क्षमताएं

JSON के काेड में दिखाना
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
फ़ील्ड
canSeeAttendees

boolean

उपयोगकर्ता से जनरेट किया गया डेटा. अगर ऐड-ऑन, इवेंट में शामिल होने वाले लोगों की सूची को पढ़ सकता है, तो true; अगर नहीं, तो false.

canAddAttendees

boolean

यूज़र जनरेटेड डेटा. अगर ऐड-ऑन, इवेंट में शामिल होने वाले लोगों की सूची में नए मेहमानों को जोड़ सकता है, तो true; अगर नहीं, तो false.

canSeeConferenceData

boolean

उपयोगकर्ता का जनरेट किया गया डेटा. अगर ऐड-ऑन, इवेंट कॉन्फ़्रेंस का डेटा पढ़ सकता है, तो सही; अगर नहीं, तो गलत.

canSetConferenceData

boolean

उपयोगकर्ता से मिला डेटा. अगर ऐड-ऑन, इवेंट की कॉन्फ़्रेंस के डेटा को अपडेट कर सकता है, तो true; अगर नहीं, तो false.

canAddAttachments

boolean

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

DriveEventObject

Drive का इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के Google Drive और उसके कॉन्टेंट की जानकारी होती है. यह इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होता है, जब होस्ट ऐप्लिकेशन Google Drive हो.

JSON के काेड में दिखाना
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
फ़ील्ड
selectedItems[]

object (DriveItemMetadata)

Drive में चुने गए आइटम (फ़ाइलें या फ़ोल्डर) की सूची.

activeCursorItem

object (DriveItemMetadata)

Drive का वह आइटम जो फ़िलहाल चालू है.

DriveItemMetadata

Drive आइटम ऑब्जेक्ट में, Drive के खास आइटम की जानकारी होती है. जैसे, फ़ाइलें या फ़ोल्डर.

JSON के काेड में दिखाना
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
फ़ील्ड
id

string

चुने गए आइटम का आईडी.

iconUrl

string

चुने गए आइटम को दिखाने वाले आइकॉन का यूआरएल.

mimeType

string

चुने गए आइटम का एमआईएमई टाइप.

title

string

चुने गए आइटम का टाइटल.

addonHasFileScopePermission

boolean

अगर सही है, तो इसका मतलब है कि ऐड-ऑन ने इस आइटम के लिए, https://www.googleapis.com/auth/drive.file स्कोप की अनुमति का अनुरोध किया है और उसे यह अनुमति मिल गई है. अगर ऐसा नहीं है, तो इस फ़ील्ड की वैल्यू false होगी.

अगर ऐड-ऑन, https://www.googleapis.com/auth/drive या https://www.googleapis.com/auth/drive.readonly जैसे ज़्यादा अनुमति वाले स्कोप का इस्तेमाल करता है, तो यह फ़ील्ड काम का नहीं है. ऐड-ऑन डिज़ाइन करते समय, हमेशा कम से कम अनुमति वाले स्कोप का इस्तेमाल करें, ताकि उपयोगकर्ता की जानकारी सुरक्षित रहे.

GmailEventObject

Gmail इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के Gmail मैसेज की जानकारी होती है. यह इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होता है, जब होस्ट ऐप्लिकेशन Gmail हो.

JSON के काेड में दिखाना
{
  "messageId": string,
  "threadId": string,
  "accessToken": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ]
}
फ़ील्ड
messageId

string

फ़िलहाल खुले हुए Gmail मैसेज का आईडी.

threadId

string

फ़िलहाल खुले हुए Gmail थ्रेड का आईडी.

accessToken

string

Gmail के लिए खास ऐक्सेस टोकन. इस टोकन का इस्तेमाल GmailApp.setCurrentMessageAccessToken(accessToken) तरीके के साथ किया जा सकता है. इससे आपके ऐड-ऑन को उपयोगकर्ता के मौजूदा Gmail मैसेज का कुछ समय के लिए ऐक्सेस मिल जाता है. इसके अलावा, आपके ऐड-ऑन को नए ड्राफ़्ट लिखने की अनुमति भी मिल जाती है.

toRecipients[]

string

डिफ़ॉल्ट रूप से बंद है. "पाने वाला:" फ़ील्ड में मौजूद उन ईमेल पतों की सूची जिन्हें ऐड-ऑन की मदद से बनाए जा रहे ड्राफ़्ट में शामिल किया गया है. इस फ़ील्ड को चालू करने के लिए, आपको अपने मेनिफ़ेस्ट में addOns.gmail.composeTrigger.draftAccess फ़ील्ड को METADATA पर सेट करना होगा.

ccRecipients[]

string

डिफ़ॉल्ट रूप से बंद है. "कॉपी:" फ़ील्ड में मौजूद उन ईमेल पतों की सूची जिन्हें ऐड-ऑन की मदद से बनाए जा रहे ड्राफ़्ट में शामिल किया गया है. इस फ़ील्ड को चालू करने के लिए, आपको अपने मेनिफ़ेस्ट में addOns.gmail.composeTrigger.draftAccess फ़ील्ड को METADATA पर सेट करना होगा.

bccRecipients[]

string

डिफ़ॉल्ट रूप से बंद है. "गुप्त कॉपी:" फ़ील्ड में मौजूद उन ईमेल पतों की सूची जिन्हें फ़िलहाल, ऐड-ऑन की मदद से लिखे जा रहे ड्राफ़्ट में शामिल किया गया है. इस फ़ील्ड को चालू करने के लिए, आपको अपने मेनिफ़ेस्ट में addOns.gmail.composeTrigger.draftAccess फ़ील्ड को METADATA पर सेट करना होगा.

SheetsEventObject

Sheets का इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के दस्तावेज़ और उसके कॉन्टेंट की जानकारी होती है. यह इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होता है, जब ऐड-ऑन, Google Sheets को एक्सटेंड करता है.

JSON के काेड में दिखाना
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
फ़ील्ड
id

string

यह सिर्फ़ तब मौजूद होता है, जब उपयोगकर्ता ने https://www.googleapis.com/auth/drive.file स्कोप को अनुमति दी हो. Sheets के यूज़र इंटरफ़ेस (यूआई) में खुली हुई स्प्रेडशीट का आईडी.

title

string

यह सिर्फ़ तब मौजूद होता है, जब उपयोगकर्ता ने https://www.googleapis.com/auth/drive.file स्कोप को अनुमति दी हो. Sheets के यूज़र इंटरफ़ेस (यूआई) में खुली हुई स्प्रेडशीट का टाइटल.

addonHasFileScopePermission

boolean

अगर true है, तो इसका मतलब है कि Sheets के यूज़र इंटरफ़ेस (यूआई) में खुली स्प्रेडशीट के लिए, ऐड-ऑन ने https://www.googleapis.com/auth/drive.file स्कोप को ऐक्सेस करने का अनुरोध किया है और उसे अनुमति मिल गई है. अगर ऐसा नहीं है, तो इस फ़ील्ड की वैल्यू false होगी.

matchedUrl

object (MatchedUrl)

यह जानकारी सिर्फ़ तब दिखती है, जब ये शर्तें पूरी हों:

  • https://www.googleapis.com/auth/workspace.linkpreview को उपयोगकर्ता ने अनुमति दी है.
  • यूआरएल, LinkPreviewTriggers ट्रिगर में बताए गए होस्ट पैटर्न से मैच करता हो.

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

जब कोई उपयोगकर्ता लिंक https://www.example.com/12345 की झलक देखता है, तो उसके लिए पेलोड का उदाहरण:

"sheets" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

MatchedUrl

लिंक की झलक दिखाने के अनुरोधों के साथ दिखाया गया इवेंट ऑब्जेक्ट.

JSON के काेड में दिखाना
{
  "url": string
}
फ़ील्ड
url

string

मैच किया गया यूआरएल.

SlidesEventObject

Slides का इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के दस्तावेज़ और उसके कॉन्टेंट की जानकारी होती है. यह सिर्फ़ तब किसी इवेंट ऑब्जेक्ट में मौजूद होता है, जब ऐड-ऑन Google Slides को एक्सटेंड करता है.

JSON के काेड में दिखाना
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
फ़ील्ड
id

string

यह सिर्फ़ तब मौजूद होता है, जब उपयोगकर्ता ने https://www.googleapis.com/auth/drive.file स्कोप को अनुमति दी हो. Slides के यूज़र इंटरफ़ेस (यूआई) में खुले प्रज़ेंटेशन का आईडी.

title

string

यह सिर्फ़ तब मौजूद होता है, जब उपयोगकर्ता ने https://www.googleapis.com/auth/drive.file स्कोप को अनुमति दी हो. Slides के यूज़र इंटरफ़ेस (यूआई) में खुले प्रज़ेंटेशन का टाइटल.

addonHasFileScopePermission

boolean

अगर true है, तो इसका मतलब है कि ऐड-ऑन ने Slides के यूज़र इंटरफ़ेस (यूआई) में खुले प्रज़ेंटेशन के लिए, https://www.googleapis.com/auth/drive.file स्कोप की अनुमति का अनुरोध किया है और उसे यह अनुमति मिल गई है. अगर ऐसा नहीं है, तो इस फ़ील्ड की वैल्यू false होगी.

matchedUrl

object (MatchedUrl)

यह जानकारी सिर्फ़ तब दिखती है, जब ये शर्तें पूरी हों:

  • https://www.googleapis.com/auth/workspace.linkpreview को उपयोगकर्ता ने अनुमति दी है.
  • यूआरएल, LinkPreviewTriggers ट्रिगर में बताए गए होस्ट पैटर्न से मैच करता हो.

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

जब कोई उपयोगकर्ता लिंक https://www.example.com/12345 की झलक देखता है, तब के लिए पेलोड का उदाहरण:

"slides" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

DocsEventObject

Docs का इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के दस्तावेज़ और उसके कॉन्टेंट की जानकारी होती है. यह इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होता है, जब ऐड-ऑन, Google Docs को एक्सटेंड करता है.

JSON के काेड में दिखाना
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
फ़ील्ड
id

string

यह सिर्फ़ तब मौजूद होता है, जब उपयोगकर्ता ने https://www.googleapis.com/auth/drive.file स्कोप को अनुमति दी हो. Docs के यूज़र इंटरफ़ेस (यूआई) में खुले दस्तावेज़ का आईडी.

title

string

यह सिर्फ़ तब मौजूद होता है, जब उपयोगकर्ता ने https://www.googleapis.com/auth/drive.file स्कोप को अनुमति दी हो. Docs के यूज़र इंटरफ़ेस (यूआई) में खुले दस्तावेज़ का टाइटल.

addonHasFileScopePermission

boolean

अगर true है, तो इसका मतलब है कि ऐड-ऑन ने Docs के यूज़र इंटरफ़ेस (यूआई) में खुले दस्तावेज़ के लिए, https://www.googleapis.com/auth/drive.file स्कोप की अनुमति का अनुरोध किया है और उसे यह अनुमति मिल गई है. अगर ऐसा नहीं है, तो यह फ़ील्ड false है.

matchedUrl

object (MatchedUrl)

यह जानकारी सिर्फ़ तब दिखती है, जब ये शर्तें पूरी हों:

  • https://www.googleapis.com/auth/workspace.linkpreview को उपयोगकर्ता ने अनुमति दी है.
  • यूआरएल, LinkPreviewTriggers ट्रिगर में बताए गए होस्ट पैटर्न से मैच करता हो.

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

जब कोई उपयोगकर्ता लिंक https://www.example.com/12345 की झलक देखता है, तो उसके लिए पेलोड का उदाहरण:

"docs" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

ChatEventObject

Google Chat ऐप्लिकेशन के इवेंट ऑब्जेक्ट का पेलोड, जिसे Google सर्वर से ऐड-ऑन को भेजा जाता है. पेलोड का इस्तेमाल, इवेंट के टाइप की पहचान करने के लिए किया जा सकता है.

JSON के काेड में दिखाना
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
फ़ील्ड
type

enum (EventType)

इवेंट का टाइप. इसे सिर्फ़ Chat ऐप्लिकेशन में, ऐप्लिकेशन के होम पेज पर होने वाले इवेंट के लिए पॉप्युलेट किया जाता है. ये ऐप्लिकेशन, ऐड-ऑन नहीं होते.

user

object (User)

चैट ऐप्लिकेशन से इंटरैक्ट करने वाला उपयोगकर्ता.

space

object (Space)

वह स्पेस जिसमें इवेंट हुआ. यह सिर्फ़ Chat ऐप्लिकेशन में ऐप्लिकेशन के होम पेज पर होने वाले इवेंट के लिए पॉप्युलेट होता है. ये ऐप्लिकेशन, ऐड-ऑन नहीं होते.

eventTime

string (Timestamp format)

इवेंट ऑब्जेक्ट के होने का समय बताने वाला टाइमस्टैंप.

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

इवेंट ऑब्जेक्ट का पेलोड. पेलोड, इवेंट ऑब्जेक्ट के टाइप पर निर्भर करते हैं. यहां उन फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
messagePayload

object (MessagePayload)

कोई उपयोगकर्ता, Chat ऐप्लिकेशन को मैसेज भेजता है या किसी स्पेस में Chat ऐप्लिकेशन को @mention करता है. ऐप्लिकेशन के कमांड को ट्रिगर करने की सुविधा (जैसे, स्लैश कमांड और क्विक कमांड), appCommandPayload में उपलब्ध कराई जाती है.

addedToSpacePayload

object (AddedToSpacePayload)

कोई उपयोगकर्ता, Chat ऐप्लिकेशन को किसी Chat स्पेस में जोड़ता है या कोई Google Workspace एडमिन, अपने संगठन के उपयोगकर्ताओं के लिए, Chat ऐप्लिकेशन को डायरेक्ट मैसेज वाले स्पेस में इंस्टॉल करता है.

removedFromSpacePayload

object (RemovedFromSpacePayload)

कोई उपयोगकर्ता, Chat ऐप्लिकेशन को किसी स्पेस से हटाता है.

buttonClickedPayload

object (ButtonClickedPayload)

यह पेलोड डेटा को तब दिखाता है, जब कोई उपयोगकर्ता किसी कार्ड या डायलॉग के इंटरैक्टिव एलिमेंट से इंटरैक्ट करता है. इससे Action कॉलबैक ट्रिगर होता है. नाम के बावजूद, यह पेलोड सभी कार्ड और डायलॉग Action कॉलबैक के लिए भरा जाता है. इसमें सिर्फ़ बटन क्लिक ही नहीं, बल्कि onChangeAction ट्रिगर, onClick कार्रवाइयां, CardAction क्लिक, और डायलॉग सबमिट करना या रद्द करना (SUBMIT_DIALOG और CANCEL_DIALOG) भी शामिल है.

अगर कोई उपयोगकर्ता किसी डायलॉग बॉक्स से इंटरैक्ट करता है, तो ButtonClickedPayload के isDialogEvent फ़ील्ड को true पर सेट किया जाता है. साथ ही, इसमें DialogEventType शामिल होता है.

पूरे पेलोड में commonEventObject.formInputs और commonEventObject.parameters भी शामिल हैं.

widgetUpdatedPayload

object (WidgetUpdatedPayload)

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

पूरे पेलोड में CommonEventObject.parameters['autocomplete_widget_query'] भी शामिल होता है.

appCommandPayload

object (AppCommandPayload)

कोई उपयोगकर्ता ऐप्लिकेशन कमांड को ट्रिगर करता है.

systemCommandPayload

object (SystemCommandPayload)

कोई उपयोगकर्ता सिस्टम कमांड को ट्रिगर करता है.

एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

EventType

इवेंट का टाइप. इसे सिर्फ़ Chat ऐप्लिकेशन में, ऐप्लिकेशन के होम पेज पर होने वाले इवेंट के लिए पॉप्युलेट किया जाता है. ये ऐप्लिकेशन, ऐड-ऑन नहीं होते.

Enums
EVENT_TYPE_UNSPECIFIED enum के लिए डिफ़ॉल्ट वैल्यू. इस्तेमाल न करें.
APP_HOME कोई उपयोगकर्ता, ऐप्लिकेशन होम का इस्तेमाल करने वाले किसी चैट ऐप्लिकेशन से डायरेक्ट मैसेज खोलता है. इस तरह के इवेंट के लिए, सिर्फ़ type, user, और space फ़ील्ड शामिल किए जाते हैं. ज़्यादा जानकारी के लिए, Google Chat ऐप्लिकेशन के लिए होम पेज बनाना लेख पढ़ें.
SUBMIT_FORM कोई उपयोगकर्ता, ऐप्लिकेशन के होम कार्ड में जानकारी सबमिट करता है. इस तरह के इवेंट के लिए, सिर्फ़ type, user, और space फ़ील्ड शामिल किए जाते हैं. ज़्यादा जानकारी के लिए, [Google Chat ऐप्लिकेशन के लिए होम पेज बनाना]((https://developers.google.com/workspace/chat/send-app-home-card-message) लेख पढ़ें.

MessagePayload

कोई उपयोगकर्ता, Chat ऐप्लिकेशन को मैसेज भेजता है या किसी स्पेस में Chat ऐप्लिकेशन को @mention करता है. ऐप्लिकेशन के कमांड को ट्रिगर करने के लिए, AppCommandPayload का इस्तेमाल किया जाता है. जैसे, स्लैश कमांड और क्विक कमांड.

JSON के काेड में दिखाना
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
फ़ील्ड
space

object (Space)

ज़रूरी है. वह Chat स्पेस जिसमें इवेंट ऑब्जेक्ट मौजूद है.

message

object (Message)

इवेंट ऑब्जेक्ट को ट्रिगर करने वाला मैसेज.

configCompleteRedirectUri

string

ज़रूरी नहीं. वह यूआरएल जिस पर चैट ऐप्लिकेशन को उपयोगकर्ता को रीडायरेक्ट करना चाहिए. ऐसा तब किया जाना चाहिए, जब उपयोगकर्ता Google Chat के बाहर अनुमति देने या कॉन्फ़िगरेशन की प्रोसेस पूरी कर ले. ज़्यादा जानकारी के लिए, किसी चैट ऐप्लिकेशन को अन्य सेवाओं और टूल से कनेक्ट करना लेख पढ़ें.

AddedToSpacePayload

कोई उपयोगकर्ता, Chat ऐप्लिकेशन को किसी स्पेस में जोड़ता है या ऐप्लिकेशन और उपयोगकर्ता के बीच कोई डीएम बनाया जाता है.

JSON के काेड में दिखाना
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
फ़ील्ड
space

object (Space)

ज़रूरी है. वह Chat स्पेस जिसमें इवेंट ऑब्जेक्ट मौजूद है.

interactionAdd

boolean

क्या ऐप्लिकेशन को स्पेस में उपयोगकर्ता के इंटरैक्शन से जोड़ा गया था. उदाहरण के लिए, Chat ऐप्लिकेशन को @ मेंशन करके या स्लैश कमांड का इस्तेमाल करके. अगर इसे 'सही है' पर सेट किया जाता है, तो इंटरैक्शन से जुड़ा एक अलग इवेंट ऑब्जेक्ट होगा. इसे Chat ऐप्लिकेशन को भेजा जाएगा.

configCompleteRedirectUri

string

ज़रूरी नहीं. वह यूआरएल जिस पर चैट ऐप्लिकेशन को उपयोगकर्ता को रीडायरेक्ट करना चाहिए. ऐसा तब किया जाना चाहिए, जब उपयोगकर्ता Google Chat के बाहर अनुमति देने या कॉन्फ़िगरेशन की प्रोसेस पूरी कर ले. ज़्यादा जानकारी के लिए, किसी चैट ऐप्लिकेशन को अन्य सेवाओं और टूल से कनेक्ट करना लेख पढ़ें.

RemovedFromSpacePayload

कोई उपयोगकर्ता, Chat ऐप्लिकेशन को किसी स्पेस से हटाता है.

JSON के काेड में दिखाना
{
  "space": {
    object (Space)
  }
}
फ़ील्ड
space

object (Space)

ज़रूरी है. वह Chat स्पेस जिसमें इवेंट ऑब्जेक्ट मौजूद है.

ButtonClickedPayload

जब कोई उपयोगकर्ता, Chat ऐड-ऑन के किसी कार्ड या डायलॉग के इंटरैक्टिव एलिमेंट से इंटरैक्ट करता है, तो Action कॉलबैक ट्रिगर होता है. नाम के बावजूद, यह पेलोड सभी कार्ड और डायलॉग Action कॉलबैक के लिए पॉप्युलेट किया जाता है. इसमें बटन क्लिक, onChangeAction ट्रिगर, onClick कार्रवाइयां, CardAction क्लिक, और डायलॉग सबमिट करना या रद्द करना (SUBMIT_DIALOG और CANCEL_DIALOG) शामिल है.

अगर कोई उपयोगकर्ता किसी डायलॉग बॉक्स से इंटरैक्ट करता है, तो ButtonClickedPayload के isDialogEvent फ़ील्ड को true पर सेट किया जाता है. साथ ही, इसमें DialogEventType शामिल होता है. यह पेलोड, Chat के उन ऐप्लिकेशन के लिए SUBMIT_FORM और CARD_CLICKED इवेंट टाइप से मैप होता है जो ऐड-ऑन नहीं हैं.

पूरे पेलोड में CommonEventObject.form_inputs और CommonEventObject.parameters भी शामिल हैं.

JSON के काेड में दिखाना
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
फ़ील्ड
space

object (Space)

ज़रूरी है. वह Chat स्पेस जिसमें इवेंट ऑब्जेक्ट मौजूद है.

message

object (Message)

इवेंट ऑब्जेक्ट को ट्रिगर करने वाला मैसेज.

isDialogEvent

boolean

ButtonClicked और Message इवेंट ऑब्जेक्ट के लिए, यह जानकारी कि उपयोगकर्ता किसी डायलॉग से इंटरैक्ट कर रहा है या इंटरैक्ट करने वाला है.

dialogEventType

enum (DialogEventType)

डायलॉग इवेंट ऑब्जेक्ट का टाइप.

DialogEventType

ButtonClicked या AppCommand इवेंट पेलोड वाले इवेंट ऑब्जेक्ट के लिए, डायलॉग के साथ होने वाले इंटरैक्शन के टाइप.

Google Chat ऐप्लिकेशन के इवेंट ऑब्जेक्ट के बारे में ज़्यादा जानने के लिए, अपने Google Chat ऐप्लिकेशन के साथ होने वाले इंटरैक्शन की जानकारी पाना और उनका जवाब देना लेख पढ़ें.

Enums
DIALOG_EVENT_TYPE_UNSPECIFIED डिफ़ॉल्ट मान. नहीं बताया गया है
REQUEST_DIALOG कोई उपयोगकर्ता डायलॉग बॉक्स खोलता है.
SUBMIT_DIALOG कोई उपयोगकर्ता, डायलॉग बॉक्स के किसी इंटरैक्टिव एलिमेंट पर क्लिक करता है. उदाहरण के लिए, कोई उपयोगकर्ता किसी डायलॉग बॉक्स में जानकारी भरता है और जानकारी सबमिट करने के लिए किसी बटन पर क्लिक करता है.
CANCEL_DIALOG कोई उपयोगकर्ता जानकारी सबमिट किए बिना डायलॉग बॉक्स बंद कर देता है या डायलॉग बॉक्स रद्द कर दिया जाता है.

WidgetUpdatedPayload

जब कोई उपयोगकर्ता, इन-स्ट्रीम कार्ड या डायलॉग में मौजूद किसी विजेट को अपडेट करता है.

पूरे पेलोड में CommonEventObject.parameters['autocomplete_widget_query'] भी शामिल होता है.

JSON के काेड में दिखाना
{
  "space": {
    object (Space)
  }
}
फ़ील्ड
space

object (Space)

ज़रूरी है. वह Chat स्पेस जिसमें इवेंट ऑब्जेक्ट मौजूद है.

AppCommandPayload

कोई उपयोगकर्ता ऐप्लिकेशन कमांड को ट्रिगर करता है.

JSON के काेड में दिखाना
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
फ़ील्ड
appCommandMetadata

object (AppCommandMetadata)

ऐप्लिकेशन के कमांड के लिए पॉप्युलेट किया गया है. इनमें स्लैश कमांड और क्विक कमांड शामिल हैं.

space

object (Space)

ज़रूरी नहीं. वह Chat स्पेस जिसमें इवेंट ऑब्जेक्ट मौजूद है.

thread

object (Thread)

ज़रूरी नहीं. वह थ्रेड जिसमें इवेंट ऑब्जेक्ट होता है, अगर लागू हो. अगर इवेंट ऑब्जेक्ट किसी खास मैसेज या थ्रेड से जुड़ा है, तो यह फ़ील्ड अपने-आप भर जाता है.

message

object (Message)

ज़रूरी नहीं. इवेंट ऑब्जेक्ट को ट्रिगर करने वाला मैसेज, अगर लागू हो. यह फ़ील्ड सिर्फ़ स्लैश कमांड के लिए भरा जाता है.

configCompleteRedirectUri

string

ज़रूरी नहीं. वह यूआरएल जिस पर उपयोगकर्ता को Google Chat के बाहर, अनुमति देने या कॉन्फ़िगरेशन की प्रोसेस पूरी करने के बाद रीडायरेक्ट किया जाना चाहिए. ज़्यादा जानकारी के लिए, किसी चैट ऐप्लिकेशन को अन्य सेवाओं और टूल से कनेक्ट करना लेख पढ़ें.

isDialogEvent

boolean

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

dialogEventType

enum (DialogEventType)

ज़रूरी नहीं. डायलॉग इवेंट ऑब्जेक्ट का टाइप. यह फ़ील्ड सिर्फ़ तब लागू होता है, जब isDialogEvent की वैल्यू true हो.

AppCommandMetadata

Chat ऐप्लिकेशन के कमांड के बारे में मेटाडेटा.

JSON के काेड में दिखाना
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
फ़ील्ड
appCommandId

integer

Chat API के कॉन्फ़िगरेशन में दिए गए कमांड का आईडी.

appCommandType

enum (AppCommandType)

Chat ऐप्लिकेशन के कमांड का टाइप.

AppCommandType

Chat ऐप्लिकेशन के कमांड का टाइप. ज़्यादा जानकारी के लिए, Chat ऐप्लिकेशन के लिए इस्तेमाल की जा सकने वाली कमांड के टाइप देखें.

Enums
APP_COMMAND_TYPE_UNSPECIFIED डिफ़ॉल्ट मान. नहीं बताया गया है
SLASH_COMMAND एक स्लैश कमांड. उपयोगकर्ता, Chat मैसेज में कमांड भेजता है.
QUICK_COMMAND कोई क्विक कमांड. उपयोगकर्ता, मैसेज का जवाब देने वाले बॉक्स में Chat मेन्यू से कमांड चुनता है.
MESSAGE_ACTION मैसेज पर की जाने वाली कार्रवाई. उपयोगकर्ता, Chat में मैसेज के कॉन्टेक्स्ट मेन्यू से कमांड चुनता है.

SystemCommandPayload

कोई उपयोगकर्ता सिस्टम कमांड को ट्रिगर करता है.

JSON के काेड में दिखाना
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
फ़ील्ड
systemCommandMetadata

object (SystemCommandMetadata)

सिस्टम के उस निर्देश का मेटाडेटा जिसे ट्रिगर किया गया था.

space

string

ज़रूरी नहीं. वह Chat स्पेस जिसमें इवेंट ऑब्जेक्ट मौजूद है.

thread

object (Thread)

ज़रूरी नहीं. वह थ्रेड जिसमें इवेंट ऑब्जेक्ट होता है, अगर लागू हो. अगर इवेंट ऑब्जेक्ट किसी खास मैसेज या थ्रेड से जुड़ा है, तो यह फ़ील्ड अपने-आप भर जाता है.

SystemCommandMetadata

उपयोगकर्ता की ओर से ट्रिगर किए गए सिस्टम कमांड का मेटाडेटा.

JSON के काेड में दिखाना
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "cancelStream": {
    object (CancelStream)
  }
  // End of mutually exclusive fields.
}
फ़ील्ड
सिस्टम कमांड को शुरू किया गया. यहां ऐसे फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
cancelStream

object (CancelStream)

किसी ऐक्टिव स्ट्रीम मैसेज को रद्द करने का निर्देश.

एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

CancelStream

किसी ऐक्टिव स्ट्रीम मैसेज को रद्द करने का निर्देश.

JSON के काेड में दिखाना
{
  "streamMessage": string
}
फ़ील्ड
streamMessage

string

ज़रूरी है. उस स्ट्रीम मैसेज के संसाधन का नाम जिस पर रद्द करने का निर्देश दिया गया था.

फ़ॉर्मैट: spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange वर्कफ़्लो ऐड-ऑन को पास किया गया इवेंट ऑब्जेक्ट.

JSON के काेड में दिखाना
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
फ़ील्ड
executionMetadata

object (ExecutionMetadata)

वर्कफ़्लो के एक्ज़ीक्यूशन का मेटाडेटा.

triggerEventSource

enum (TriggerEventSource)

ट्रिगर करने वाले इवेंट का सोर्स.

वर्कफ़्लो इवेंट के पेलोड का टाइप. यहां ऐसे फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
actionInvocation

object (ActionInvocation)

वर्कफ़्लो की कोई कार्रवाई शुरू करना.

triggerCreation

object (TriggerCreation)

वर्कफ़्लो ट्रिगर बनाना.

triggerDeletion

object (TriggerDeletion)

वर्कफ़्लो ट्रिगर को मिटाना.

resourceRetrieval

object (ResourceRetrieval)

किसी संसाधन को वापस पाना (वैरिएबल इन्फ़्लेशन के लिए इस्तेमाल किया जाता है).

elementConfiguration

object (ElementConfiguration)

वर्कफ़्लो एलिमेंट का कॉन्फ़िगरेशन.

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

किसी संसाधन के साथ काम करने वाले फ़ील्ड की परिभाषाएं वापस पाना.

elementUiAutocomplete

object (ElementUiAutocomplete)

फ़िलहाल रेंडर किए गए कार्ड के लिए, अपने-आप पूरा होने वाले सुझाव.

एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

ActionInvocation

वर्कफ़्लो की कोई कार्रवाई शुरू करना.

JSON के काेड में दिखाना
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
फ़ील्ड
inputs

map (key: string, value: object (VariableData))

इनपुट वैरिएबल के नाम के हिसाब से, इनपुट वैरिएबल का मैप.

एक ऑब्जेक्ट, जिसमें "key": value जोड़ों की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

triggerId

string

एसिंक्रोनस ऐक्शन रिस्पॉन्स के लिए इस्तेमाल किया जाने वाला ट्रिगर आईडी.

flowLevelContext

object (FlowLevelContext)

ज़रूरी नहीं. पिछले चरणों से मिला फ़्लो-लेवल कॉन्टेक्स्ट.

VariableData

यह वैरिएबल डेटा को दिखाता है. इसमें अलग-अलग टाइप की कई वैल्यू हो सकती हैं.

JSON के काेड में दिखाना
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
फ़ील्ड
booleanValues[]

boolean

बूलियन वैल्यू.

integerValues[]

string (int64 format)

पूर्णांक वैल्यू.

floatValues[]

number

फ़्लोट वैल्यू.

stringValues[]

string

स्ट्रिंग वैल्यू.

timestampValues[]

string (Timestamp format)

टाइमस्टैंप की वैल्यू.

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

resourceReferences[]

object (ResourceReference)

संसाधन के रेफ़रंस (आईडी).

emailAddressValues[]

string

ईमेल पते की वैल्यू.

googleUserValues[]

string

Google उपयोगकर्ता की वैल्यू, users/{user} फ़ॉर्मैट में होनी चाहिए.

textFormatValues[]

object (WorkflowTextFormat)

Workflow में टेक्स्ट फ़ॉर्मैट की वैल्यू.

ResourceReference

ऐप्लिकेशन के हिसाब से रिसॉर्स की आईडी वैल्यू.

JSON के काेड में दिखाना
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
फ़ील्ड
resourceType

object (ResourceType)

यह आईडी किस तरह के संसाधन को दिखाता है.

resourceId

string

संसाधन का आईडी.

ResourceType

कस्टम रिसॉर्स टाइप का नाम.

JSON के काेड में दिखाना
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
फ़ील्ड
workflowBundleId

string

उस वर्कफ़्लो बंडल का आईडी जिसके पास इस संसाधन टाइप का मालिकाना हक है. यह ज़रूरी नहीं है. अगर इसे खाली छोड़ा जाता है, तो इसे वही बंडल माना जाता है जिसमें इसका इस्तेमाल किया जा रहा है.

workflowResourceDefinitionId

string

संसाधन का यूनीक आइडेंटिफ़ायर. यह ज़रूरी है कि एक ही बंडल में मौजूद हर फ़ाइल का नाम अलग हो.

WorkflowTextFormat

टेक्स्ट का एक ब्लॉक, जिसमें फ़ॉर्मैटिंग के कई विकल्प शामिल हैं. जैसे, स्टाइल, हाइपरलिंक, और इंटरैक्टिव एलिमेंट.

JSON के काेड में दिखाना
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
फ़ील्ड
textFormatElements[]

object (TextFormatElement)

टेक्स्ट फ़ॉर्मैट के एलिमेंट का कलेक्शन.

TextFormatElement

WorkflowTextFormat मैसेज में मौजूद एक एलिमेंट. यह कोई चिप, स्टाइल किया गया टेक्स्ट, हाइपरलिंक या सूची कंटेनर हो सकता है.

JSON के काेड में दिखाना
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "chip": {
    object (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
फ़ील्ड
यह एलिमेंट, टेक्स्ट फ़ॉर्मैट के कई संभावित एलिमेंट में से किसी एक को दिखाता है. यहां ऐसे फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
text

string

टेक्स्ट फ़ॉर्मैट में मौजूद टेक्स्ट.

chip

object (Chip)

टेक्स्ट फ़ॉर्मैट में क्लिक की जा सकने वाली चिप.

styledText

object (StyledText)

टेक्स्ट फ़ॉर्मैट में स्टाइल किया गया टेक्स्ट.

listContainer

object (ListContainer)

टेक्स्ट फ़ॉर्मैट में सूची का कंटेनर.

एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

चिप

टेक्स्ट फ़ॉर्मैट में क्लिक की जा सकने वाली चिप.

JSON के काेड में दिखाना
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
फ़ील्ड
icon

object (Icon)

चिप में दिखने वाला आइकॉन.

label

string

चिप में दिखने वाला टेक्स्ट.

url

string

चिप पर क्लिक करने पर, इस यूआरएल पर रीडायरेक्ट किया जाता है.

आइकॉन

चिप में मौजूद एक आइकॉन.

JSON के काेड में दिखाना
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "iconUrl": string,
  "materialIconName": string
  // End of mutually exclusive fields.
}
फ़ील्ड
चिप में दिखने वाला आइकॉन. यहां ऐसे फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
iconUrl

string

एचटीटीपीएस यूआरएल पर होस्ट किया गया पसंद का आइकॉन दिखाएं.

उदाहरण के लिए:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

.png और .jpg फ़ाइल टाइप इस्तेमाल किए जा सकते हैं.

materialIconName

string

Google Material आइकॉन में तय किया गया आइकॉन का नाम, जैसे कि check_box. अमान्य नामों को हटा दिया जाता है और उनकी जगह खाली स्ट्रिंग डाल दी जाती है. इस वजह से, आइकॉन रेंडर नहीं हो पाता.

एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

StyledText

बोल्ड, इटैलिक, और रंग जैसी स्टाइल वाला टेक्स्ट एलिमेंट.

JSON के काेड में दिखाना
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
फ़ील्ड
text

string

टेक्स्ट का मुख्य कॉन्टेंट.

styles[]

enum (Style)

टेक्स्ट पर लागू की गई स्टाइल का कलेक्शन.

fontWeight

enum (FontWeight)

टेक्स्ट के फ़ॉन्ट की मोटाई.

color

object (Color)

टेक्स्ट का रंग.

wrapStyle

enum (WrapStyle)

टेक्स्ट को रैप करने का स्टाइल.

शैली

टेक्स्ट की अलग-अलग स्टाइल के लिए Enum. जैसे, इटैलिक, अंडरलाइन वगैरह.

Enums
STYLE_UNSPECIFIED कोई स्टाइल लागू नहीं की गई. इस्तेमाल न करें.
ITALIC इटैलिक स्टाइल.
UNDERLINE अंडरलाइन स्टाइल.
STRIKETHROUGH स्ट्राइकथ्रू स्टाइल.
LINE_BREAK लाइन ब्रेक.
UPPERCASE अपरकेस स्टाइल.
CODE कोड.
CODE_BLOCK कोड ब्लॉक.

FontWeight

अलग-अलग फ़ॉन्ट वेट के लिए Enum.

Enums
FONT_WEIGHT_UNSPECIFIED सामान्य मोटाई के साथ स्टैंडर्ड वेट. इस्तेमाल न करें.
LIGHT यह हल्का और पतला है.
MEDIUM लाइट और बोल्ड के बीच का वेट.
BOLD ज़्यादा मोटाई के साथ ज़्यादा वज़न.

WrapStyle

रैप करने की अलग-अलग स्टाइल के लिए Enum.

Enums
WRAP_STYLE_UNSPECIFIED रैप स्टाइल की जानकारी नहीं दी गई है.
NO_WRAP कोई रैप स्टाइल नहीं.

ListContainer

सूची के आइटम के लिए कंटेनर, जहां सूची के हर आइटम में कई TextFormatElement हो सकते हैं.

JSON के काेड में दिखाना
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
फ़ील्ड
listNestLevel

string (int64 format)

सूची का नेस्ट लेवल. यह टॉप लेवल के लिए 0 से शुरू होता है और हर नेस्ट की गई सूची के लिए 1 से बढ़ता है.

listType

enum (ListType)

सूची का टाइप.

listItems[]

object (ListItem)

सूची में मौजूद आइटम का कलेक्शन.

ListType

अलग-अलग तरह की सूचियों के लिए Enum.

Enums
LIST_TYPE_UNSPECIFIED सूची का टाइप नहीं बताया गया. इस्तेमाल न करें.
ORDERED क्रम वाली सूची.
UNORDERED बिना क्रम वाली सूची.
BLOCKQUOTE यह ब्लॉककोट की सूची को दिखाता है.

ListItem

सूची में मौजूद कोई आइटम.

JSON के काेड में दिखाना
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
फ़ील्ड
textFormatElements[]

object (TextFormatElement)

टेक्स्ट फ़ॉर्मैट के एलिमेंट का कलेक्शन.

FlowLevelContext

फ़्लो-लेवल कॉन्टेक्स्ट, जिसमें पिछले चरणों के आउटपुट शामिल होते हैं.

JSON के काेड में दिखाना
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
फ़ील्ड
stepContexts[]

object (StepContext)

ज़रूरी नहीं. पिछले चरणों की सूची. क्रम मायने रखता है. इसलिए, पक्का करें कि इस सूची में लागू करने का क्रम सही हो.

StepContext

फ़्लो-लेवल कॉन्टेक्स्ट के लिए, स्टेप कॉन्टेक्स्ट मेटाडेटा और आउटपुट.

JSON के काेड में दिखाना
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
फ़ील्ड
stepId

string

ज़रूरी नहीं. वर्कफ़्लो ग्राफ़ में मौजूद चरण का यूनीक आईडी.

outputs

map (key: string, value: object (VariableData))

ज़रूरी नहीं. इस चरण से जनरेट हुए आउटपुट वैरिएबल का मैप. इसे वैरिएबल के नाम के हिसाब से कुंजीबद्ध किया गया है.

एक ऑब्जेक्ट, जिसमें "key": value जोड़ों की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

TriggerCreation

वर्कफ़्लो ट्रिगर बनाना.

JSON के काेड में दिखाना
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
फ़ील्ड
triggerId

string

ट्रिगर बनाते समय दिया गया यूनीक आइडेंटिफ़ायर.

triggerType

enum (TriggerType)

ट्रिगर का टाइप.

inputs

map (key: string, value: object (VariableData))

इनपुट वैरिएबल के नाम के हिसाब से, इनपुट वैरिएबल का मैप.

एक ऑब्जेक्ट, जिसमें "key": value जोड़ों की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

notifyUri

string

ट्रिगर के फ़ायर होने पर, इस एंडपॉइंट को कॉल किया जाएगा.

TriggerType

ट्रिगर का टाइप.

Enums
TRIGGER_TYPE_UNDEFINED डिफ़ॉल्ट मान. इस्तेमाल न करें.
REPEATING इनपुट की शर्तें पूरी होने पर, ट्रिगर हर बार फ़ायर होगा.

TriggerDeletion

वर्कफ़्लो ट्रिगर को मिटाना.

JSON के काेड में दिखाना
{
  "triggerId": string
}
फ़ील्ड
triggerId

string

ट्रिगर बनाते समय दिया गया यूनीक आइडेंटिफ़ायर.

ResourceRetrieval

किसी संसाधन को वापस पाना.

JSON के काेड में दिखाना
{
  "resourceReference": {
    object (ResourceReference)
  }
}
फ़ील्ड
resourceReference

object (ResourceReference)

फ़ेच किए जाने वाले संसाधन का टाइप और आईडी.

ElementConfiguration

वर्कफ़्लो एलिमेंट को कॉन्फ़िगर करते समय, इनवोकेशन.

JSON के काेड में दिखाना
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
फ़ील्ड
inputs

map (key: string, value: object (VariableData))

इनपुट वैरिएबल के नाम के हिसाब से, इनपुट वैरिएबल का मैप. यह मैप खाली हो सकता है. इसका इस्तेमाल, वर्कफ़्लो होम में किसी एक वर्कफ़्लो एलिमेंट (ट्रिगर या कार्रवाई) को कॉन्फ़िगर करते समय किया जाता है.

एक ऑब्जेक्ट, जिसमें "key": value जोड़ों की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayDestination

enum (DisplayDestination)

एलिमेंट कॉन्फ़िगरेशन कार्ड का डेस्टिनेशन. एलिमेंट इस फ़ील्ड का इस्तेमाल करके, डेस्टिनेशन के आधार पर अलग-अलग कॉन्फ़िगरेशन कार्ड लेआउट दिखा सकते हैं.

nodeId

string

रेंडर किए जा रहे प्रिमिटिव कॉन्फ़िगरेशन का नोड आईडी.

workflowId

string

रेंडर किए जा रहे प्रिमिटिव कॉन्फ़िगरेशन का वर्कफ़्लो आईडी.

availableVariables[]

object (VariableReference)

नोड की पोज़िशन के हिसाब से क्रम में लगाए गए उपलब्ध वैरिएबल.

DisplayDestination

इससे पता चलता है कि वापस आने वाले एलिमेंट का कॉन्फ़िगरेशन कार्ड कहां दिखेगा.

Enums
DISPLAY_DESTINATION_UNSPECIFIED डिफ़ॉल्ट मान. इस्तेमाल न करें.
DISPLAY_DESTINATION_SIDE_PANEL कॉन्फ़िगरेशन कार्ड, साइड पैनल में दिखेगा.
DISPLAY_DESTINATION_FULL_SCREEN कॉन्फ़िगरेशन कार्ड, फ़ुल स्क्रीन ऐप्लिकेशन में दिखाया जाएगा.

VariableReference

वर्कफ़्लो में मौजूद किसी वैरिएबल का रेफ़रंस.

JSON के काेड में दिखाना
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
फ़ील्ड
parentElementId

string

वैरिएबल बनाने वाले एलिमेंट का प्रिमिटिव आईडी. ज़रूरत पड़ने पर, हम इसे WorkflowElement या ज़्यादा जानकारी वाले मेटाडेटा प्रोटो में बड़ा कर सकते हैं.

nodeId

string

नोड का रेफ़रंस आईडी

path

string

वैरिएबल सिलेक्टर पाथ सिग्नेचर

dataType

object (DataType)

वैरिएबल का डेटा टाइप

iconUrl

string

इस वैरिएबल को बनाने वाले प्रिमिटिव के आइकॉन का यूआरएल.

stepNumber

integer

इस वैरिएबल को जनरेट करने वाले प्रिमिटिव का स्टेप नंबर.

descriptionText

string

वैरिएबल का ब्यौरा.

displayText

string

वैरिएबल चिप का डिसप्ले टेक्स्ट.

DataType

वैरिएबल का टाइप.

JSON के काेड में दिखाना
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
फ़ील्ड
valueMetadata

object (ValueMetadata)

किसी वैरिएबल की संभावित वैल्यू के बारे में मेटाडेटा.

डेटा का टाइप. यहां ऐसे फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
basicType

enum (BasicType)

बुनियादी डेटा टाइप.

resourceType

object (ResourceType)

ऐप्लिकेशन के संसाधन आईडी का टाइप.

एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

BasicType

बुनियादी सामान्य डेटा टाइप.

Enums
BASIC_TYPE_UNSPECIFIED डिफ़ॉल्ट मान. इस्तेमाल न करें.
STRING वर्णों की एक स्ट्रिंग.
INTEGER कोई इंटीजर नंबर.
FLOAT कोई फ़्लोटिंग पॉइंट नंबर.
TIMESTAMP आईएसओ 8601 फ़ॉर्मैट में टाइमस्टैंप.
BOOLEAN ऐसी वैल्यू जो सही या गलत हो सकती है.
EMAIL_ADDRESS ईमेल पता, जो ईमेल पते के फ़ॉर्मैट में एक स्ट्रिंग है.
GOOGLE_USER Google की सेवाओं का उपयोगकर्ता, users/{user} फ़ॉर्मैट में.
FILE फ़ाइल का रेफ़रंस.
FORMATTED_TEXT बेहतरीन फ़ॉर्मैटिंग वाला टेक्स्ट.

ValueMetadata

किसी वैरिएबल की संभावित वैल्यू के बारे में जानकारी.

JSON के काेड में दिखाना
{
  "enumValues": [
    string
  ],
  "dynamicTypes": [
    enum (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
फ़ील्ड
enumValues[]

string

ज़रूरी नहीं. इससे किसी स्ट्रिंग के लिए अनुमति वाली वैल्यू तय की जाती हैं. इसे सिर्फ़ तब सेट किया जा सकता है, जब DataType की वैल्यू STRING हो.

dynamicTypes[]

enum (BasicType)

ज़रूरी नहीं. इससे उन टाइप के बारे में पता चलता है जिन्हें किसी वैरिएबल के लिए डाइनैमिक तौर पर कास्ट किया जा सकता है. इसे सिर्फ़ तब सेट किया जा सकता है, जब DataType एक स्ट्रिंग हो और वैरिएबल एक आउटपुट हो.

semanticDescriptors[]

object (SemanticDescriptor)

ज़रूरी नहीं. इससे किसी वैरिएबल के सिमैंटिक मतलब को समझने में मदद मिलती है.

dynamicSchema

object (DynamicSchema)

ज़रूरी नहीं. इस वैरिएबल के स्कीमा को डाइनैमिक तौर पर रिज़ॉल्व करने के लिए कॉन्फ़िगरेशन.

defaultValue

string

ज़रूरी नहीं. इस वैरिएबल की डिफ़ॉल्ट वैल्यू बताने वाली स्ट्रिंग. उदाहरण के लिए, बूलियन के लिए, defaultValue को true या false पर सेट किया जा सकता है.

SemanticDescriptor

किसी वैरिएबल के सिमैंटिक मतलब के बारे में मेटाडेटा.

JSON के काेड में दिखाना
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
फ़ील्ड
resourceAttribute

string

इससे पता चलता है कि वैरिएबल, किसी संसाधन के खास एट्रिब्यूट से जुड़ा है. यह खास तौर पर उन वैरिएबल के लिए मददगार है जो किसी संसाधन के आइडेंटिफ़ायर (आईडी, यूआरएल, कुंजी वगैरह) को दिखाते हैं.

हमारा सुझाव है कि आप इस फ़ॉर्मैट का इस्तेमाल करें: - "{brand}/{appName}/{resource}:{attribute}" {brand} ज़रूरी नहीं है. अगर यह {appName} के जैसा ही है, तो इसे शामिल न करें.

उदाहरण: - "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id" वगैरह.

क्लाइंट इस जानकारी का इस्तेमाल करके, उपयोगकर्ता को यह बताएगा कि कौनसे आउटपुट वैरिएबल किसी इनपुट के साथ काम करते हैं.

disallowedResourceAttributes[]

string

ज़रूरी नहीं. यह सिर्फ़ इनपुट के लिए लागू होता है. आउटपुट के लिए इसे अनदेखा कर दिया जाता है. इस सिमैंटिक डिस्क्रिप्टर से जुड़े ऐसे एट्रिब्यूट जिनकी अनुमति नहीं है. क्लाइंट, ऐसे आउटपुट के लिए वैरिएबल चुनने से साफ़ तौर पर रोकेगा जो अनुमति न दिए गए इन संसाधन एट्रिब्यूट से जुड़े हैं.

DynamicSchema

रनटाइम के दौरान, इस वैरिएबल के स्कीमा को डाइनैमिक तौर पर रिज़ॉल्व करने के लिए कॉन्फ़िगरेशन.

JSON के काेड में दिखाना
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
फ़ील्ड
requiredInputIds[]

string

सिबलिंग इनपुट वैरिएबल के आईडी, जिन्हें इस वैरिएबल के स्कीमा को डाइनैमिक तौर पर हल करने से पहले देना ज़रूरी है.

strictEnum

boolean

सही होने पर, वैरिएबल की वैल्यू, डाइनैमिक तौर पर रिज़ॉल्व की गई enum वैल्यू में से किसी एक से मैच होनी चाहिए. 'गलत है' पर सेट होने पर, डाइनैमिक तौर पर तय की गई वैल्यू को सामान्य सुझावों के तौर पर माना जाता है.

ResourceFieldsDefinitionRetrieval

यह किसी संसाधन के साथ काम करने वाले फ़ील्ड की जानकारी हासिल करता है.

JSON के काेड में दिखाना
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
फ़ील्ड
elementId

string

उस एलिमेंट का आईडी बताता है जिसका डाइनैमिक रिसॉर्स स्कीमा फ़ेच करना है.

inputs

map (key: string, value: object (VariableData))

इसमें उस नोड के फ़ील्ड इनपुट शामिल होते हैं जो वैरिएबल उपलब्ध कराता है. इनपुट वैरिएबल के नाम के हिसाब से, इनपुट वैरिएबल का मैप.

एक ऑब्जेक्ट, जिसमें "key": value जोड़ों की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ElementUiAutocomplete

फ़िलहाल रेंडर किए गए कार्ड के लिए, अपने-आप पूरा होने वाले सुझाव.

JSON के काेड में दिखाना
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
फ़ील्ड
query

string

अपने-आप पूरी होने वाली क्वेरी.

inputs

map (key: string, value: object (VariableData))

इनपुट वैरिएबल के नाम के हिसाब से, इनपुट वैरिएबल का मैप.

एक ऑब्जेक्ट, जिसमें "key": value जोड़ों की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

विजेट से जुड़ा वह फ़ंक्शन जिसे कॉल किया गया है.

resourceId

string

वह संसाधन आईडी जिसके लिए ऑटोकंप्लीट की सुविधा चालू होनी चाहिए. यह फ़ील्ड ज़रूरी नहीं है और हो सकता है कि इसे सेट न किया गया हो.

operationId

string

उस कार्रवाई का आईडी जिससे अपने-आप पूरा होने वाला संसाधन मिला. यह फ़ील्ड ज़रूरी नहीं है और हो सकता है कि इसे सेट न किया गया हो.

ExecutionMetadata

वर्कफ़्लो के एक्ज़ीक्यूशन का मेटाडेटा.

JSON के काेड में दिखाना
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
फ़ील्ड
versionId

integer

वर्कफ़्लो एलिमेंट का वह वर्शन जिसे शुरू किया जा रहा है.

timeZone

string

सेव किए जा रहे वर्कफ़्लो का टाइम ज़ोन. उदाहरण के लिए, "America/Los_Angeles".

stepNumber

integer

यह प्रिमिटिव को शुरू करने के चरण का नंबर दिखाता है.

TriggerEventSource

इस प्रोसेस को ट्रिगर करने वाले इवेंट का सोर्स.

Enums
TRIGGER_EVENT_SOURCE_UNSPECIFIED डिफ़ॉल्ट मान. इस्तेमाल न करें.
TRIGGER_EVENT_SOURCE_AUTOMATED इवेंट की वजह से, कोड अपने-आप ट्रिगर होता है.
TRIGGER_EVENT_SOURCE_TEST_RUN टेस्ट रन की मदद से, फ़्लो को ट्रिगर किया जाता है.