ग्रुप ऑब्जेक्ट, जिसके सदस्यों और ग्रुप के सदस्यों की भूमिकाओं के बारे में क्वेरी की जा सकती है.
यहां एक उदाहरण दिया गया है जो ग्रुप के सदस्यों को दिखाता है. इसे चलाने से पहले, अपने डोमेन के ईमेल पते के ईमेल पते को बदलें.
function listGroupMembers() { var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); console.log(group.getEmail() + ':'); var users = group.getUsers(); for (var i = 0; i < users.length; i++) { var 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() { var groups = GroupsApp.getGroups(); for (var i = 0; i < groups.length; i++) { console.log(groups[i].getEmail()); } }
रिटर्न
String
— ग्रुप का ईमेल पता.
अनुमति देना
इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या ज़्यादा स्कोप से अनुमति देने की ज़रूरत होती है:
-
https://www.googleapis.com/auth/groups
getGroups()
ग्रुप के डायरेक्ट चाइल्ड ग्रुप को फिर से हासिल करता है. अगर आपको ग्रुप के सदस्यों की सूची देखने की अनुमति नहीं है, तो यह एक अपवाद है.
इस तरीके के अलावा, आप किसी डोमेन में ग्रुप के सदस्यों को वापस लाने के लिए, एडमिन SDK की डायरेक्ट्री की बेहतर सेवा का इस्तेमाल कर सकते हैं.
function listGroupMembers() { var GROUP_EMAIL = "example@googlegroups.com"; var group = GroupsApp.getGroupByEmail(GROUP_EMAIL); var childGroups = group.getGroups(); console.log("Group " + GROUP_EMAIL + " has " + childGroups.length + " groups:"); for (var i = 0; i < childGroups.length; i++) { var childGroup = childGroups[i]; console.log(childGroup.getEmail()); } }
रिटर्न
Group[]
— ग्रुप के सभी डायरेक्ट चाइल्ड ग्रुप.
अनुमति देना
इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या ज़्यादा स्कोप से अनुमति देने की ज़रूरत होती है:
-
https://www.googleapis.com/auth/groups
getRole(email)
ग्रुप के संदर्भ में उपयोगकर्ता की भूमिका वापस हासिल करता है. ऐसे उपयोगकर्ता जो किसी ग्रुप में सीधे तौर पर शामिल होते हैं, उस ग्रुप में उनकी सिर्फ़ एक भूमिका होती है. अगर उपयोगकर्ता किसी ग्रुप का सदस्य न हो या आपको ग्रुप की सदस्यों की सूची देखने की अनुमति न हो, तो अपवाद की अनुमति दी जाती है.
इस उदाहरण में ग्रुप के मालिकों की सूची दी गई है:
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var users = group.getUsers(); console.log('These are the group owners:'); for (var i = 0; i < users.length; i++) { var user = users[i]; if (group.getRole(user.getEmail()) == GroupsApp.Role.OWNER) { console.log(user.getEmail()); } }
पैरामीटर
नाम | Type | ब्यौरा |
---|---|---|
email | String | उपयोगकर्ता का ईमेल पता. |
रिटर्न
Role
— ग्रुप में उस उपयोगकर्ता की भूमिका.
अनुमति देना
इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या ज़्यादा स्कोप से अनुमति देने की ज़रूरत होती है:
-
https://www.googleapis.com/auth/groups
getRole(user)
ग्रुप के संदर्भ में उपयोगकर्ता की भूमिका वापस हासिल करता है. ऐसे उपयोगकर्ता जो किसी ग्रुप में सीधे तौर पर शामिल होते हैं, उस ग्रुप में उनकी सिर्फ़ एक भूमिका होती है. अगर उपयोगकर्ता किसी ग्रुप का सदस्य न हो या आपको ग्रुप की सदस्यों की सूची देखने की अनुमति न हो, तो अपवाद की अनुमति दी जाती है.
इस उदाहरण में ग्रुप के मालिकों की सूची दी गई है:
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var users = group.getUsers(); console.log('These are the group owners:'); for (var i = 0; i < users.length; i++) { var user = users[i]; if (group.getRole(user) == GroupsApp.Role.OWNER) { console.log(user.getEmail()); } }
पैरामीटर
नाम | Type | ब्यौरा |
---|---|---|
user | User | वह उपयोगकर्ता जिसकी भूमिका को फिर से हासिल करना है. |
रिटर्न
Role
— ग्रुप में उस उपयोगकर्ता की भूमिका.
अनुमति देना
इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या ज़्यादा स्कोप से अनुमति देने की ज़रूरत होती है:
-
https://www.googleapis.com/auth/groups
इन्हें भी देखें
getRoles(users)
ग्रुप के संदर्भ में उपयोगकर्ताओं की भूमिकाएं वापस लाता है. ऐसे उपयोगकर्ता जो किसी ग्रुप में सीधे तौर पर शामिल होते हैं, उस ग्रुप में उनकी सिर्फ़ एक भूमिका होती है. अगर कोई उपयोगकर्ता उस ग्रुप का सदस्य न हो या आपको उस ग्रुप की सदस्यों की सूची देखने की अनुमति न हो, तो अपवाद की अनुमति दी जाती है.
इस उदाहरण में ग्रुप के मालिकों की सूची दी गई है:
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var users = group.getUsers(); var roles = group.getRoles(users); console.log('These are the group owners:'); for (var i = 0; i < users.length; i++) { if (roles[i] == GroupsApp.Role.OWNER) { console.log(users[i].getEmail()); } }
पैरामीटर
नाम | Type | ब्यौरा |
---|---|---|
users | User[] | वे उपयोगकर्ता जिनकी भूमिकाओं का अनुरोध किया गया है. |
रिटर्न
Role[]
— ग्रुप में उन उपयोगकर्ताओं की भूमिकाएं.
अनुमति देना
इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या ज़्यादा स्कोप से अनुमति देने की ज़रूरत होती है:
-
https://www.googleapis.com/auth/groups
getUsers()
ग्रुप के उन सदस्यों को सीधे तौर पर ऐक्सेस करता है जिनके पास Google खाता है. अगर आपको ग्रुप के सदस्यों की सूची या सदस्यों के ईमेल देखने की अनुमति नहीं है, तो यह अपवाद है.
ध्यान दें: अगर आप ऐसे ग्रुप B के सदस्य हैं जो खुद किसी दूसरे ग्रुप A का सदस्य है, तो आपको ग्रुप A की सदस्यता अप्रत्यक्ष तौर पर मिली है. हालाँकि, आपको इस पर भेजे गए मैसेज की कॉपी मिलती हैं, लेकिन आप पैरंट ग्रुप A के सदस्य नहीं हैं.
यहां एक उदाहरण दिया गया है जो ग्रुप के सदस्यों को दिखाता है. इसे चलाने से पहले, अपने डोमेन के ईमेल पते के ईमेल पते को बदलें.
function listGroupMembers() { var GROUP_EMAIL = "example@googlegroups.com"; var group = GroupsApp.getGroupByEmail(GROUP_EMAIL); var users = group.getUsers(); console.log("Group " + GROUP_EMAIL + " has " + users.length + " members:"); for (var i = 0; i < users.length; i++) { var user = users[i]; console.log(user.getEmail()); } }इसके अलावा, आपके पास एडमिन SDK डायरेक्ट्री की बेहतर सेवा का इस्तेमाल करके, किसी डोमेन के ग्रुप के सदस्यों को वापस लाने का विकल्प भी होता है.
रिटर्न
User[]
— ग्रुप के सभी सीधे तौर पर सदस्य.
अनुमति देना
इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या ज़्यादा स्कोप से अनुमति देने की ज़रूरत होती है:
-
https://www.googleapis.com/auth/groups
hasGroup(group)
यह जांच करता है कि कोई ग्रुप, सीधे तौर पर इस ग्रुप का सदस्य है या नहीं. अगर जांचे गए ग्रुप को इस ग्रुप के नीचे एक से ज़्यादा लेवल पर नेस्ट किया गया है, तो यह तरीका true
नहीं दिखाता. अगर आपको ग्रुप के सदस्यों की सूची
देखने की अनुमति नहीं है, तो यह एक अपवाद होगा.
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var childGroup = GroupsApp.getGroupByEmail("childgroup@googlegroups.com"); if (group.hasGroup(childGroup)) { console.log("childgroup@googlegroups.com is a child group"); }
पैरामीटर
नाम | Type | ब्यौरा |
---|---|---|
group | Group | वह ग्रुप जिसकी सदस्यता की जांच करनी है. |
रिटर्न
Boolean
— true
, अगर वह इस ग्रुप का चाइल्ड ग्रुप है; नहीं तो false
.
अनुमति देना
इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या ज़्यादा स्कोप से अनुमति देने की ज़रूरत होती है:
-
https://www.googleapis.com/auth/groups
hasGroup(email)
यह जांच करता है कि कोई ग्रुप, सीधे तौर पर इस ग्रुप का सदस्य है या नहीं. अगर जांचे गए ग्रुप को इस ग्रुप के नीचे एक से ज़्यादा लेवल पर नेस्ट किया गया है, तो यह तरीका true
नहीं दिखाता. अगर आपको ग्रुप के सदस्यों की सूची
देखने की अनुमति नहीं है, तो यह एक अपवाद होगा.
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); if (group.hasGroup("childgroup@googlegroups.com")) { console.log("childgroup@googlegroups.com is a child group"); }
पैरामीटर
नाम | Type | ब्यौरा |
---|---|---|
email | String | किसी ग्रुप का ईमेल पता. |
रिटर्न
Boolean
— true
, अगर वह इस ग्रुप का चाइल्ड ग्रुप है; नहीं तो false
.
अनुमति देना
इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या ज़्यादा स्कोप से अनुमति देने की ज़रूरत होती है:
-
https://www.googleapis.com/auth/groups
hasUser(email)
यह जांच करता है कि कोई उपयोगकर्ता ग्रुप का सदस्य है या नहीं. अगर आपको ग्रुप के सदस्यों की सूची देखने की अनुमति नहीं है, तो यह एक अपवाद है.
यहां दिए गए उदाहरण से पता चलता है कि मौजूदा उपयोगकर्ता किसी ग्रुप का सदस्य है या नहीं:
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var currentUser = Session.getActiveUser(); if (group.hasUser(currentUser.getEmail())) { console.log("You are a member"); }
पैरामीटर
नाम | Type | ब्यौरा |
---|---|---|
email | String | उपयोगकर्ता का ईमेल पता. |
रिटर्न
Boolean
— true
, अगर वह उपयोगकर्ता ग्रुप का सदस्य है; अगर ऐसा नहीं है, तो false
.
अनुमति देना
इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या ज़्यादा स्कोप से अनुमति देने की ज़रूरत होती है:
-
https://www.googleapis.com/auth/groups
hasUser(user)
यह जांच करता है कि कोई उपयोगकर्ता ग्रुप का सदस्य है या नहीं. अगर आपको ग्रुप के सदस्यों की सूची देखने की अनुमति नहीं है, तो यह एक अपवाद है.
यहां दिए गए उदाहरण से पता चलता है कि मौजूदा उपयोगकर्ता किसी ग्रुप का सदस्य है या नहीं:
var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); var currentUser = Session.getActiveUser(); if (group.hasUser(currentUser)) { console.log("You are a member"); }
पैरामीटर
नाम | Type | ब्यौरा |
---|---|---|
user | User | वह उपयोगकर्ता जिसकी सदस्यता की जांच करनी है. |
रिटर्न
Boolean
— true
, अगर वह उपयोगकर्ता ग्रुप का सदस्य है; अगर ऐसा नहीं है, तो false
.
अनुमति देना
इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या ज़्यादा स्कोप से अनुमति देने की ज़रूरत होती है:
-
https://www.googleapis.com/auth/groups