Google Workspace के इवेंट के लिए बेहतर सेवा

Google Workspace की बेहतर इवेंट सेवा की मदद से, Apps Script में Google Workspace Events API का इस्तेमाल किया जा सकता है. इस एपीआई की मदद से, Google Workspace के संसाधनों की सदस्यता ली जा सकती है. इससे आपको अपनी दिलचस्पी के मुताबिक इवेंट की जानकारी मिलती है. इवेंट, संसाधनों में हुए बदलावों को दिखाते हैं. जैसे, संसाधनों को बनाने, अपडेट करने या मिटाने पर.

ज़रूरी शर्तें

  • Apps Script प्रोजेक्ट, जो Apps Script के ज़रिए अपने-आप बनाए गए डिफ़ॉल्ट प्रोजेक्ट के बजाय, स्टैंडर्ड Google Cloud प्रोजेक्ट का इस्तेमाल करता है.
  • सदस्यता इवेंट पाने के लिए, उसी Google Cloud प्रोजेक्ट में बनाया गया Pub/Sub टॉपिक. Pub/Sub विषय बनाने के लिए, Pub/Sub विषय बनाना और उस पर सदस्यता लेना लेख पढ़ें.
  • Chat इवेंट की सदस्यता लेने के लिए, आपके पास Google Cloud Console में Chat API कॉन्फ़िगरेशन पेज पर कॉन्फ़िगर किया गया Google Chat ऐप्लिकेशन होना चाहिए. Google Chat ऐप्लिकेशन बनाने के लिए, Apps Script की मदद से Google Chat ऐप्लिकेशन बनाना लेख पढ़ें.

  • Apps Script प्रोजेक्ट की appsscript.json फ़ाइल में जोड़े गए, अनुमति के ज़रूरी दायरे. ज़रूरी स्कोप, सदस्यताओं के टारगेट किए गए संसाधनों और इवेंट के टाइप पर निर्भर करते हैं. ज़्यादा जानकारी के लिए, Google Workspace Events API के स्कोप चुनना लेख पढ़ें. उदाहरण के लिए:

    "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages.readonly"
]

रेफ़रंस

इस सेवा के बारे में ज़्यादा जानने के लिए, Google Workspace Events API का रेफ़रंस दस्तावेज़ देखें. Apps Script की सभी बेहतर सेवाओं की तरह ही, Google Workspace की इवेंट सेवा भी पब्लिक एपीआई के जैसे ही ऑब्जेक्ट, तरीकों, और पैरामीटर का इस्तेमाल करती है.

नमूना कोड

इन सैंपल में, बेहतर सेवा का इस्तेमाल करके, Google Workspace Events API की सामान्य कार्रवाइयां करने का तरीका बताया गया है.

सदस्यता बनाना

Google Workspace के किसी संसाधन की सदस्यता बनाने के लिए, Apps Script प्रोजेक्ट के कोड में यह फ़ंक्शन जोड़ें:

advanced/events.gs
/**
 * Creates a subscription to receive events about a Google Workspace resource.
 * For a list of supported resources and event types, see the
 * [Google Workspace Events API Overview](https://developers.google.com/workspace/events#supported-events).
 * For additional information, see the
 * [subscriptions.create](https://developers.google.com/workspace/events/reference/rest/v1/subscriptions/create)
 * method reference.
 * @param {!string} targetResource The full resource name of the Google Workspace resource to subscribe to.
 * @param {!string|!Array<string>} eventTypes The types of events to receive about the resource.
 * @param {!string} pubsubTopic The resource name of the Pub/Sub topic that receives events from the subscription.
 */
function createSubscription(targetResource, eventTypes, pubsubTopic) {
  try {
    const operation = WorkspaceEvents.Subscriptions.create({
      targetResource: targetResource,
      eventTypes: eventTypes,
      notificationEndpoint: {
        pubsubTopic: pubsubTopic,
      },
    });
    console.log(operation);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to create subscription with error %s', err.message);
  }
}

सदस्यताओं की सूची

इवेंट टाइप और टारगेट संसाधन के हिसाब से फ़िल्टर की गई सदस्यताओं की सूची देखने के लिए, Apps Script प्रोजेक्ट के कोड में यह फ़ंक्शन जोड़ें:

advanced/events.gs
/**
 * Lists subscriptions created by the calling app filtered by one or more event types and optionally by a target resource.
 * For additional information, see the
 * [subscriptions.list](https://developers.google.com/workspace/events/reference/rest/v1/subscriptions/list)
 * method reference.
 * @param {!string} filter The query filter.
 */
