Events

Calendar API, इवेंट के संसाधनों के अलग-अलग वर्शन उपलब्ध कराता है. ज़्यादा जानकारी के लिए, इवेंट के बारे में जानकारी लेख पढ़ें.

इस संसाधन के लिए तरीकों की सूची देखने के लिए, इस पेज के आखिर में जाएं.

संसाधन के बारे में जानकारी

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "eventLabelId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer,
      "asyncOperation": string
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": string
  },
  "eventType": string
}
प्रॉपर्टी का नाम मान ब्यौरा नोट
anyoneCanAddSelf boolean यह तय करता है कि कोई भी व्यक्ति इवेंट में शामिल होने का न्योता खुद को भेज सकता है या नहीं (अब इस्तेमाल नहीं किया जाता). ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है. लिखा जा सकता है
attachments[] list इवेंट के लिए फ़ाइल अटैचमेंट.

अटैचमेंट में बदलाव करने के लिए, supportsAttachments अनुरोध पैरामीटर को true पर सेट किया जाना चाहिए.

हर इवेंट में ज़्यादा से ज़्यादा 25 अटैचमेंट हो सकते हैं,

attachments[].fileId string अटैच की गई फ़ाइल का आईडी. सिर्फ़ पढ़ने के लिए.

Google Drive की फ़ाइलों के लिए, यह Drive API में मौजूद Files संसाधन एंट्री का आईडी होता है.

attachments[].fileUrl string अटैचमेंट का यूआरएल लिंक.

Google Drive में मौजूद फ़ाइल अटैचमेंट जोड़ने के लिए, उसी फ़ॉर्मैट का इस्तेमाल करें जो Drive API में Files संसाधन की alternateLink प्रॉपर्टी में इस्तेमाल किया गया है.

अटैचमेंट जोड़ते समय यह फ़ील्ड भरना ज़रूरी है.

लिखा जा सकता है
attachments[].mimeType string अटैचमेंट का इंटरनेट मीडिया टाइप (MIME टाइप).
attachments[].title string अटैचमेंट का टाइटल.
attendeesOmitted boolean इससे पता चलता है कि इवेंट में शामिल होने वाले लोगों को इवेंट के ब्यौरे से हटाया गया है या नहीं. इवेंट वापस पाने के दौरान, ऐसा maxAttendee क्वेरी पैरामीटर की ओर से तय की गई पाबंदी की वजह से हो सकता है. किसी इवेंट को अपडेट करते समय, इसका इस्तेमाल सिर्फ़ हिस्सा लेने वाले व्यक्ति के जवाब को अपडेट करने के लिए किया जा सकता है. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है. लिखा जा सकता है
attendees[] list इवेंट में शामिल होने वाले लोग. कैलेंडर का इस्तेमाल करने वाले अन्य लोगों के साथ इवेंट शेड्यूल करने के बारे में ज़्यादा जानने के लिए, मेहमानों के साथ इवेंट गाइड देखें. सेवा खातों को, मीटिंग में शामिल होने वाले लोगों की सूची भरने के लिए पूरे डोमेन के लिए अनुमति देने की सुविधा का इस्तेमाल करना होगा. लिखा जा सकता है
attendees[].additionalGuests integer अतिरिक्त मेहमानों की संख्या. ज़रूरी नहीं. डिफ़ॉल्ट वैल्यू 0 होती है. लिखा जा सकता है
attendees[].asyncOperation string अगर यह मौजूद है, तो इससे इस मेहमान के लिए चल रहे एसिंक्रोनस ऑपरेशन की स्थिति का पता चलता है. जैसे, मेहमानों के बड़े ग्रुप के सदस्यों की सूची बनाना. सिर्फ़ पढ़ने के लिए. डिफ़ॉल्ट रूप से, यह मौजूद नहीं होता है.

ये वैल्यू इस्तेमाल की जा सकती हैं:

  • "inProgress" - एसिंक्रोनस ऑपरेशन चल रहा है.
  • (not present) - अन्य.

attendees[].comment string इसमें शामिल व्यक्ति की टिप्पणी. ज़रूरी नहीं. लिखा जा सकता है
attendees[].displayName string अगर उपलब्ध हो, तो शामिल होने वाले व्यक्ति का नाम. ज़रूरी नहीं. लिखा जा सकता है
attendees[].email string अगर उपलब्ध हो, तो मीटिंग में शामिल होने वाले व्यक्ति का ईमेल पता. किसी व्यक्ति को मेहमान के तौर पर जोड़ने के लिए, यह फ़ील्ड मौजूद होना चाहिए. यह RFC5322 के मुताबिक एक मान्य ईमेल पता होना चाहिए.

किसी व्यक्ति को मेहमान के तौर पर जोड़ते समय यह फ़ील्ड ज़रूरी होता है.

लिखा जा सकता है
attendees[].id string अगर उपलब्ध हो, तो मीटिंग में शामिल होने वाले व्यक्ति का प्रोफ़ाइल आईडी.
attendees[].optional boolean क्या यह वैकल्पिक तौर पर शामिल होने वाला व्यक्ति है. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है. लिखा जा सकता है
attendees[].organizer boolean यह जानकारी कि मेहमान, इवेंट का आयोजक है या नहीं. सिर्फ़ पढ़ने के लिए. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
attendees[].resource boolean क्या शामिल होने वाला व्यक्ति कोई संसाधन है. इस विकल्प को सिर्फ़ तब सेट किया जा सकता है, जब किसी मेहमान को पहली बार इवेंट में शामिल किया जाता है. इसके बाद किए गए बदलावों को अनदेखा कर दिया जाता है. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है. लिखा जा सकता है
attendees[].responseStatus string मीटिंग में शामिल होने वाले व्यक्ति के जवाब का स्टेटस. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "needsAction" - मेहमान ने न्योते का जवाब नहीं दिया है. हमारा सुझाव है कि नए इवेंट के लिए इस विकल्प का इस्तेमाल करें.
  • declined - मेहमान ने बुलावा अस्वीकार कर दिया है.
  • "tentative" - इसका मतलब है कि मेहमान ने न्योते को अभी के लिए स्वीकार किया है.
  • accepted - इसका मतलब है कि मेहमान ने न्योता स्वीकार कर लिया है.
