Class GroupsApp

GroupsApp

本課程可讓您存取 Google 網路論壇資訊。可用於查詢群組電子郵件地址，或使用者為直接成員的群組清單等資訊。

以下範例顯示目前使用者加入的群組數量：

var groups = GroupsApp.getGroups();
Logger.log('You belong to ' + groups.length + ' groups.');

屬性

屬性	類型	說明
Role	Role

方法

方法	傳回類型	簡短說明
getGroupByEmail(email)	Group	擷取包含指定電子郵件地址的群組。
getGroups()	Group[]	擷取您直接成員 (或待審核的成員) 的所有群組。

內容詳盡的說明文件

getGroupByEmail(email)

擷取包含指定電子郵件地址的群組。如果群組不存在，或是您沒有檢視權限，則會擲回例外狀況。

以下範例會透過電子郵件地址取得群組，並輸出目前使用者是否為成員。在開始執行前，請將範例電子郵件地址替換為實際群組的電子郵件地址。

var group = GroupsApp.getGroupByEmail("[e-mail]");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  Logger.log("You are a member of this group.");
}
else {
  Logger.log("You are not a member of this group.");
}

參數

名稱	類型	說明
email	String	要擷取的群組電子郵件地址。

回攻員

Group：具有指定電子郵件地址的群組。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

---

getGroups()

擷取您直接成員 (或待審核的成員) 的所有群組。如果您不在任何群組中，則這份清單會是空白清單。如果群組不存在，或是您沒有檢視權限，則會擲回例外狀況。

以下範例說明如何列印使用者所屬每個群組的電子郵件地址：

function showMyGroups() {
  var groups = GroupsApp.getGroups();
  var str = 'You are in ' + groups.length + ' groups: ';
  for (var i = 0; i < groups.length; i++) {
    var group = groups[i];
    str = str + group.getEmail() + ' ';
  }
  Logger.log(str);
}

請注意，如果您是某個群組 B 的成員，而該群組本身隸屬於另一個群組 A，則您「間接」訂閱了 A 群組。雖然收到傳送給「父項」群組 A 的訊息副本，但實際上並未訂閱該群組。

您可以使用 Group.getRole(email) 來判斷在傳回的群組中是現有或待核准的成員。

回攻員

Group[]：使用者是直接成員的群組清單。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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