Class Group

ग्रुप

ऐसा ग्रुप ऑब्जेक्ट जिसके सदस्यों और ग्रुप में उन सदस्यों की भूमिकाओं के बारे में क्वेरी की जा सकती है.

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

function listGroupMembers() {
  const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
  console.log(`${group.getEmail()}:`);
  const users = group.getUsers();
  for (let i = 0; i < users.length; i++) {
    const user = users[i];
    console.log(user.getEmail());
  }
}

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
getEmail()Stringइस ग्रुप का ईमेल पता पाता है.
getGroups()Group[]ग्रुप के डायरेक्ट चाइल्ड ग्रुप को वापस लाता है.
getRole(email)Roleग्रुप के संदर्भ में, उपयोगकर्ता की भूमिका दिखाता है.
getRole(user)Roleग्रुप के संदर्भ में, उपयोगकर्ता की भूमिका दिखाता है.
getRoles(users)Role[]ग्रुप के संदर्भ में, उपयोगकर्ताओं की भूमिकाएं दिखाता है.
getUsers()User[]ग्रुप के उन सदस्यों की जानकारी मिलती है जिनके पास Google खाता है.
hasGroup(group)Booleanयह जांच करता है कि कोई ग्रुप, इस ग्रुप का सीधा सदस्य है या नहीं.
hasGroup(email)Booleanयह जांच करता है कि कोई ग्रुप, इस ग्रुप का सीधा सदस्य है या नहीं.
hasUser(email)Booleanयह जांच करता है कि कोई उपयोगकर्ता, ग्रुप का डायरेक्ट सदस्य है या नहीं.
hasUser(user)Booleanयह जांच करता है कि कोई उपयोगकर्ता, ग्रुप का डायरेक्ट सदस्य है या नहीं.

ज़्यादा जानकारी वाला दस्तावेज़

getEmail()

इस ग्रुप का ईमेल पता पाता है.

इस उदाहरण में, उन सभी ग्रुप के ईमेल पते की सूची दी गई है जिनका उपयोगकर्ता सदस्य है.

function listMyGroupEmails() {
  const groups = GroupsApp.getGroups();
  for (let i = 0; i < groups.length; i++) {
    console.log(groups[i].getEmail());
  }
}

वापसी का टिकट

String — ग्रुप का ईमेल पता.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/groups

getGroups()

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

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

function listGroupMembers() {
  const GROUP_EMAIL = 'example@googlegroups.com';
  const group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  const childGroups = group.getGroups();
  console.log(`Group ${GROUP_EMAIL} has ${childGroups.length} groups:`);
  for (let i = 0; i < childGroups.length; i++) {
    const childGroup = childGroups[i];
    console.log(childGroup.getEmail());
  }
}

वापसी का टिकट

Group[] — ग्रुप के सभी डायरेक्ट चाइल्ड ग्रुप.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/groups

getRole(email)

ग्रुप के संदर्भ में, उपयोगकर्ता की भूमिका दिखाता है. किसी ग्रुप का डायरेक्ट सदस्य, उस ग्रुप में सिर्फ़ एक भूमिका निभा सकता है. अगर उपयोगकर्ता ग्रुप का सदस्य नहीं है या आपके पास ग्रुप के सदस्यों की सूची देखने की अनुमति नहीं है, तो यह एक्सप्शन दिखाता है.

इस उदाहरण में, किसी ग्रुप के मालिकों की सूची दी गई है:

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const users = group.getUsers();
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  const user = users[i];
  if (group.getRole(user.getEmail()) === GroupsApp.Role.OWNER) {
    console.log(user.getEmail());
  }
}

पैरामीटर

नामटाइपब्यौरा
emailStringउपयोगकर्ता का ईमेल पता.

वापसी का टिकट

Role — ग्रुप में उस उपयोगकर्ता की भूमिका.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/groups

getRole(user)

ग्रुप के संदर्भ में, उपयोगकर्ता की भूमिका दिखाता है. किसी ग्रुप का डायरेक्ट सदस्य, उस ग्रुप में सिर्फ़ एक भूमिका निभा सकता है. अगर उपयोगकर्ता ग्रुप का सदस्य नहीं है या आपके पास ग्रुप के सदस्यों की सूची देखने की अनुमति नहीं है, तो यह एक्सप्शन दिखाता है.

