Class GroupsApp

GroupsApp

本課程提供 Google 網路論壇資訊的存取權。可用來查詢資訊,例如 做為群組電子郵件地址,或是使用者為直接成員的群組清單。

以下範例顯示目前使用者參與的群組數量:

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

屬性

屬性類型說明
RoleRole

方法

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

內容詳盡的說明文件

getGroupByEmail(email)

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

以下範例會依照電子郵件地址擷取群組,並輸出目前 位使用者為成員。在開始執行之前,請將範例電子郵件地址替換為實際群組的電子郵件地址。

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
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.");
}

參數

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

回攻員

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,B 本身是另一個群組的成員,則 您「直接」訂閱 A 群組。即使您收到了訊息副本 傳送給「家長」A 群組,但您實際上並未訂閱該群組。

您可以用 Group.getRole(email) 判斷自己是現有還是待處理狀態 群組成員。

回攻員

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

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

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