Cloud Identity Groups की बेहतर सेवा

ऐडवांस Cloud Identity Groups (CIG) सेवा की मदद से, Apps Script में CIG API का इस्तेमाल किया जा सकता है.

ध्यान दें: यह एक बेहतर सेवा है. इसका इस्तेमाल करने से पहले, इसे चालू करना ज़रूरी है.

रेफ़रंस

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

नमूना कोड

यहां दिए गए हेल्पर फ़ंक्शन, एपीआई के वर्शन 1 का इस्तेमाल करते हैं.

कोई समूह बनाएं

Google ग्रुप बनाने के लिए, नए ग्रुप रिसॉर्स के इंस्टेंस के साथ groups.create को कॉल करें. ग्रुप इंस्टेंस में, groupKey, parent, और label को cloudidentity.googleapis.com/groups.discussion_forum पर सेट करना ज़रूरी है. आपको initialGroupConfig पैरामीटर भी सेट करना होगा. इससे ग्रुप के शुरुआती मालिक के बारे में पता चलता है. इस पैरामीटर के लिए, इन वैल्यू का इस्तेमाल किया जा सकता है:

WITH_INITIAL_OWNER: अनुरोध करने वाले व्यक्ति को ग्रुप का मालिक बनाता है.

EMPTY: ऐसा ग्रुप बनाता है जिसमें कोई मालिक नहीं होता. इस वैल्यू का इस्तेमाल सिर्फ़ तब किया जा सकता है, जब आप Google Workspace के सुपर एडमिन या ग्रुप एडमिन हों. Google Workspace में भूमिकाओं के बारे में ज़्यादा जानकारी के लिए, पहले से तय एडमिन की भूमिकाएं देखें.

नीचे दिए गए उदाहरण में, ऐसा ग्रुप बनाने का तरीका बताया गया है जिसमें उपयोगकर्ता, ग्रुप का मालिक हो:

const groups = CloudIdentityGroups.Groups;

function createGroup(groupId, parentId, displayName) {
  const groupKey = { id: groupId };
  const group = {
    parent: "customerId/" + parentId,
    displayName: displayName,
    groupKey: groupKey,
    // Set the label to specify creation of a Google Group.
    labels: { "cloudidentity.googleapis.com/groups.discussion_forum": "" },
  };
  const optionalArgs = { initialGroupConfig: "WITH_INITIAL_OWNER" };

  try {
    const response = groups.create(group, optionalArgs);
    console.log(response);
  } catch (error) {
    console.error(error);
  }
}

कोई ग्रुप खोजना

Google ग्रुप खोजने के लिए, क्वेरी स्ट्रिंग के साथ groups.search को कॉल करें. सभी ग्रुप खोजने के लिए, label cloudidentity.googleapis.com/groups.discussion_forum डालें.

const groups = CloudIdentityGroups.Groups;

function searchGroup(customer_id) {
  const search_query = `parent=='customerId/${customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`;
  const search_group_request = groups.search({ query: search_query });
  console.log(JSON.stringify(search_group_request));
}

किसी ग्रुप में सदस्यता जोड़ना

ग्रुप बनाने के बाद, उसके लिए पैसे चुकाकर ली जाने वाली सदस्यताएं बनाई जा सकती हैं. इस तरीके के लिए, membership संसाधन और माता-पिता के संसाधन name स्ट्रिंग की ज़रूरत होती है. पिछली वैल्यू पाने के लिए, lookup तरीके से ग्रुप को खोजें.

यहां दिए गए हेल्पर तरीके में, किसी ग्रुप में सदस्यता जोड़ने का उदाहरण दिया गया है. expiryDetail एक वैकल्पिक फ़ील्ड है. इसे सदस्यता की समयसीमा सेट करने के लिए जोड़ा जा सकता है. preferredMemberKey की वैल्यू, सदस्य का ईमेल पता है.

const groups = CloudIdentityGroups.Groups;

function createMembership(namespace, groupId, memberKey) {
  try {
    // Given a group ID and namespace, retrieve the ID for parent group
    const groupLookupResponse = groups.lookup({
      'groupKey.id': groupId,
      'groupKey.namespace': namespace
    });
    const groupName = groupLookupResponse.name;

    // Create a membership object with a memberKey and a single role of type MEMBER
    const membership = {
      preferredMemberKey: { id: memberKey },
      roles: [
        {
          name: "MEMBER",
          expiryDetail: {
            expireTime: "2025-10-02T15:01:23Z",
          },
        },
      ],
    };

    // Create a membership using the ID for the parent group and a membership object
    const response = groups.Memberships.create(membership, groupName);
    console.log(JSON.stringify(response));
  } catch (e) {
    console.error(e);
  }
}

पैसे चुकाकर बने सदस्यों से सदस्यताएं पाना

किसी सदस्य के माता-पिता को खोजने के लिए, groups.memberships.searchDirectGroups तरीका अपनाएं.

यहां दिया गया हेल्पर तरीका, किसी सदस्य की सीधे तौर पर ली गई सदस्यताओं को दोहराने का उदाहरण दिखाता है.

const groups = CloudIdentityGroups.Groups;

 function searchMemberMemberships(memberId, pageSize) {
  try {
    let memberships = [];
    let nextPageToken = '';
    const withinParent = 'groups/-';  // This parameter sets the scope as "all groups"

    do {
      // Get page of memberships
      const queryParams = {
        query: `member_key_id == \'${memberId}\'`,
        page_size: pageSize,
        page_token: nextPageToken,
      };
      const response = groups.Memberships.searchDirectGroups(withinParent, queryParams);
      memberships = memberships.concat(response.memberships);

      // Set up next page
      nextPageToken = response.nextPageToken;
    } while (nextPageToken);

    return memberships;
  } catch(e) {
    console.error(e);
  }
}

किसी ग्रुप से सदस्यताएं पाना

किसी ग्रुप के सदस्यों की सूची देखने के लिए, groups.memberships.list तरीका अपनाएं.

groupId: उस ग्रुप का अंकों वाला आईडी जिसकी सदस्यों की सूची बनानी है. किसी एक ग्रुप का आईडी ढूंढने के लिए, groups.lookup तरीके का इस्तेमाल करें. किसी ग्राहक या नेमस्पेस के तहत सभी ग्रुप आईडी देखने के लिए, groups.list तरीका इस्तेमाल करें.

const groups = CloudIdentityGroups.Groups;

function listGroupMemberships(groupId, pageSize) {
  try {
    let membershipList = [];
    let nextPageToken = '';

    // Get group name
    const groupName = groups.lookup({'groupKey.id': groupId}).name;

    do {
      // Get page of memberships
      const queryParams = {
        pageSize: pageSize,
        pageToken: nextPageToken
      }
      const response = groups.Memberships.list(groupName, queryParams);
      membershipList = membershipList.concat(response.memberships);

      // Set up next page
      nextPageToken = response.nextPageToken;
    } while(nextPageToken);

    return membershipList;
  } catch (error) {
    console.error(error);
  }
}