function listSubscriptions(filter) {
  try {
    const response = WorkspaceEvents.Subscriptions.list({ filter });
    console.log(response);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to list subscriptions with error %s', err.message);
  }
}

सदस्यता पाना

किसी सदस्यता के बारे में जानकारी पाने के लिए, Apps Script प्रोजेक्ट के कोड में यह फ़ंक्शन जोड़ें:

advanced/events.gs
/**
 * Gets details about a subscription.
 * For additional information, see the
 * [subscriptions.get](https://developers.google.com/workspace/events/reference/rest/v1/subscriptions/get)
 * method reference.
 * @param {!string} name The resource name of the subscription.
 */
function getSubscription(name) {
  try {
    const subscription = WorkspaceEvents.Subscriptions.get(name);
    console.log(subscription);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to get subscription with error %s', err.message);
  }
}

सदस्यता अपडेट करें

सदस्यता को अपडेट करने या रिन्यू करने के लिए, Apps Script प्रोजेक्ट के कोड में यह फ़ंक्शन जोड़ें:

advanced/events.gs
/**
 * Updates an existing subscription.
 * This can be used to renew a subscription that is about to expire.
 * For additional information, see the
 * [subscriptions.patch](https://developers.google.com/workspace/events/reference/rest/v1/subscriptions/patch)
 * method reference.
 * @param {!string} name The resource name of the subscription.
 */
function patchSubscription(name) {
  try {
    const operation = WorkspaceEvents.Subscriptions.patch({
      // Setting the TTL to 0 seconds extends the subscription to its maximum expiration time.
      ttl: '0s',
    }, name);
    console.log(operation);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to update subscription with error %s', err.message);
  }
}

सदस्यता फिर से चालू करना

किसी सदस्यता को फिर से चालू करने के लिए, Apps Script प्रोजेक्ट के कोड में यह फ़ंक्शन जोड़ें:

advanced/events.gs
/**
 * Reactivates a suspended subscription.
 * Before reactivating, you must resolve any errors with the subscription.
 * For additional information, see the
 * [subscriptions.reactivate](https://developers.google.com/workspace/events/reference/rest/v1/subscriptions/reactivate)
 * method reference.
 * @param {!string} name The resource name of the subscription.
 */
function reactivateSubscription(name) {
  try {
    const operation = WorkspaceEvents.Subscriptions.reactivate({}, name);
    console.log(operation);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to reactivate subscription with error %s', err.message);
  }
}

सदस्यता मिटाना

किसी सदस्यता को मिटाने के लिए, Apps Script प्रोजेक्ट के कोड में यह फ़ंक्शन जोड़ें:

advanced/events.gs
/**
 * Deletes a subscription.
 * For additional information, see the
 * [subscriptions.delete](https://developers.google.com/workspace/events/reference/rest/v1/subscriptions/delete)
 * method reference.
 * @param {!string} name The resource name of the subscription.
 */
function deleteSubscription(name) {
  try {
    const operation = WorkspaceEvents.Subscriptions.remove(name);
    console.log(operation);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to delete subscription with error %s', err.message);
  }
}

कार्रवाई डाउनलोड करना

Google Workspace Events API के ज़्यादातर तरीके, लंबे समय तक चलने वाला ऑपरेशन दिखाते हैं. ऑपरेशन की स्थिति जानने के लिए, operations.get() तरीके का इस्तेमाल किया जा सकता है.

किसी ऑपरेशन के बारे में जानकारी पाने के लिए, Apps Script प्रोजेक्ट के कोड में यह फ़ंक्शन जोड़ें:

advanced/events.gs
/**
 * Gets details about an operation returned by one of the methods on the subscription
 * resource of the Google Workspace Events API.
 * For additional information, see the
 * [operations.get](https://developers.google.com/workspace/events/reference/rest/v1/operations/get)
 * method reference.
 * @param {!string} name The resource name of the operation.
 */
function getOperation(name) {
  try {
    const operation = WorkspaceEvents.Operations.get(name);
    console.log(operation);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to get operation with error %s', err.message);
  }
}

किसी ऑपरेशन का नाम पाने के लिए, Google Workspace Events API के किसी तरीके से मिले name फ़ील्ड की वैल्यू का इस्तेमाल करें. जैसे, subscriptions.create() या subscriptions.patch().