लिखा जा सकता है
attendees[].self boolean यह एंट्री उस कैलेंडर को दिखाती है जिस पर इवेंट की यह कॉपी दिखती है. सिर्फ़ पढ़ने के लिए. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
birthdayProperties nested object जन्मदिन या खास इवेंट का डेटा. इस एट्रिब्यूट का इस्तेमाल तब किया जाता है, जब eventType एट्रिब्यूट की वैल्यू "birthday" हो. इम्यूटेबल. लिखा जा सकता है
birthdayProperties.contact string उस संपर्क के रिसॉर्स का नाम जिससे यह जन्मदिन का इवेंट लिंक है. इसका इस्तेमाल, People API से संपर्क जानकारी पाने के लिए किया जा सकता है. फ़ॉर्मैट: "people/c12345". सिर्फ़ पढ़ने के लिए.
birthdayProperties.customTypeName string इस इवेंट के लिए कस्टम टाइप का लेबल तय किया गया है. अगर birthdayProperties.type को "custom" पर सेट किया जाता है, तो यह अपने-आप भर जाता है. सिर्फ़ पढ़ने के लिए.
birthdayProperties.type string बर्थडे या खास इवेंट का टाइप. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "anniversary" - जन्मदिन के अलावा, कोई और सालगिरह. इसमें हमेशा contact होता है.
  • "birthday" - जन्मदिन का इवेंट. यह डिफ़ॉल्ट मान है.
  • "custom" - यह एक खास तारीख होती है. इसका लेबल customTypeName फ़ील्ड में दिया जाता है. इसमें हमेशा contact होता है.
  • "other" - यह एक खास तारीख है, जो अन्य कैटगरी में नहीं आती है. साथ ही, इसका कोई कस्टम लेबल नहीं है. इसमें हमेशा contact होता है.
  • "self" - कैलेंडर के मालिक का जन्मदिन. इसमें contact नहीं हो सकता.
Calendar API, सिर्फ़ "birthday" टाइप के इवेंट बनाने की सुविधा देता है. इवेंट बनाने के बाद, इसका टाइप नहीं बदला जा सकता.
लिखा जा सकता है
colorId string इवेंट का रंग. यह एक ऐसा आईडी है जो रंगों की परिभाषा के event सेक्शन में मौजूद किसी एंट्री को दिखाता है. इसके बारे में जानने के लिए, colors एंडपॉइंट देखें. ज़रूरी नहीं. लिखा जा सकता है
conferenceData nested object कॉन्फ़्रेंस से जुड़ी जानकारी, जैसे कि Google Meet कॉन्फ़्रेंस की जानकारी. कॉन्फ़्रेंस की नई जानकारी बनाने के लिए, createRequest फ़ील्ड का इस्तेमाल करें. बदलावों को सेव करने के लिए, इवेंट में बदलाव करने के सभी अनुरोधों के लिए, conferenceDataVersion अनुरोध पैरामीटर को 1 पर सेट करना न भूलें. लिखा जा सकता है
conferenceData.conferenceId string कॉन्फ़्रेंस का आईडी.

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

कॉन्फ़्रेंस के हर समाधान के टाइप के लिए, आईडी की वैल्यू अलग-अलग होती है:

  • eventHangout: आईडी सेट नहीं है. (इस कॉन्फ़्रेंस टाइप का इस्तेमाल नहीं किया जा सकता.)
  • eventNamedHangout: आईडी, Hangout का नाम होता है. (इस कॉन्फ़्रेंस टाइप का इस्तेमाल नहीं किया जा सकता.)
  • hangoutsMeet: आईडी, 10 अक्षरों वाला मीटिंग कोड होता है. उदाहरण के लिए, aaa-bbbb-ccc.
  • addOn: आईडी को तीसरे पक्ष की सेवा देने वाली कंपनी तय करती है.
ज़रूरी नहीं.

conferenceData.conferenceSolution nested object कॉन्फ़्रेंसिंग की सुविधा देने वाला समाधान, जैसे कि Google Meet.

कॉन्फ़्रेंस के लिए सेट नहीं किया गया है. कॉन्फ़्रेंस बनाने का अनुरोध पूरा नहीं किया जा सका.

conferenceSolution और कम से कम एक entryPoint या createRequest में से कोई एक वैल्यू दी जानी चाहिए.

conferenceData.conferenceSolution.iconUri string इस समाधान के लिए, उपयोगकर्ता को दिखने वाला आइकॉन.
conferenceData.conferenceSolution.key nested object यह वह कुंजी है जो इस इवेंट के लिए कॉन्फ़्रेंस के समाधान की यूनीक तरीके से पहचान कर सकती है.
conferenceData.conferenceSolution.key.type string कॉन्फ़्रेंसिंग के समाधान का टाइप.

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

