Class GroupsApp

網路論壇應用程式

這個類別可讓您存取 Google 群組資訊。可用於查詢群組電子郵件地址等資訊，或是使用者直接加入的群組清單。

以下範例說明目前使用者所屬群組的人數：

const groups = GroupsApp.getGroups();
Logger.log(`You belong to ${groups.length} groups.`);

屬性

屬性	類型	說明
Role	Role

方法

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

內容詳盡的說明文件

getGroupByEmail(email)

擷取具有指定電子郵件地址的群組。如果群組不存在，或是您沒有查看該群組的權限，系統會擲回例外狀況。

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

const group = GroupsApp.getGroupByEmail('[e-mail]');
const 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() {
  const groups = GroupsApp.getGroups();
  let str = `You are in ${groups.length} groups: `;
  for (let i = 0; i < groups.length; i++) {
    const group = groups[i];
    str = `${str + group.getEmail()} `;
  }
  Logger.log(str);
}

請注意，如果您是群組 B 的成員，而群組 B 本身是群組 A 的成員，那麼您就會間接訂閱群組 A。即使您收到傳送至「父」群組 A 的郵件副本，但您實際上並未訂閱該群組。

您可以使用 Group.getRole(email) 判斷自己是否為傳回群組的現有或待處理成員。

回攻員

Group[]：使用者直接加入的群組清單。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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