इस उदाहरण में, किसी ग्रुप के मालिकों की सूची दी गई है:

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const users = group.getUsers();
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  const user = users[i];
  if (group.getRole(user) === GroupsApp.Role.OWNER) {
    console.log(user.getEmail());
  }
}

पैरामीटर

नामटाइपब्यौरा
userUserवह उपयोगकर्ता जिसकी भूमिका वापस लानी है.

वापसी का टिकट

Role — ग्रुप में उस उपयोगकर्ता की भूमिका.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/groups

इन्हें भी देखें


getRoles(users)

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

इस उदाहरण में, किसी ग्रुप के मालिकों की सूची दी गई है:

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const users = group.getUsers();
const roles = group.getRoles(users);
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  if (roles[i] === GroupsApp.Role.OWNER) {
    console.log(users[i].getEmail());
  }
}

पैरामीटर

नामटाइपब्यौरा
usersUser[]वे उपयोगकर्ता जिनकी भूमिकाओं के लिए अनुरोध किया गया है.

वापसी का टिकट

Role[] — ग्रुप में उन उपयोगकर्ताओं की भूमिकाएं.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/groups

getUsers()

ग्रुप के उन सदस्यों और प्रतिबंधित सदस्यों की जानकारी मिलती है जिनका Google खाता मौजूद है. अगर आपके पास ग्रुप के सदस्यों की सूची या सदस्यों के ईमेल देखने की अनुमति नहीं है, तो यह एक अपवाद दिखाता है.

ध्यान दें: अगर आप ग्रुप B के सदस्य हैं और ग्रुप B, ग्रुप A का सदस्य है, तो इसका मतलब है कि आपने अप्रत्यक्ष रूप से ग्रुप A की सदस्यता ली है. हालांकि, आपको उसमें भेजे गए मैसेज की कॉपी मिलती हैं, लेकिन आपके पास पैरंट ग्रुप A की सदस्यता नहीं है.

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

function listGroupMembers() {
  const GROUP_EMAIL = 'example@googlegroups.com';
  const group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  const users = group.getUsers();
  console.log(`Group ${GROUP_EMAIL} has ${users.length} members:`);
  for (let i = 0; i < users.length; i++) {
    const user = users[i];
    console.log(user.getEmail());
  }
}
इस तरीके के अलावा, एडमिन SDK डायरेक्ट्री की बेहतर सेवा का इस्तेमाल करके, किसी डोमेन में ग्रुप के सदस्यों की जानकारी हासिल की जा सकती है.

वापसी का टिकट

User[] — ग्रुप के सभी डायरेक्ट सदस्य.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/groups

hasGroup(group)

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const childGroup = GroupsApp.getGroupByEmail('childgroup@googlegroups.com');
if (group.hasGroup(childGroup)) {
  console.log('childgroup@googlegroups.com is a child group');
}

पैरामीटर

नामटाइपब्यौरा
groupGroupवह ग्रुप जिसकी सदस्यता की जांच करनी है.

वापसी का टिकट

Booleantrue, अगर वह ग्रुप इस ग्रुप का चाइल्ड ग्रुप है; false, अगर ऐसा नहीं है.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/groups

hasGroup(email)

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
if (group.hasGroup('childgroup@googlegroups.com')) {
  console.log('childgroup@googlegroups.com is a child group');
}

पैरामीटर

नामटाइपब्यौरा
emailStringग्रुप का ईमेल पता.

वापसी का टिकट

Booleantrue, अगर वह ग्रुप इस ग्रुप का चाइल्ड ग्रुप है; false, अगर ऐसा नहीं है.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/groups

hasUser(email)

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

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const currentUser = Session.getActiveUser();
if (group.hasUser(currentUser.getEmail())) {
  console.log('You are a member');
}

पैरामीटर

नामटाइपब्यौरा
emailStringउपयोगकर्ता का ईमेल पता.

वापसी का टिकट

Boolean — अगर वह उपयोगकर्ता ग्रुप का सदस्य है, तो true; अगर नहीं है, तो false.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/groups

hasUser(user)

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

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  console.log('You are a member');
}

पैरामीटर

नामटाइपब्यौरा
userUserवह उपयोगकर्ता जिसकी सदस्यता की जांच करनी है.

वापसी का टिकट

Boolean — अगर वह उपयोगकर्ता ग्रुप का सदस्य है, तो true; अगर नहीं है, तो false.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/groups