इन वैल्यू का इस्तेमाल किया जा सकता है:

  • "eventHangout" Hangouts for consumers के लिए (अब काम नहीं करता; मौजूदा इवेंट में इस तरह के कॉन्फ़्रेंस की सुविधा दिख सकती है, लेकिन नए कॉन्फ़्रेंस नहीं बनाए जा सकते)
  • "eventNamedHangout" Google Workspace के उपयोगकर्ताओं के लिए Hangouts का क्लासिक वर्शन (बंद कर दिया गया है; मौजूदा इवेंट में कॉन्फ़्रेंस के इस समाधान का टाइप दिख सकता है, लेकिन नए कॉन्फ़्रेंस नहीं बनाए जा सकते)
  • "hangoutsMeet" for Google Meet (http://meet.google.com)
  • "addOn" तीसरे पक्ष की कॉन्फ़्रेंस कंपनियों के लिए

conferenceData.conferenceSolution.name string यह प्रॉपर्टी इस समाधान के लिए, उपयोगकर्ता को दिखने वाले नाम के बारे में जानकारी देती है. स्थानीय भाषा में उपलब्ध नहीं है.
conferenceData.createRequest nested object कॉन्फ़्रेंस जनरेट करने और उसे इवेंट से अटैच करने का अनुरोध. डेटा को एसिंक्रोनस तरीके से जनरेट किया जाता है. डेटा मौजूद है या नहीं, यह देखने के लिए status फ़ील्ड देखें.

conferenceSolution और कम से कम एक entryPoint या createRequest में से कोई एक वैल्यू दी जानी चाहिए.

conferenceData.createRequest.conferenceSolutionKey nested object कॉन्फ़्रेंसिंग की सुविधा देने वाला ऐप्लिकेशन, जैसे कि Hangouts या Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type string कॉन्फ़्रेंसिंग के समाधान का टाइप.

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

इन वैल्यू का इस्तेमाल किया जा सकता है:

  • "eventHangout" Hangouts for consumers के लिए (अब काम नहीं करता; मौजूदा इवेंट में इस तरह के कॉन्फ़्रेंस की सुविधा दिख सकती है, लेकिन नए कॉन्फ़्रेंस नहीं बनाए जा सकते)
  • "eventNamedHangout" Google Workspace के उपयोगकर्ताओं के लिए Hangouts का क्लासिक वर्शन (बंद कर दिया गया है; मौजूदा इवेंट में कॉन्फ़्रेंस के इस समाधान का टाइप दिख सकता है, लेकिन नए कॉन्फ़्रेंस नहीं बनाए जा सकते)
  • "hangoutsMeet" for Google Meet (http://meet.google.com)
  • "addOn" तीसरे पक्ष की कॉन्फ़्रेंस कंपनियों के लिए

conferenceData.createRequest.requestId string क्लाइंट से जनरेट किया गया, इस अनुरोध के लिए यूनीक आईडी.

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

conferenceData.createRequest.status nested object कॉन्फ़्रेंस बनाने के अनुरोध की स्थिति.
conferenceData.createRequest.status.statusCode string कॉन्फ़्रेंस बनाने के अनुरोध की मौजूदा स्थिति. सिर्फ़ पढ़ने के लिए.

इन वैल्यू का इस्तेमाल किया जा सकता है:

  • "pending": कॉन्फ़्रेंस बनाने का अनुरोध अब भी प्रोसेस किया जा रहा है.
  • "success": कॉन्फ़्रेंस बनाने का अनुरोध पूरा हो गया है. एंट्री पॉइंट भर दिए गए हैं.
  • "failure": कॉन्फ़्रेंस बनाने का अनुरोध पूरा नहीं किया जा सका. कोई एंट्री पॉइंट नहीं है.

conferenceData.entryPoints[] list कॉन्फ़्रेंस में शामिल होने के अलग-अलग तरीकों के बारे में जानकारी. जैसे, यूआरएल या फ़ोन नंबर.

ये सभी एक ही कॉन्फ़्रेंस से जुड़े होने चाहिए.

conferenceSolution और कम से कम एक entryPoint या createRequest में से कोई एक वैल्यू दी जानी चाहिए.

conferenceData.entryPoints[].accessCode string कॉन्फ़्रेंस को ऐक्सेस करने का कोड. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं.

नया कॉन्फ़्रेंस डेटा बनाते समय, सिर्फ़ {meetingCode, accessCode, passcode, password, pin} फ़ील्ड के उस सबसेट को भरें जो कॉन्फ़्रेंस की सेवा देने वाली कंपनी की शब्दावली से मेल खाता हो. सिर्फ़ वे फ़ील्ड दिखने चाहिए जिनमें जानकारी भरी गई है.

ज़रूरी नहीं.

conferenceData.entryPoints[].entryPointType string कॉन्फ़्रेंस में शामिल होने के एंट्री पॉइंट का टाइप.

ये वैल्यू इस्तेमाल की जा सकती हैं:

  • "video" - एचटीटीपी पर कॉन्फ़्रेंस में शामिल होना. किसी कॉन्फ़्रेंस में एक या एक से ज़्यादा video एंट्री पॉइंट हो सकते हैं.
  • "phone" - फ़ोन नंबर डायल करके कॉन्फ़्रेंस में शामिल होना. किसी कॉन्फ़्रेंस में शून्य या उससे ज़्यादा phone एंट्री पॉइंट हो सकते हैं.
  • "sip" - एसआईपी के ज़रिए किसी कॉन्फ़्रेंस में शामिल हो रहा है. किसी कॉन्फ़्रेंस में एक या एक से ज़्यादा sip एंट्री पॉइंट हो सकते हैं.
  • "more" - कॉन्फ़्रेंस में शामिल होने के बारे में ज़्यादा जानकारी. जैसे, अन्य फ़ोन नंबर. किसी कॉन्फ़्रेंस में एक या एक से ज़्यादा more एंट्री पॉइंट हो सकते हैं. सिर्फ़ more एंट्री पॉइंट वाला कॉन्फ़्रेंस, मान्य कॉन्फ़्रेंस नहीं होता.

conferenceData.entryPoints[].label string यूआरआई का लेबल. यह असली उपयोगकर्ताओं को दिखेगा. स्थानीय भाषा में उपलब्ध नहीं है. इसमें ज़्यादा से ज़्यादा 512 वर्ण इस्तेमाल किए जा सकते हैं.

उदाहरण:

  • video के लिए: meet.google.com/aaa-bbbb-ccc
  • phone के लिए: +1 123 268 2601
  • sip के लिए: 12345678@altostrat.com
  • more के लिए: इसे नहीं भरा जाना चाहिए

ज़रूरी नहीं.

conferenceData.entryPoints[].meetingCode string कॉन्फ़्रेंस को ऐक्सेस करने के लिए मीटिंग कोड. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं.

नया कॉन्फ़्रेंस डेटा बनाते समय, सिर्फ़ {meetingCode, accessCode, passcode, password, pin} फ़ील्ड के उस सबसेट को भरें जो कॉन्फ़्रेंस की सेवा देने वाली कंपनी की शब्दावली से मेल खाता हो. सिर्फ़ वे फ़ील्ड दिखने चाहिए जिनमें जानकारी भरी गई है.

ज़रूरी नहीं.

conferenceData.entryPoints[].passcode string कॉन्फ़्रेंस को ऐक्सेस करने का पासकोड. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं.

नया कॉन्फ़्रेंस डेटा बनाते समय, सिर्फ़ {meetingCode, accessCode, passcode, password, pin} फ़ील्ड के उस सबसेट को भरें जो कॉन्फ़्रेंस की सेवा देने वाली कंपनी की शब्दावली से मेल खाता हो. सिर्फ़ वे फ़ील्ड दिखने चाहिए जिनमें जानकारी भरी गई है.

conferenceData.entryPoints[].password string कॉन्फ़्रेंस को ऐक्सेस करने का पासवर्ड. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं.

नया कॉन्फ़्रेंस डेटा बनाते समय, सिर्फ़ {meetingCode, accessCode, passcode, password, pin} फ़ील्ड के उस सबसेट को भरें जो कॉन्फ़्रेंस की सेवा देने वाली कंपनी की शब्दावली से मेल खाता हो. सिर्फ़ वे फ़ील्ड दिखने चाहिए जिनमें जानकारी भरी गई है.

ज़रूरी नहीं.

conferenceData.entryPoints[].pin string कॉन्फ़्रेंस को ऐक्सेस करने के लिए पिन. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं.

नया कॉन्फ़्रेंस डेटा बनाते समय, सिर्फ़ {meetingCode, accessCode, passcode, password, pin} फ़ील्ड के उस सबसेट को भरें जो कॉन्फ़्रेंस की सेवा देने वाली कंपनी की शब्दावली से मेल खाता हो. सिर्फ़ वे फ़ील्ड दिखने चाहिए जिनमें जानकारी भरी गई है.

ज़रूरी नहीं.

conferenceData.entryPoints[].uri string एंट्री पॉइंट का यूआरआई. इसमें ज़्यादा से ज़्यादा 1,300 वर्ण इस्तेमाल किए जा सकते हैं.

फ़ॉर्मैट:

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

conferenceData.notes string उपयोगकर्ता को दिखाने के लिए अतिरिक्त नोट (जैसे, डोमेन एडमिन के निर्देश, कानूनी सूचनाएं). इसमें एचटीएमएल शामिल हो सकता है. इसमें ज़्यादा से ज़्यादा 2,048 वर्ण इस्तेमाल किए जा सकते हैं. ज़रूरी नहीं.
conferenceData.signature string कॉन्फ़्रेंस के डेटा का हस्ताक्षर.

यह सर्वर साइड पर जनरेट होता है.

कॉन्फ़्रेंस के लिए सेट नहीं किया गया है. कॉन्फ़्रेंस बनाने का अनुरोध पूरा नहीं किया जा सका.

यह उन कॉन्फ़्रेंस के लिए ज़रूरी नहीं है जिनके लिए मीटिंग बनाने का अनुरोध अब तक पूरा नहीं हुआ है.

created datetime इवेंट बनाए जाने का समय (RFC3339 टाइमस्टैंप के तौर पर). सिर्फ़ पढ़ने के लिए.
creator object इवेंट बनाने वाला व्यक्ति. सिर्फ़ पढ़ने के लिए.
creator.displayName string अगर उपलब्ध हो, तो क्रिएटर का नाम.
creator.email string अगर क्रिएटर का ईमेल पता उपलब्ध है, तो उसे यहां दिखाया जाता है.
creator.id string क्रिएटर का प्रोफ़ाइल आईडी, अगर उपलब्ध हो.
creator.self boolean इससे पता चलता है कि इवेंट को शेड्यूल करने वाला व्यक्ति, उस कैलेंडर का मालिक है या नहीं जिस पर इवेंट की यह कॉपी दिखती है. सिर्फ़ पढ़ने के लिए. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
description string इवेंट के बारे में जानकारी. इसमें एचटीएमएल शामिल हो सकता है. ज़रूरी नहीं. लिखा जा सकता है
end nested object इवेंट के खत्म होने का समय (अलग से उपलब्ध). बार-बार होने वाले इवेंट के लिए, यह पहले इंस्टेंस के खत्म होने का समय होता है.
end.date date अगर यह पूरे दिन का इवेंट है, तो तारीख "yyyy-mm-dd" फ़ॉर्मैट में. लिखा जा सकता है
end.dateTime datetime समय, तारीख और समय की वैल्यू के तौर पर (RFC3339 के मुताबिक फ़ॉर्मैट किया गया). टाइम ज़ोन ऑफ़सेट की जानकारी देना ज़रूरी है. हालांकि, अगर timeZone में टाइम ज़ोन की जानकारी दी गई है, तो इसकी ज़रूरत नहीं है. लिखा जा सकता है
end.timeZone string वह टाइम ज़ोन जिसमें समय बताया गया है. (इसे आईएएनए टाइम ज़ोन डेटाबेस के नाम के तौर पर फ़ॉर्मैट किया गया है. उदाहरण के लिए, "Europe/Zurich".) बार-बार होने वाले इवेंट के लिए, इस फ़ील्ड की ज़रूरत होती है. इससे उस समय क्षेत्र के बारे में पता चलता है जिसमें बार-बार होने वाले इवेंट को बढ़ाया जाता है. सिंगल इवेंट के लिए, यह फ़ील्ड वैकल्पिक होता है. इससे इवेंट के शुरू/खत्म होने के लिए कस्टम टाइम ज़ोन का पता चलता है. लिखा जा सकता है
endTimeUnspecified boolean इससे पता चलता है कि इवेंट खत्म होने का समय वाकई नहीं बताया गया है. हालांकि, इस एट्रिब्यूट को 'सही' पर सेट करने के बावजूद, कंपैटिबिलिटी की वजह से खत्म होने का समय अब भी दिया जाता है. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
etag etag संसाधन का ETag.
eventLabelId string इवेंट को असाइन किए गए इवेंट लेबल का आईडी. ज़रूरी नहीं. यह कैलेंडर की labelProperties.eventLabels प्रॉपर्टी में मौजूद किसी एंट्री का आईडी होता है. इसके बारे में जानने के लिए, Calendars.get एंडपॉइंट देखें.

यह प्रॉपर्टी, इंडेक्स पर आधारित colorId प्रॉपर्टी की जगह लेती है. इस प्रॉपर्टी को सेट या बदलने के लिए, आपको insert, import, update, और patch तरीकों के पैरामीटर में eventLabelVersion=1 को तय करना होगा.

इस फ़ील्ड को किसी खाली स्ट्रिंग पर सेट करने या इसे सेट न करने पर, इवेंट से मौजूदा लेबल हट जाएगा.

लिखा जा सकता है
eventType string इवेंट का टाइप. इवेंट बनाने के बाद, इसमें बदलाव नहीं किया जा सकता. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "birthday" - यह पूरे दिन का एक खास इवेंट है, जो हर साल होता है.
  • "default" - सामान्य इवेंट या इसके बारे में ज़्यादा जानकारी नहीं दी गई है.
  • "focusTime" - काम पर फ़ोकस करने के लिए बनाया गया इवेंट.
  • "fromGmail" - Gmail से मिला कोई इवेंट. इस तरह का इवेंट नहीं बनाया जा सकता.
  • "outOfOffice" - यह 'अभी मैं छुट्टी पर हूं' इवेंट होता है.
  • "workingLocation" - काम करने की जगह की जानकारी देने वाला इवेंट.
लिखा जा सकता है
extendedProperties object इवेंट की ज़्यादा प्रॉपर्टी.
extendedProperties.private object ये ऐसी प्रॉपर्टी हैं जो इस कैलेंडर पर दिखने वाले इवेंट की कॉपी के लिए निजी होती हैं. लिखा जा सकता है
extendedProperties.private.(key) string निजी प्रॉपर्टी का नाम और उससे जुड़ी वैल्यू.
extendedProperties.shared object ये ऐसी प्रॉपर्टी होती हैं जिन्हें इवेंट की कॉपी के बीच शेयर किया जाता है. ये कॉपी, इवेंट में शामिल अन्य लोगों के कैलेंडर पर दिखती हैं. लिखा जा सकता है
extendedProperties.shared.(key) string शेयर की गई प्रॉपर्टी का नाम और उससे जुड़ी वैल्यू.
focusTimeProperties nested object फ़ोकस टाइम इवेंट का डेटा. इस एट्रिब्यूट का इस्तेमाल तब किया जाता है, जब eventType एट्रिब्यूट की वैल्यू focusTime हो. लिखा जा सकता है
focusTimeProperties.autoDeclineMode string यह तय करता है कि काम पर फ़ोकस करने के लिए बनाए गए इवेंट के साथ ओवरलैप होने वाले मीटिंग के न्योते अस्वीकार किए जाएं या नहीं. मान्य वैल्यू ये हैं: declineNone, इसका मतलब है कि मीटिंग के किसी भी न्योते को अस्वीकार नहीं किया जाएगा; declineAllConflictingInvitations, इसका मतलब है कि इवेंट के साथ टकराव करने वाले मीटिंग के सभी न्योते अस्वीकार कर दिए जाएंगे; और declineOnlyNewConflictingInvitations, इसका मतलब है कि काम पर फ़ोकस करने के लिए बनाए गए इवेंट के दौरान, मीटिंग के सिर्फ़ उन नए न्योतों को अस्वीकार किया जाएगा जो इवेंट के साथ टकराव करते हैं.
focusTimeProperties.chatStatus string Chat और इससे जुड़े प्रॉडक्ट में उपयोगकर्ता को मार्क करने की स्थिति. यह available या doNotDisturb हो सकता है.
focusTimeProperties.declineMessage string अगर Calendar किसी मौजूदा इवेंट या नए न्योते को अपने-आप अस्वीकार कर देता है, तो जवाब के तौर पर यह मैसेज सेट किया जाता है.
gadget object यह गैजेट, इस इवेंट को बढ़ाता है. गैजेट बंद कर दिए गए हैं. इस स्ट्रक्चर का इस्तेमाल, सिर्फ़ जन्मदिन के कैलेंडर के मेटाडेटा को वापस लाने के लिए किया जाता है.
gadget.display string गैजेट का डिसप्ले मोड. समर्थन नहीं होना या रुकना. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "icon" - यह गैजेट, कैलेंडर व्यू में इवेंट के टाइटल के बगल में दिखता है.
  • "chip" - यह गैजेट, इवेंट पर क्लिक करने पर दिखता है.
लिखा जा सकता है
gadget.height integer गैजेट की ऊंचाई, पिक्सल में. ऊंचाई ऐसी पूरी संख्या होनी चाहिए जो शून्य से ज़्यादा हो. ज़रूरी नहीं. समर्थन नहीं होना या रुकना. लिखा जा सकता है
gadget.preferences object प्राथमिकताएं पर क्लिक करें. लिखा जा सकता है
gadget.preferences.(key) string प्राथमिकता का नाम और उससे जुड़ी वैल्यू.
gadget.title string गैजेट का टाइटल. समर्थन नहीं होना या रुकना. लिखा जा सकता है
gadget.type string गैजेट का टाइप. समर्थन नहीं होना या रुकना. लिखा जा सकता है
gadget.width integer पिक्सेल में गैजेट की चौड़ाई. चौड़ाई, 0 से ज़्यादा वाली कोई पूर्णांक संख्या होनी चाहिए. ज़रूरी नहीं. समर्थन नहीं होना या रुकना. लिखा जा सकता है
guestsCanInviteOthers boolean यह जानकारी कि क्या आयोजक के अलावा अन्य लोग भी इवेंट में शामिल होने के लिए दूसरों को न्योता दे सकते हैं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह True पर सेट होता है. लिखा जा सकता है
guestsCanModify boolean यह जानकारी कि क्या इवेंट शेड्यूल करने वाले व्यक्ति के अलावा, अन्य मेहमान इवेंट में बदलाव कर सकते हैं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह False पर सेट होता है. लिखा जा सकता है
guestsCanSeeOtherGuests boolean यह तय करना कि आयोजक के अलावा, इवेंट में हिस्सा लेने वाले अन्य लोग यह देख सकते हैं या नहीं कि इवेंट में हिस्सा लेने वाले लोग कौन हैं. ज़रूरी नहीं. डिफ़ॉल्ट रूप से, यह True पर सेट होता है. लिखा जा सकता है
iCalUID string RFC5545 में बताए गए इवेंट का यूनीक आइडेंटिफ़ायर. इसका इस्तेमाल, कैलेंडर सिस्टम में इवेंट की पहचान करने के लिए किया जाता है. import तरीके से इवेंट इंपोर्ट करते समय, इसे उपलब्ध कराना ज़रूरी है.

ध्यान दें कि iCalUID और id एक जैसे नहीं हैं. इवेंट बनाते समय, इनमें से सिर्फ़ एक को सबमिट किया जाना चाहिए. इनके सिमैंटिक में एक अंतर यह है कि बार-बार होने वाले इवेंट में, एक इवेंट के सभी इंस्टेंस के लिए अलग-अलग id होते हैं, जबकि वे सभी एक ही iCalUID शेयर करते हैं. किसी इवेंट को उसके iCalUID का इस्तेमाल करके वापस पाने के लिए, iCalUID पैरामीटर का इस्तेमाल करके events.list तरीके को कॉल करें. किसी इवेंट को उसके id का इस्तेमाल करके वापस पाने के लिए, events.get तरीके को कॉल करें.

id string इवेंट का अपारदर्शी आइडेंटिफ़ायर. एक बार होने वाले या बार-बार होने वाले नए इवेंट बनाते समय, उनके आईडी तय किए जा सकते हैं. सबमिट किए गए आईडी इन नियमों के मुताबिक होने चाहिए:
  • आईडी में इस्तेमाल किए जा सकने वाले वर्ण, base32hex एन्कोडिंग में इस्तेमाल किए जाते हैं.जैसे, अंग्रेज़ी के छोटे अक्षर a से v और अंक 0 से 9. इसके बारे में जानने के लिए, RFC2938 के सेक्शन 3.1.2 पर जाएं
  • आईडी की लंबाई 5 से 1,024 वर्णों के बीच होनी चाहिए
  • हर कैलेंडर के लिए आईडी यूनीक होना चाहिए
सिस्टम दुनिया भर में फैला हुआ है. इसलिए, हम इस बात की गारंटी नहीं दे सकते कि इवेंट बनाते समय आईडी के टकराव का पता चल जाएगा. हमारा सुझाव है कि टकराव के जोखिम को कम करने के लिए, RFC4122 में बताए गए यूयूआईडी एल्गोरिदम जैसे किसी स्थापित एल्गोरिदम का इस्तेमाल करें.

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

ध्यान दें कि icalUID और id एक जैसे नहीं हैं. इवेंट बनाते समय, इनमें से सिर्फ़ एक को सबमिट किया जाना चाहिए. इनके सिमैंटिक में एक अंतर यह है कि बार-बार होने वाले इवेंट में, एक इवेंट के सभी इंस्टेंस के लिए अलग-अलग id होते हैं, जबकि वे सभी एक ही icalUID शेयर करते हैं.

लिखा जा सकता है
kind string संसाधन का टाइप ("calendar#event").
location string इवेंट की भौगोलिक जगह, फ़्री-फ़ॉर्म टेक्स्ट के तौर पर. ज़रूरी नहीं. लिखा जा सकता है
locked boolean यह एक लॉक की गई इवेंट कॉपी है. इसमें मुख्य इवेंट फ़ील्ड "खास जानकारी", "ब्यौरा", "जगह", "शुरू होने का समय", "खत्म होने का समय" या "दोहराव" में कोई बदलाव नहीं किया जा सकता. डिफ़ॉल्ट रूप से, यह False पर सेट होता है. रीड-ओनली.
organizer object इवेंट का आयोजक. अगर मीटिंग आयोजित करने वाला व्यक्ति भी शामिल होने वाला व्यक्ति है, तो इसे attendees में अलग एंट्री के तौर पर दिखाया जाता है. साथ ही, organizer फ़ील्ड को 'सही' पर सेट किया जाता है. आयोजक को बदलने के लिए, move ऑपरेशन का इस्तेमाल करें. इवेंट इंपोर्ट करने के अलावा, सिर्फ़ देखने की अनुमति. लिखा जा सकता है
organizer.displayName string अगर उपलब्ध हो, तो आयोजक का नाम. लिखा जा सकता है
organizer.email string अगर उपलब्ध हो, तो इवेंट के आयोजक का ईमेल पता. यह RFC5322 के मुताबिक एक मान्य ईमेल पता होना चाहिए. लिखा जा सकता है
organizer.id string अगर उपलब्ध हो, तो इवेंट के आयोजक का प्रोफ़ाइल आईडी.
organizer.self boolean इससे पता चलता है कि इवेंट को शेड्यूल करने वाला व्यक्ति, उस कैलेंडर का मालिक है या नहीं जिस पर इवेंट की यह कॉपी दिखती है. सिर्फ़ पढ़ने के लिए. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
originalStartTime nested object बार-बार होने वाले इवेंट के किसी इंस्टेंस के लिए, यह वह समय होता है जब यह इवेंट, recurringEventId से पहचाने गए बार-बार होने वाले इवेंट के दोहराव के डेटा के हिसाब से शुरू होगा. यह बार-बार होने वाले इवेंट की सीरीज़ में इंस्टेंस की यूनीक पहचान करता है. भले ही, इंस्टेंस को किसी दूसरे समय पर ले जाया गया हो. इम्यूटेबल.
originalStartTime.date date अगर यह पूरे दिन का इवेंट है, तो तारीख "yyyy-mm-dd" फ़ॉर्मैट में. लिखा जा सकता है
originalStartTime.dateTime datetime समय, तारीख और समय की वैल्यू के तौर पर (RFC3339 के मुताबिक फ़ॉर्मैट किया गया). टाइम ज़ोन ऑफ़सेट की जानकारी देना ज़रूरी है. हालांकि, अगर timeZone में टाइम ज़ोन की जानकारी दी गई है, तो इसकी ज़रूरत नहीं है. लिखा जा सकता है
originalStartTime.timeZone string वह टाइम ज़ोन जिसमें समय बताया गया है. (इसे आईएएनए टाइम ज़ोन डेटाबेस के नाम के तौर पर फ़ॉर्मैट किया गया है. उदाहरण के लिए, "Europe/Zurich".) बार-बार होने वाले इवेंट के लिए, इस फ़ील्ड की ज़रूरत होती है. इससे उस समय क्षेत्र के बारे में पता चलता है जिसमें बार-बार होने वाले इवेंट को बढ़ाया जाता है. सिंगल इवेंट के लिए, यह फ़ील्ड वैकल्पिक होता है. इससे इवेंट के शुरू/खत्म होने के लिए कस्टम टाइम ज़ोन का पता चलता है. लिखा जा सकता है
outOfOfficeProperties nested object 'अभी मैं छुट्टी पर हूं' इवेंट का डेटा. इस एट्रिब्यूट का इस्तेमाल तब किया जाता है, जब eventType एट्रिब्यूट की वैल्यू outOfOffice हो. लिखा जा सकता है
outOfOfficeProperties.autoDeclineMode string यह तय करना कि 'अभी मैं छुट्टी पर हूं' इवेंट के साथ ओवरलैप होने वाली मीटिंग के न्योते अस्वीकार करने हैं या नहीं. मान्य वैल्यू ये हैं: declineNone, इसका मतलब है कि मीटिंग के किसी भी न्योते को अस्वीकार नहीं किया जाएगा; declineAllConflictingInvitations, इसका मतलब है कि इवेंट से टकराने वाले मीटिंग के सभी न्योते अस्वीकार किए जाएंगे; और declineOnlyNewConflictingInvitations, इसका मतलब है कि 'अभी मैं छुट्टी पर हूं' इवेंट के दौरान मिलने वाले, इवेंट से टकराने वाले मीटिंग के सिर्फ़ नए न्योते अस्वीकार किए जाएंगे.
outOfOfficeProperties.declineMessage string अगर Calendar किसी मौजूदा इवेंट या नए न्योते को अपने-आप अस्वीकार कर देता है, तो जवाब के तौर पर यह मैसेज सेट किया जाता है.
privateCopy boolean अगर इसे 'सही है' पर सेट किया जाता है, तो इवेंट प्रोपगेशन बंद हो जाता है. ध्यान दें कि यह निजी इवेंट की प्रॉपर्टी से अलग है. ज़रूरी नहीं. इम्यूटेबल. डिफ़ॉल्ट रूप से, यह False पर सेट होता है.
recurrence[] list बार-बार होने वाले इवेंट के लिए, RRULE, EXRULE, RDATE, और EXDATE लाइनों की सूची. यह RFC5545 में बताई गई है. ध्यान दें कि इस फ़ील्ड में DTSTART और DTEND लाइनें इस्तेमाल करने की अनुमति नहीं है. इवेंट के शुरू और खत्म होने का समय, start और end फ़ील्ड में दिया जाता है. इस फ़ील्ड को, किसी खास इवेंट या बार-बार होने वाले इवेंट के इंस्टेंस के लिए शामिल नहीं किया जाता. लिखा जा सकता है
recurringEventId string बार-बार होने वाले इवेंट के किसी इंस्टेंस के लिए, यह उस बार-बार होने वाले इवेंट का id होता है जिससे यह इंस्टेंस जुड़ा होता है. इम्यूटेबल.
reminders object भरोसेमंद व्यक्ति के लिए, इवेंट के रिमाइंडर के बारे में जानकारी. ध्यान दें कि रिमाइंडर बदलने से, इवेंट की updated प्रॉपर्टी में भी बदलाव नहीं होता.
reminders.overrides[] list अगर इवेंट में डिफ़ॉल्ट रिमाइंडर का इस्तेमाल नहीं किया जाता है, तो इससे इवेंट के हिसाब से रिमाइंडर की सूची दिखती है. अगर रिमाइंडर सेट नहीं किए गए हैं, तो इससे पता चलता है कि इस इवेंट के लिए कोई रिमाइंडर सेट नहीं किया गया है. छुट्टी के रिमाइंडर को ज़्यादा से ज़्यादा पांच बार अनदेखा किया जा सकता है. लिखा जा सकता है
reminders.overrides[].method string इस रिमाइंडर के लिए इस्तेमाल किया गया तरीका. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "email" - रिमाइंडर ईमेल से भेजे जाते हैं.
  • "popup" - रिमाइंडर, यूज़र इंटरफ़ेस वाले पॉप-अप के ज़रिए भेजे जाते हैं.

रिमाइंडर जोड़ने के लिए ज़रूरी है.

लिखा जा सकता है
reminders.overrides[].minutes integer इवेंट शुरू होने से कितने मिनट पहले रिमाइंडर ट्रिगर होना चाहिए. मान्य वैल्यू 0 से 40320 (चार हफ़्ते में मिनट) के बीच होती हैं.

रिमाइंडर जोड़ने के लिए ज़रूरी है.

लिखा जा सकता है
reminders.useDefault boolean इससे पता चलता है कि कैलेंडर के डिफ़ॉल्ट रिमाइंडर, इवेंट पर लागू होते हैं या नहीं. लिखा जा सकता है
sequence integer iCalendar के मुताबिक क्रम संख्या. लिखा जा सकता है
source object वह सोर्स जिससे इवेंट बनाया गया था. उदाहरण के लिए, कोई वेब पेज, ईमेल मैसेज या ऐसा कोई भी दस्तावेज़ जिसकी पहचान एचटीटीपी या एचटीटीपीएस स्कीम वाले यूआरएल से की जा सकती है. इसे सिर्फ़ इवेंट बनाने वाला व्यक्ति देख सकता है या इसमें बदलाव कर सकता है.
source.title string सोर्स का टाइटल; उदाहरण के लिए, किसी वेब पेज का टाइटल या ईमेल का विषय. लिखा जा सकता है
source.url string किसी संसाधन की ओर ले जाने वाले सोर्स का यूआरएल. यूआरएल स्कीम, एचटीटीपी या एचटीटीपीएस होनी चाहिए. लिखा जा सकता है
start nested object इवेंट के शुरू होने का समय (शामिल है). बार-बार होने वाले इवेंट के लिए, यह पहले इंस्टेंस के शुरू होने का समय होता है.
start.date date अगर यह पूरे दिन का इवेंट है, तो तारीख "yyyy-mm-dd" फ़ॉर्मैट में. लिखा जा सकता है
start.dateTime datetime समय, तारीख और समय की वैल्यू के तौर पर (RFC3339 के मुताबिक फ़ॉर्मैट किया गया). टाइम ज़ोन ऑफ़सेट की जानकारी देना ज़रूरी है. हालांकि, अगर timeZone में टाइम ज़ोन की जानकारी दी गई है, तो इसकी ज़रूरत नहीं है. लिखा जा सकता है
start.timeZone string वह टाइम ज़ोन जिसमें समय बताया गया है. (इसे आईएएनए टाइम ज़ोन डेटाबेस के नाम के तौर पर फ़ॉर्मैट किया गया है. उदाहरण के लिए, "Europe/Zurich".) बार-बार होने वाले इवेंट के लिए, इस फ़ील्ड की ज़रूरत होती है. इससे उस समय क्षेत्र के बारे में पता चलता है जिसमें बार-बार होने वाले इवेंट को बढ़ाया जाता है. सिंगल इवेंट के लिए, यह फ़ील्ड वैकल्पिक होता है. इससे इवेंट के शुरू/खत्म होने के लिए कस्टम टाइम ज़ोन का पता चलता है. लिखा जा सकता है
status string इवेंट की स्थिति. ज़रूरी नहीं. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "confirmed" - इवेंट की पुष्टि हो गई है. यह डिफ़ॉल्ट स्थिति है.
  • "tentative" - इवेंट की पुष्टि अस्थायी तौर पर की गई है.
  • "cancelled" - इवेंट रद्द कर दिया गया है (मिटा दिया गया है). list तरीके से, रद्द किए गए इवेंट सिर्फ़ इंक्रीमेंटल सिंक (जब syncToken या updatedMin तय किए गए हों) पर दिखते हैं. इसके अलावा, अगर showDeleted फ़्लैग को true पर सेट किया गया हो, तब भी रद्द किए गए इवेंट दिखते हैं. get तरीके से हमेशा ये वैल्यू मिलती हैं.

    'रद्द किया गया' स्टेटस, इवेंट टाइप के हिसाब से दो अलग-अलग स्थितियों को दिखाता है:

    1. बार-बार होने वाले किसी ऐसे इवेंट के रद्द किए गए अपवादों से पता चलता है कि इस इंस्टेंस को अब उपयोगकर्ता को नहीं दिखाया जाना चाहिए. क्लाइंट को इन इवेंट को, बार-बार होने वाले पैरंट इवेंट की पूरी अवधि के लिए सेव करना चाहिए.

      रद्द किए गए अपवादों के लिए, सिर्फ़ id, recurringEventId, और originalStartTime फ़ील्ड की वैल्यू भरी जाती हैं. ऐसा हो सकता है कि अन्य फ़ील्ड खाली हों.

    2. रद्द किए गए अन्य सभी इवेंट, मिटाए गए इवेंट होते हैं. क्लाइंट को अपनी लोकल सिंक की गई कॉपी हटा देनी चाहिए. रद्द किए गए ऐसे इवेंट आखिर में दिखना बंद हो जाएंगे. इसलिए, यह न सोचें कि ये हमेशा उपलब्ध रहेंगे.

      मिटाए गए इवेंट के लिए, सिर्फ़ id फ़ील्ड में वैल्यू मौजूद होती है.

    आयोजक के कैलेंडर में, रद्द किए गए इवेंट की जानकारी (खास जानकारी, जगह वगैरह) दिखती रहती है, ताकि उन्हें वापस लाया जा सके. इसी तरह, जिन इवेंट के लिए उपयोगकर्ता को न्योता भेजा गया था और जिन्हें उसने मैन्युअल तरीके से हटाया था उनकी जानकारी भी मिलती रहेगी. हालांकि, showDeleted को 'गलत है' पर सेट करके, इंक्रीमेंटल सिंक के अनुरोध करने पर यह जानकारी नहीं मिलेगी.

    अगर किसी इवेंट का आयोजक बदल जाता है (उदाहरण के लिए, move ऑपरेशन के ज़रिए) और मूल आयोजक, शामिल होने वाले लोगों की सूची में नहीं है, तो इवेंट रद्द हो जाएगा. इसमें सिर्फ़ id फ़ील्ड में जानकारी मौजूद होगी.

लिखा जा सकता है
summary string इवेंट का शीर्षक. लिखा जा सकता है
transparency string इससे पता चलता है कि इवेंट, कैलेंडर में समय ब्लॉक करता है या नहीं. ज़रूरी नहीं. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "opaque" - डिफ़ॉल्ट वैल्यू. इवेंट, कैलेंडर में समय को ब्लॉक करता है. यह Calendar के यूज़र इंटरफ़ेस (यूआई) में, मुझे इस तरह दिखाएं को व्यस्त पर सेट करने के बराबर है.
  • "transparent" - इस इवेंट से कैलेंडर में कोई समय ब्लॉक नहीं होता. यह Calendar के यूज़र इंटरफ़ेस (यूआई) में, मुझे इस तरह दिखाएं को उपलब्ध है पर सेट करने के बराबर है.
लिखा जा सकता है
updated datetime मुख्य इवेंट डेटा में आखिरी बार बदलाव कब किया गया था (RFC3339 टाइमस्‍टैंप के तौर पर). इवेंट के रिमाइंडर अपडेट करने से, इसमें कोई बदलाव नहीं होगा. सिर्फ़ पढ़ने के लिए.
visibility string इवेंट किसको दिखे. ज़रूरी नहीं. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "default" - इससे कैलेंडर पर मौजूद इवेंट के लिए, डिफ़ॉल्ट रूप से दिखने की सेटिंग का इस्तेमाल होता है. यह डिफ़ॉल्ट मान है.
  • "public" - इवेंट सार्वजनिक है और इवेंट की जानकारी, कैलेंडर देखने वाले सभी लोगों को दिखती है.
  • "private" - इवेंट को निजी के तौर पर मार्क किया गया है. इसमें शामिल लोग ही इवेंट की जानकारी देख सकते हैं.
  • "confidential" - इवेंट को निजी के तौर पर सेट किया गया है. यह वैल्यू, पुराने सिस्टम के साथ काम करने की सुविधा के लिए दी गई है.
लिखा जा सकता है
workingLocationProperties nested object काम करने की जगह के इवेंट का डेटा. लिखा जा सकता है
workingLocationProperties.customLocation object अगर यह मौजूद है, तो इसका मतलब है कि उपयोगकर्ता किसी कस्टम जगह से काम कर रहा है. लिखा जा सकता है
workingLocationProperties.customLocation.label string ज़्यादा जानकारी के लिए, एक अतिरिक्त लेबल (ज़रूरी नहीं). लिखा जा सकता है
workingLocationProperties.homeOffice any value अगर यह मौजूद है, तो इसका मतलब है कि उपयोगकर्ता घर से काम कर रहा है. लिखा जा सकता है
workingLocationProperties.officeLocation object अगर यह मौजूद है, तो इसका मतलब है कि उपयोगकर्ता ऑफ़िस से काम कर रहा है. लिखा जा सकता है
workingLocationProperties.officeLocation.buildingId string बिल्डिंग का वैकल्पिक आइडेंटिफ़ायर. यह संगठन के संसाधन डेटाबेस में मौजूद बिल्डिंग आईडी का रेफ़रंस होना चाहिए. लिखा जा सकता है
workingLocationProperties.officeLocation.deskId string डेस्क आइडेंटिफ़ायर (ज़रूरी नहीं). लिखा जा सकता है
workingLocationProperties.officeLocation.floorId string फ़्लोर आइडेंटिफ़ायर, जिसे डालना ज़रूरी नहीं है. लिखा जा सकता है
workingLocationProperties.officeLocation.floorSectionId string फ़्लोर सेक्शन का वैकल्पिक आइडेंटिफ़ायर. लिखा जा सकता है
workingLocationProperties.officeLocation.label string ऑफ़िस का वह नाम जो Calendar के वेब और मोबाइल क्लाइंट पर दिखता है. हमारा सुझाव है कि आप संगठन के संसाधन डेटाबेस में, बिल्डिंग का नाम डालें. लिखा जा सकता है
workingLocationProperties.type string काम करने की जगह का टाइप. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • "homeOffice" - उपयोगकर्ता घर से काम कर रहा है.
  • "officeLocation" - उपयोगकर्ता ऑफ़िस से काम कर रहा है.
  • "customLocation" - उपयोगकर्ता किसी कस्टम जगह से काम कर रहा है.
कोई भी जानकारी, तय किए गए नाम के सब-फ़ील्ड में दी जाती है. हालांकि, अगर यह फ़ील्ड खाली है, तो यह मौजूद नहीं हो सकता. अन्य फ़ील्ड को अनदेखा कर दिया जाता है.

काम करने की जगह की प्रॉपर्टी जोड़ते समय यह ज़रूरी है.

लिखा जा सकता है

तरीके

मिटाएं
इस फ़ंक्शन का इस्तेमाल करके, किसी इवेंट को मिटाया जा सकता है.
पाएं
इस फ़ंक्शन की मदद से, Google Calendar आईडी के आधार पर इवेंट की जानकारी मिलती है. किसी इवेंट को उसके iCalendar आईडी का इस्तेमाल करके वापस पाने के लिए, events.list तरीके को iCalUID पैरामीटर का इस्तेमाल करके कॉल करें.
import
इवेंट इंपोर्ट करता है. इस ऑपरेशन का इस्तेमाल, किसी कैलेंडर में मौजूदा इवेंट की निजी कॉपी जोड़ने के लिए किया जाता है. सिर्फ़ default के eventType वाले इवेंट इंपोर्ट किए जा सकते हैं.

अब काम नहीं करता: अगर कोई ऐसा इवेंट इंपोर्ट किया जाता है जो default नहीं है, तो उसका टाइप default में बदल जाएगा. साथ ही, इवेंट टाइप के हिसाब से उसकी प्रॉपर्टी हटा दी जाएंगी.

insert
कोई इवेंट बनाता है.
instances
बार-बार होने वाले इवेंट के तय किए गए इंस्टेंस दिखाता है.
list
यह फ़ंक्शन, चुने गए कैलेंडर के इवेंट दिखाता है.
move
किसी इवेंट को दूसरे कैलेंडर में ले जाता है. इसका मतलब है कि इवेंट के आयोजक को बदलता है. ध्यान दें कि सिर्फ़ default इवेंट को ट्रांसफ़र किया जा सकता है. birthday, focusTime, fromGmail, outOfOffice, और workingLocation इवेंट को ट्रांसफ़र नहीं किया जा सकता.
पैच
इस फ़ंक्शन का इस्तेमाल, किसी इवेंट को अपडेट करने के लिए किया जाता है. यह तरीका, पैच सिमैंटिक के साथ काम करता है. ध्यान दें कि हर पैच अनुरोध में तीन कोटा यूनिट इस्तेमाल होती हैं. इसलिए, get के बाद update का इस्तेमाल करना बेहतर होता है. आपके दिए गए फ़ील्ड की वैल्यू, मौजूदा वैल्यू की जगह ले लेती हैं. अनुरोध में जिन फ़ील्ड के बारे में नहीं बताया जाता है उनमें कोई बदलाव नहीं होता. अगर ऐरे फ़ील्ड तय किए जाते हैं, तो वे मौजूदा ऐरे को बदल देते हैं. इससे, ऐरे के पिछले सभी एलिमेंट हट जाते हैं.
quickAdd
यह फ़ंक्शन, सामान्य टेक्स्ट स्ट्रिंग के आधार पर इवेंट बनाता है.
अपडेट करें
इस फ़ंक्शन का इस्तेमाल, किसी इवेंट को अपडेट करने के लिए किया जाता है. यह तरीका, पैच सिमैंटिक्स के साथ काम नहीं करता. साथ ही, यह हमेशा पूरे इवेंट रिसॉर्स को अपडेट करता है. आंशिक अपडेट करने के लिए, एटैग का इस्तेमाल करके get और फिर update करें, ताकि यह पक्का किया जा सके कि अपडेट एक साथ हो.
watch
Events API के संसाधनों में होने वाले बदलावों पर नज़र रखें.