Groups

Groups 資源是 Groups Settings API 的根資料類別。每個 Groups 資源都與一組設定相關聯。

詳情請參閱這項資源的方法清單。

資源表示法

群組資源包含中繼資料,其中包含指定群組設定的摘要。這些設定可以管理群組的存取權、通知、封存討論、訊息審核,以及自訂帳戶的使用者群組。

根據預設,Groups 資源資料會以 atom+XML 資料格式傳回。

Atom

<entry xmlns="http://www.w3.org/2005/Atom" xmlns:apps="http://schemas.google.com/apps/2006" xmlns:gd="http://schemas.google.com/g/2005">
  <id>
    string
  </id>
  <title>
    Groups Resource Entry
  </title>
  <content type="text">
    string
  </content>
  <author>
    <name>
      Google
    </name>
  </author>
  <apps:email>
    string
  </apps:email>
  <apps:name>
    string
  </apps:name>
  <apps:description>
    string
  </apps:description>
  <apps:whoCanJoin>
    string
  </apps:whoCanJoin>
  <apps:whoCanViewMembership>
    string
  </apps:whoCanViewMembership>
  <apps:whoCanViewGroup>
    string
  </apps:whoCanViewGroup>
  <apps:whoCanInvite>
    string
  </apps:whoCanInvite>
  <apps:whoCanAdd>
    string
  </apps:whoCanAdd>
  <apps:allowExternalMembers>
    string
  </apps:allowExternalMembers>
  <apps:whoCanPostMessage>
    string
  </apps:whoCanPostMessage>
  <apps:allowWebPosting>
    string
  </apps:allowWebPosting>
  <apps:primaryLanguage>
    string
  </apps:primaryLanguage>
  <apps:maxMessageBytes>
    integer
  </apps:maxMessageBytes>
  <apps:isArchived>
    string
  </apps:isArchived>
  <apps:archiveOnly>
    string
  </apps:archiveOnly>
  <apps:messageModerationLevel>
    string
  </apps:messageModerationLevel>
  <apps:spamModerationLevel>
    string
  </apps:spamModerationLevel>
  <apps:replyTo>
    string
  </apps:replyTo>
  <apps:customReplyTo>
    string
  </apps:customReplyTo>
  <apps:includeCustomFooter>
    string
  </apps:includeCustomFooter>
  <apps:customFooterText>
    string
  </apps:customFooterText>
  <apps:sendMessageDenyNotification>
    string
  </apps:sendMessageDenyNotification>
  <apps:defaultMessageDenyNotificationText>
    string
  </apps:defaultMessageDenyNotificationText>
  <apps:showInGroupDirectory>
    string
  </apps:showInGroupDirectory>
  <apps:allowGoogleCommunication>
    string
  </apps:allowGoogleCommunication>
  <apps:membersCanPostAsTheGroup>
    string
  </apps:membersCanPostAsTheGroup>
  <apps:messageDisplayFont>
    string
  </apps:messageDisplayFont>
  <apps:includeInGlobalAddressList>
    string
  </apps:includeInGlobalAddressList>
  <apps:whoCanLeaveGroup>
    string
  </apps:whoCanLeaveGroup>
  <apps:whoCanContactOwner>
    string
  </apps:whoCanContactOwner>
  <apps:whoCanAddReferences>
    string
  </apps:whoCanAddReferences>
  <apps:whoCanAssignTopics>
    string
  </apps:whoCanAssignTopics>
  <apps:whoCanUnassignTopic>
    string
  </apps:whoCanUnassignTopic>
  <apps:whoCanTakeTopics>
    string
  </apps:whoCanTakeTopics>
  <apps:whoCanMarkDuplicate>
    string
  </apps:whoCanMarkDuplicate>
  <apps:whoCanMarkNoResponseNeeded>
    string
  </apps:whoCanMarkNoResponseNeeded>
  <apps:whoCanMarkFavoriteReplyOnAnyTopic>
    string
  </apps:whoCanMarkFavoriteReplyOnAnyTopic>
  <apps:whoCanMarkFavoriteReplyOnOwnTopic>
    string
  </apps:whoCanMarkFavoriteReplyOnOwnTopic>
  <apps:whoCanUnmarkFavoriteReplyOnAnyTopic>
    string
  </apps:whoCanUnmarkFavoriteReplyOnAnyTopic>
  <apps:whoCanEnterFreeFormTags>
    string
  </apps:whoCanEnterFreeFormTags>
  <apps:whoCanModifyTagsAndCategories>
    string
  </apps:whoCanModifyTagsAndCategories>
  <apps:favoriteRepliesOnTop>
    string
  </apps:favoriteRepliesOnTop>
  <apps:whoCanApproveMembers>
    string
  </apps:whoCanApproveMembers>
  <apps:whoCanBanUsers>
    string
  </apps:whoCanBanUsers>
  <apps:whoCanModifyMembers>
    string
  </apps:whoCanModifyMembers>
  <apps:whoCanApproveMessages>
    string
  </apps:whoCanApproveMessages>
  <apps:whoCanDeleteAnyPost>
    string
  </apps:whoCanDeleteAnyPost>
  <apps:whoCanDeleteTopics>
    string
  </apps:whoCanDeleteTopics>
  <apps:whoCanLockTopics>
    string
  </apps:whoCanLockTopics>
  <apps:whoCanMoveTopicsIn>
    string
  </apps:whoCanMoveTopicsIn>
  <apps:whoCanMoveTopicsOut>
    string
  </apps:whoCanMoveTopicsOut>
  <apps:whoCanPostAnnouncements>
    string
  </apps:whoCanPostAnnouncements>
  <apps:whoCanHideAbuse>
    string
  </apps:whoCanHideAbuse>
  <apps:whoCanMakeTopicsSticky>
    string
  </apps:whoCanMakeTopicsSticky>
  <apps:whoCanModerateMembers>
    string
  </apps:whoCanModerateMembers>
  <apps:whoCanModerateContent>
    string
  </apps:whoCanModerateContent>
  <apps:whoCanAssistContent>
    string
  </apps:whoCanAssistContent>
  <apps:customRolesEnabledForSettingsToBeMerged>
    string
  </apps:customRolesEnabledForSettingsToBeMerged>
  <apps:enableCollaborativeInbox>
    string
  </apps:enableCollaborativeInbox>
  <apps:whoCanDiscoverGroup>
    string
  </apps:whoCanDiscoverGroup>
  <apps:defaultSender>
    string
  </apps:defaultSender>
</entry>

下表列出群組資源:

屬性名稱 說明
entry object 群組資源
entry/xmlns string Atom 格式的結構定義
entry/xmlns:apps string Google Workspace I/O 格式的結構定義
entry/xmlns:gd string Google Data 通訊協定的結構定義
entry/id object 群組資源的專屬 ID
entry/title object API 的 Atom 項目標題,即 Groups Resource Entry
entry/content object Atom 項目的內容類型
entry/content/type string Atom 動態饋給的內容類型,text
entry/author object Atom 項目的作者標記
entry/author/name object 作者姓名,也就是 Google
entry/apps:email object

群組的電子郵件地址。您可以使用 Directory API 更新這個屬性。

entry/apps:name object 群組名稱。群組名稱的長度上限為 75 個半形字元。
entry/apps:description object 群組的說明。如果您尚未輸入群組說明,這個屬性值可以是空白字串。如果輸入,群組說明的長度上限為 4,096 個字元。
entry/apps:whoCanJoin object 加入群組的權限。可能的值包括:
  • ANYONE_CAN_JOIN:任何網際網路使用者 (不論是否屬於您的網域) 皆可加入群組。
  • ALL_IN_DOMAIN_CAN_JOIN:帳戶網域中的任何人都可以加入。包括擁有多個網域的帳戶。
  • INVITED_CAN_JOIN:您可以邀請候選人加入。
  • CAN_REQUEST_TO_JOIN:非會員可以要求加入。
entry/apps:whoCanViewMembership object 查看成員資格的權限。可能的值包括:
  • ALL_IN_DOMAIN_CAN_VIEW:帳戶中的所有使用者都可以查看群組成員清單。

    如果群組已有外部成員,這些成員仍可傳送電子郵件給這個群組。

  • ALL_MEMBERS_CAN_VIEW:群組成員可以查看群組成員名單。
  • ALL_MANAGERS_CAN_VIEW:群組管理員可以查看群組成員清單。
entry/apps:whoCanViewGroup object 查看群組訊息的權限。可能的值包括:
  • ANYONE_CAN_VIEW:任何網路使用者都可以查看群組訊息。
  • ALL_IN_DOMAIN_CAN_VIEW:帳戶中的任何人都能查看這個群組的訊息。
  • ALL_MEMBERS_CAN_VIEW:所有群組成員都可以查看群組訊息。
  • ALL_MANAGERS_CAN_VIEW:任何群組管理員都能查看這個群組的訊息。
  • ALL_OWNERS_CAN_VIEW:所有群組擁有者都能查看這個群組的訊息。
entry/apps:whoCanInvite object 已淘汰。這會合併至 whoCanModerateMembers 設定。邀請新成員的權限。可能的值包括:
  • ALL_MEMBERS_CAN_INVITE:管理員和成員可以邀請新成員候選人。
  • ALL_MANAGERS_CAN_INVITE:只有管理員可以邀請新成員。包括群組擁有者。
  • ALL_OWNERS_CAN_INVITE:只有擁有者可以邀請新成員。
  • NONE_CAN_INVITE:任何人都無法邀請新成員候選人。
entry/apps:whoCanAdd object 已淘汰。這會合併至 whoCanModerateMembers 設定。直接新增成員的權限。可能的值包括:
  • ALL_MEMBERS_CAN_ADD:管理員和成員可以直接新增成員。
  • ALL_MANAGERS_CAN_ADD:只有管理員可以直接新增成員。包括群組擁有者。
  • ALL_OWNERS_CAN_ADD:只有擁有者可以直接新增成員。
  • NONE_CAN_ADD:任何人都無法直接新增成員。
entry/apps:allowExternalMembers object 識別機構外部成員能否加入群組。可能的值包括:
  • true:機構外的 Google Workspace 使用者能夠成為這個群組的成員。
  • false:不屬於機構的使用者不得成為這個群組的成員。
entry/apps:whoCanPostMessage object 張貼訊息的權限。可能的值包括:
  • NONE_CAN_POST:群組已停用並封存。任何人都無法向這個群組張貼訊息。
    • 如果 archiveOnly 為 false,將 whoCanPostMessage 更新為 NONE_CAN_POST 會導致錯誤。
    • 如果 archiveOnly 從 true 還原為 falsewhoCanPostMessages 會設為 ALL_MANAGERS_CAN_POST
  • ALL_MANAGERS_CAN_POST:管理員 (包括版主) 可以張貼訊息。
  • ALL_MEMBERS_CAN_POST:任何群組成員都可以留言。
  • ALL_OWNERS_CAN_POST:只有群組擁有者可以張貼訊息。
  • ALL_IN_DOMAIN_CAN_POST:帳戶中的任何人都可以張貼訊息。
  • ANYONE_CAN_POST:任何網際網路使用者 (不限於您的帳戶) 都能存取您的 Google 群組服務,並張貼訊息。
entry/apps:allowWebPosting object 允許透過網站張貼。可能的值包括:
  • true:允許任何成員在群組論壇中發布內容。
  • false:成員只會使用 Gmail 與群組溝通交流。
entry/apps:primaryLanguage object 群組的主要語言。請使用「支援的語言」表格中的語言標記。
entry/apps:maxMessageBytes object 已淘汰。郵件大小上限為 25 MB。
entry/apps:isArchived object 允許封存群組內容。可能的值包括:
  • true:封存傳送至群組的訊息。
  • false:請勿保留傳送至這個群組的訊息封存資料。如果為 false,先前封存的訊息仍會保留在封存中。
entry/apps:archiveOnly object 這項設定只允許封存群組。可能的值包括:
  • true:群組已封存,而且群組已停用。系統會拒絕傳送至這個群組的新訊息。舊的封存訊息可供瀏覽及搜尋。
    • 如果是 true,則 whoCanPostMessage 屬性會設為 NONE_CAN_POST
    • 如果從 true 還原為 false, WhoCanPostMessages 會設為 ALL_MANAGERS_CAN_POST
  • false:群組已啟用,可以接收訊息。
    • falsewhoCanPostMessage 更新為 NONE_CAN_POST 時,會發生錯誤。
entry/apps:messageModerationLevel object 收到的訊息審核等級。可能的值包括:
  • MODERATE_ALL_MESSAGES:所有訊息都會傳送至群組擁有者的電子郵件地址,以供核准。如果獲得核准,系統就會將訊息傳送給群組。
  • MODERATE_NON_MEMBERS:所有來自非群組成員的郵件都會傳送至群組擁有者的電子郵件地址以供審核。如果獲得核准,系統就會將訊息傳送給群組。
  • MODERATE_NEW_MEMBERS:新成員發送的所有訊息都會傳送至群組擁有者的電子郵件地址,以便核准。如果獲得核准,系統就會將訊息傳送給群組。
  • MODERATE_NONE:不需管理員核准。訊息會直接傳送至群組。
entry/apps:spamModerationLevel object 指定系統偵測為垃圾郵件的訊息審核層級。可能的值包括:
  • ALLOW:將訊息張貼到群組。
  • MODERATE:將訊息傳送至審核佇列。此為預設值。
  • SILENTLY_MODERATE:將訊息傳送至審核佇列,但不要通知管理員。
  • REJECT:立即拒絕郵件。
entry/apps:replyTo object 指定預設回覆的接收對象。可能的值包括:
  • REPLY_TO_CUSTOM:如要回覆訊息,請使用群組的自訂電子郵件地址。

    當群組的 ReplyTo 屬性設為 REPLY_TO_CUSTOM 時,customReplyTo 屬性會保留用於回覆訊息的自訂電子郵件地址。如果群組的 ReplyTo 屬性設為 REPLY_TO_CUSTOMcustomReplyTo 屬性就必須有值。否則會傳回錯誤。

  • REPLY_TO_SENDER:傳送給訊息作者的回覆。
  • REPLY_TO_LIST:這個回覆訊息會傳送給群組。
  • REPLY_TO_OWNER:回覆會傳送給群組擁有者。不包含群組管理員。
  • REPLY_TO_IGNORE:群組使用者可自行決定要將訊息回覆傳送至哪個對象。
  • REPLY_TO_MANAGERS:這則回覆訊息會傳送給群組管理員,包括所有管理員和群組版主。
entry/apps:customReplyTo object replyTo 屬性設為 REPLY_TO_CUSTOM 的情況下,回覆訊息時使用的電子郵件地址。這個地址是由帳戶管理員定義。
  • 當群組的 ReplyTo 屬性設為 REPLY_TO_CUSTOM 時,customReplyTo 屬性會保留用於回覆訊息的自訂電子郵件地址。
  • 如果群組的 ReplyTo 屬性設為 REPLY_TO_CUSTOMcustomReplyTo 屬性就必須有文字值,否則系統會傳回錯誤。
entry/apps:includeCustomFooter object 是否要加入自訂頁尾。可能的值包括:
  • true
  • false
entry/apps:customFooterText object 設定自訂頁尾文字的內容。最多不得超過 1000 個字元。
entry/apps:sendMessageDenyNotification object 如果群組版主拒絕成員傳送給群組的訊息,系統會通知該成員。可能的值包括:
  • true:訊息遭到拒絕時,傳送拒絕訊息通知給訊息作者。

    defaultMessageDenyNotificationText 屬性取決於 sendMessageDenyNotification 屬性是否為 true

  • false:訊息遭拒時,系統不會傳送通知。
entry/apps:defaultMessageDenyNotificationText object 訊息遭到拒絕時,系統會傳送這段文字,做為傳送給訊息作者的拒絕通知。根據預設,這個屬性為空白,且在 API 的回應主體中沒有任何值。通知文字大小上限為 10,000 個半形字元。
entry/apps:showInGroupDirectory object 已淘汰。這會合併至 whoCanDiscoverGroup 設定。允許群組顯示在群組目錄中。可能的值包括:
  • true:帳戶中的所有群組都會列在「網路論壇目錄」中。
  • false:目錄中並未列出帳戶中的所有群組。
entry/apps:allowGoogleCommunication object 已淘汰。允許 Google 聯絡群組管理員。
  • true:允許 Google 聯絡這個群組的管理員。Google 會不定期傳送最新功能的更新資訊、請你對新功能提供意見,或是請求特別標明你的群組。
  • false:Google 無法聯絡這個群組的管理員。
entry/apps:membersCanPostAsTheGroup object 允許成員以群組身分張貼訊息。可能的值包括:
  • true:群組成員可以使用群組的電子郵件地址 (而非他們的電子郵件地址) 張貼訊息。訊息似乎來自群組本身。
  • false:成員無法使用群組的電子郵件地址發布貼文。
entry/apps:messageDisplayFont object 已淘汰。預設訊息顯示字型一律為 DEFAULT_FONT
entry/apps:includeInGlobalAddressList object 讓群組納入全域通訊清單。詳情請參閱說明中心。可能的值包括:
  • true:群組已納入全域通訊清單。
  • false:群組未納入全域通訊清單。
entry/apps:whoCanLeaveGroup object 指定誰可以離開群組。可能的值包括:
  • ALL_MANAGERS_CAN_LEAVE
  • ALL_MEMBERS_CAN_LEAVE
  • NONE_CAN_LEAVE
entry/apps:whoCanContactOwner object 指定誰可以聯絡版主。可能的值包括:
  • ALL_IN_DOMAIN_CAN_CONTACT
  • ALL_MANAGERS_CAN_CONTACT
  • ALL_MEMBERS_CAN_CONTACT
  • ANYONE_CAN_CONTACT
entry/apps:whoCanAddReferences object 已淘汰。Google 網路論壇使用者介面已不再支援這項功能。此值一律為 NONE
entry/apps:whoCanAssignTopics object 已淘汰。這會合併至 whoCanAssistContent 設定。指定哪些使用者可以將論壇中的主題指派給其他使用者。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanUnassignTopic object 已淘汰,這會合併至 whoCanAssistContent 設定。指定可取消指派論壇中任何主題的使用者。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanTakeTopics object 已淘汰。這會合併至 whoCanAssistContent 設定。指定誰可以在論壇中接管主題。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanMarkDuplicate object 已淘汰。這會合併至 whoCanAssistContent 設定。指定哪些使用者可以將主題標示為重複項目。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanMarkNoResponseNeeded object 已淘汰,這會合併至 whoCanAssistContent 設定。指定哪些使用者可以將主題標示為不需要回應。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanMarkFavoriteReplyOnAnyTopic object 已淘汰。這會合併至 whoCanAssistContent 設定。指定哪些使用者可以將其他使用者的貼文標示為最愛回覆。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanMarkFavoriteReplyOnOwnTopic object 已淘汰,這會合併至 whoCanAssistContent 設定。指定誰可以將自己發起的主題留言標示為最愛回覆。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanUnmarkFavoriteReplyOnAnyTopic object 已淘汰。這個項目已併入 whoCanAssistContent 設定。指定可取消標示任何「最愛回覆」的使用者。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanEnterFreeFormTags object 已淘汰。這個項目已併入 whoCanAssistContent 設定。指定誰可以為論壇中的主題輸入任意形式的標記。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanModifyTagsAndCategories object 已淘汰,這個項目已併入 whoCanAssistContent 設定。指定可變更標記和類別的使用者。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
entry/apps:favoriteRepliesOnTop object 指出最愛回覆是否應顯示在其他回覆上方。
  • true:系統會將最愛的回覆顯示在其他回覆上方。
  • false:系統不會將最愛的回覆顯示在其他回覆上方。
entry/apps:whoCanApproveMembers object 已淘汰,這會合併至 whoCanModerateMembers 設定。已淘汰。這會合併至 whoCanModerateMembers 設定。指定可以核准要求加入群組的成員。可能的值包括:
  • ALL_MEMBERS_CAN_APPROVE
  • ALL_MANAGERS_CAN_APPROVE
  • ALL_OWNERS_CAN_APPROVE
  • NONE_CAN_APPROVE
entry/apps:whoCanBanUsers object 已淘汰。這會合併至 whoCanModerateMembers 設定。指定誰可以取消使用者的成員資格。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanModifyMembers object 已淘汰,這會合併至 whoCanModerateMembers 設定。指定可變更群組成員角色的使用者。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanApproveMessages object 已淘汰,這會合併至 whoCanModerateContent 設定。指定誰可以核准審核佇列中的待核准訊息。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanDeleteAnyPost object 已淘汰。這會合併至 whoCanModerateContent 設定。指定誰可以刪除主題的回覆。(作者一律可刪除自己的留言)。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanDeleteTopics object 已淘汰。這會合併至 whoCanModerateContent 設定。指定哪些使用者可以刪除主題。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanLockTopics object 已淘汰。這會合併至 whoCanModerateContent 設定。指定哪些使用者可以禁止其他使用者針對主題張貼回覆。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanMoveTopicsIn object 已淘汰,這會合併至 whoCanModerateContent 設定。指定哪些使用者可以將主題移入群組或論壇。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanMoveTopicsOut object 已淘汰。這會合併至 whoCanModerateContent 設定。指定誰可以將主題移出群組或論壇。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanPostAnnouncements object 已淘汰,這會合併至 whoCanModerateContent 設定。指定誰可以張貼公告 (一種特別的主題類型)。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanHideAbuse object 已淘汰。這會合併至 whoCanModerateContent 設定。指定誰可以透過檢舉濫用行為來隱藏相關不當留言。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanMakeTopicsSticky object 已淘汰。這個項目已併入 whoCanModerateContent 設定。指定哪些使用者可以讓主題顯示在主題清單頂端。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanModerateMembers object 指定誰可以管理成員。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanModerateContent object 指定誰可以審核內容。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanAssistContent object 指定誰可以審核中繼資料。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
entry/apps:customRolesEnabledForSettingsToBeMerged object 指出群組是否具備自訂角色。該角色適用於即將合併的其中一項設定。這個欄位為唯讀,系統會忽略對此欄位的 UPDATEPATCH 要求。可能的值包括:
  • true
  • false
entry/apps:enableCollaborativeInbox object 指定群組的協作收件匣是否維持啟用狀態。可能的值包括:
  • true
  • false
entry/apps:whoCanDiscoverGroup object 指定可發現這個群組的使用者組合。可能的值包括:
  • ANYONE_CAN_DISCOVER
  • ALL_IN_DOMAIN_CAN_DISCOVER
  • ALL_MEMBERS_CAN_DISCOVER
entry/apps:defaultSender object 可代表群組張貼訊息的使用者,預設的寄件者。可能的值包括:
  • DEFAULT_SELF
  • GROUP

JSON

{
  "kind": "groupsSettings#groups",
  "email": string,
  "name": string,
  "description": string,
  "whoCanJoin": string,
  "whoCanViewMembership": string,
  "whoCanViewGroup": string,
  "whoCanInvite": string,
  "whoCanAdd": string,
  "allowExternalMembers": string,
  "whoCanPostMessage": string,
  "allowWebPosting": string,
  "primaryLanguage": string,
  "maxMessageBytes": integer,
  "isArchived": string,
  "archiveOnly": string,
  "messageModerationLevel": string,
  "spamModerationLevel": string,
  "replyTo": string,
  "customReplyTo": string,
  "includeCustomFooter": string,
  "customFooterText": string,
  "sendMessageDenyNotification": string,
  "defaultMessageDenyNotificationText": string,
  "showInGroupDirectory": string,
  "allowGoogleCommunication": string,
  "membersCanPostAsTheGroup": string,
  "messageDisplayFont": string,
  "includeInGlobalAddressList": string,
  "whoCanLeaveGroup": string,
  "whoCanContactOwner": string,
  "whoCanAddReferences": string,
  "whoCanAssignTopics": string,
  "whoCanUnassignTopic": string,
  "whoCanTakeTopics": string,
  "whoCanMarkDuplicate": string,
  "whoCanMarkNoResponseNeeded": string,
  "whoCanMarkFavoriteReplyOnAnyTopic": string,
  "whoCanMarkFavoriteReplyOnOwnTopic": string,
  "whoCanUnmarkFavoriteReplyOnAnyTopic": string,
  "whoCanEnterFreeFormTags": string,
  "whoCanModifyTagsAndCategories": string,
  "favoriteRepliesOnTop": string,
  "whoCanApproveMembers": string,
  "whoCanBanUsers": string,
  "whoCanModifyMembers": string,
  "whoCanApproveMessages": string,
  "whoCanDeleteAnyPost": string,
  "whoCanDeleteTopics": string,
  "whoCanLockTopics": string,
  "whoCanMoveTopicsIn": string,
  "whoCanMoveTopicsOut": string,
  "whoCanPostAnnouncements": string,
  "whoCanHideAbuse": string,
  "whoCanMakeTopicsSticky": string,
  "whoCanModerateMembers": string,
  "whoCanModerateContent": string,
  "whoCanAssistContent": string,
  "customRolesEnabledForSettingsToBeMerged": string,
  "enableCollaborativeInbox": string,
  "whoCanDiscoverGroup": string,
  "defaultSender": string
}

下表列出群組資源:

屬性名稱 說明
kind string 資源類型。一律為 groupsSettings#groups
email string 群組的電子郵件地址。您可以使用 Directory API 更新這個屬性。
name string 群組名稱,長度上限為 75 個半形字元。
description string 群組的說明。如果您尚未輸入群組說明,這個屬性值可以是空白字串。如果輸入群組說明,其長度不得超過 4,096 個半形字元。
whoCanJoin string 加入群組的權限。可能的值包括:
  • ANYONE_CAN_JOIN:任何網際網路使用者 (不論是否屬於您的網域) 皆可加入群組。
  • ALL_IN_DOMAIN_CAN_JOIN:帳戶網域中的任何人都可以加入。包括擁有多個網域的帳戶。
  • INVITED_CAN_JOIN:您可以邀請候選人加入。
  • CAN_REQUEST_TO_JOIN:非會員可以要求加入。
whoCanViewMembership string 查看成員資格的權限。可能的值包括:
  • ALL_IN_DOMAIN_CAN_VIEW:帳戶中的所有使用者都可以查看群組成員清單。

    如果群組已有外部成員,這些成員仍可傳送電子郵件給這個群組。

  • ALL_MEMBERS_CAN_VIEW:群組成員可以查看群組成員名單。
  • ALL_MANAGERS_CAN_VIEW:群組管理員可以查看群組成員清單。
whoCanViewGroup string 查看群組訊息的權限。可能的值包括:
  • ANYONE_CAN_VIEW:任何網路使用者都可以查看群組訊息。
  • ALL_IN_DOMAIN_CAN_VIEW:帳戶中的任何人都能查看這個群組的訊息。
  • ALL_MEMBERS_CAN_VIEW:所有群組成員都可以查看群組訊息。
  • ALL_MANAGERS_CAN_VIEW:任何群組管理員都能查看這個群組的訊息。
whoCanInvite string 已淘汰,這個項目已併入 whoCanModerateMembers 設定。邀請新成員的權限。可能的值包括:
  • ALL_MEMBERS_CAN_INVITE:管理員和成員可以邀請新成員候選人。
  • ALL_MANAGERS_CAN_INVITE:只有管理員可以邀請新成員。包括群組擁有者。
  • ALL_OWNERS_CAN_INVITE:只有擁有者可以邀請新成員。
  • NONE_CAN_INVITE:任何人都無法邀請新成員候選人。
whoCanAdd string 已淘汰。這會合併至 whoCanModerateMembers 設定。新增成員的權限。可能的值包括:
  • ALL_MEMBERS_CAN_ADD:管理員和成員可以直接新增成員。
  • ALL_MANAGERS_CAN_ADD:只有管理員可以直接新增成員,包括群組擁有者。
  • ALL_OWNERS_CAN_ADD:只有擁有者可以直接新增成員。
  • NONE_CAN_ADD:任何人都無法直接新增成員。
allowExternalMembers string 識別機構外部成員能否加入群組。可能的值包括:
  • true:機構外的 Google Workspace 使用者能夠成為這個群組的成員。
  • false:不屬於機構的使用者不得成為這個群組的成員。
whoCanPostMessage string 張貼訊息的權限。可能的值包括:
  • NONE_CAN_POST:群組已停用並封存。沒有人可以在這個群組張貼留言。
    • 如果 archiveOnlyfalse,將 whoCanPostMessage 更新為 NONE_CAN_POST 會導致錯誤。
    • 如果 archiveOnlytrue 改回 falsewhoCanPostMessages 就會設為 ALL_MANAGERS_CAN_POST
  • ALL_MANAGERS_CAN_POST:管理員 (包括版主) 可以張貼訊息。
  • ALL_MEMBERS_CAN_POST:任何群組成員都可以留言。
  • ALL_OWNERS_CAN_POST:只有群組擁有者可以張貼訊息。
  • ALL_IN_DOMAIN_CAN_POST:帳戶中的任何人都可以張貼訊息。
  • ANYONE_CAN_POST:任何網際網路使用者 (不限於您的帳戶) 都能存取您的 Google 群組服務,並張貼訊息。
allowWebPosting string 允許透過網站張貼。可能的值包括:
  • true:允許任何成員在群組論壇中發布內容。
  • false:成員只會使用 Gmail 與群組溝通交流。
primaryLanguage string 群組的主要語言。請使用「支援的語言」表格中的語言標記。
maxMessageBytes integer 已淘汰。郵件大小上限為 25 MB。
isArchived string 允許封存群組內容。可能的值包括:
  • true:封存傳送至群組的訊息。
  • false:請勿保留傳送至這個群組的訊息封存資料。如果為 false,先前封存的訊息仍會保留在封存中。
archiveOnly string 這項設定只允許封存群組。可能的值包括:
  • true:群組已封存,而且群組已停用。系統會拒絕傳送至這個群組的新訊息。舊的封存訊息可供瀏覽及搜尋。
    • 如果是 true,則 whoCanPostMessage 屬性會設為 NONE_CAN_POST
    • 如果從 true 還原為 false, WhoCanPostMessages 會設為 ALL_MANAGERS_CAN_POST
  • false:群組已啟用,可以接收訊息。
    • falsewhoCanPostMessage 更新為 NONE_CAN_POST 時,會發生錯誤。
messageModerationLevel string 收到的訊息審核等級。可能的值包括:
  • MODERATE_ALL_MESSAGES:所有訊息都會傳送至群組擁有者的電子郵件地址,以供核准。如果獲得核准,系統就會將訊息傳送給群組。
  • MODERATE_NON_MEMBERS:所有來自非群組成員的郵件都會傳送至群組擁有者的電子郵件地址以供審核。如果獲得核准,系統就會將訊息傳送給群組。
  • MODERATE_NEW_MEMBERS:新成員發送的所有訊息都會傳送至群組擁有者的電子郵件地址,以便核准。如果獲得核准,系統就會將訊息傳送給群組。
  • MODERATE_NONE:無須經過管理員核准。訊息會直接傳送至群組。
spamModerationLevel string 指定系統偵測為垃圾郵件的訊息審核層級。可能的值包括:
  • ALLOW:將訊息張貼到群組。
  • MODERATE:將訊息傳送至審核佇列。此為預設值。
  • SILENTLY_MODERATE:將訊息傳送至審核佇列,但不要通知管理員。
  • REJECT:立即拒絕郵件。
replyTo string 指定誰會收到預設回覆。可能的值包括:
  • REPLY_TO_CUSTOM:如要回覆訊息,請使用群組的自訂電子郵件地址。

    當群組的 ReplyTo 屬性設為 REPLY_TO_CUSTOM 時,customReplyTo 屬性會保留用於回覆訊息的自訂電子郵件地址。如果群組的 ReplyTo 屬性設為 REPLY_TO_CUSTOMcustomReplyTo 屬性就必須有值。否則會傳回錯誤。

  • REPLY_TO_SENDER:傳送給訊息作者的回覆。
  • REPLY_TO_LIST:這個回覆訊息會傳送給群組。
  • REPLY_TO_OWNER:回覆會傳送給群組擁有者。不包含群組管理員。
  • REPLY_TO_IGNORE:個別群組使用者決定訊息回覆的傳送目的地。
  • REPLY_TO_MANAGERS:這則回覆訊息會傳送給群組管理員,包括所有管理員和群組版主。
customReplyTo string replyTo 屬性設為 REPLY_TO_CUSTOM 的情況下,回覆訊息時使用的電子郵件地址。這個地址是由帳戶管理員定義。
  • 當群組的 ReplyTo 屬性設為 REPLY_TO_CUSTOM 時,customReplyTo 屬性會保留用於回覆訊息的自訂電子郵件地址。
  • 如果群組的 ReplyTo 屬性設為 REPLY_TO_CUSTOMcustomReplyTo 屬性就必須有文字值,否則系統會傳回錯誤。
includeCustomFooter string 是否要加入自訂頁尾。可能的值包括:
  • true
  • false
customFooterText string 設定自訂頁尾文字的內容。字元數上限為 1,000 個。
sendMessageDenyNotification string 如果群組版主拒絕成員傳送給群組的訊息,系統會通知該成員。可能的值包括:
  • true:訊息遭到拒絕時,傳送拒絕訊息通知給訊息作者。

    defaultMessageDenyNotificationText 屬性取決於 sendMessageDenyNotification 屬性是否為 true

  • false:訊息遭拒時,系統不會傳送通知。
defaultMessageDenyNotificationText string 訊息遭到拒絕時,系統會傳送這段文字,做為傳送給訊息作者的拒絕通知。根據預設,這個屬性為空白,且在 API 的回應主體中沒有任何值。通知文字大小上限為 10,000 個半形字元。
showInGroupDirectory string 已淘汰。這會合併至 whoCanDiscoverGroup 設定。允許群組顯示在群組目錄中。可能的值包括:
  • true:帳戶中的所有群組都會列在「網路論壇目錄」中。
  • false:目錄中並未列出帳戶中的所有群組。
allowGoogleCommunication string 已淘汰。允許 Google 聯絡群組管理員。
  • true:允許 Google 聯絡這個群組的管理員。Google 會不定期傳送最新功能的更新資訊、請你對新功能提供意見,或是請求特別標明你的群組。
  • false:Google 無法聯絡這個群組的管理員。
membersCanPostAsTheGroup string 允許成員以群組身分張貼訊息。可能的值包括:
  • true:群組成員可以使用群組的電子郵件地址 (而非他們的電子郵件地址) 張貼訊息。訊息似乎來自群組本身。
  • false:成員無法使用群組的電子郵件地址發布貼文。
messageDisplayFont string 已淘汰。預設訊息顯示字型一律為 DEFAULT_FONT
includeInGlobalAddressList string 讓群組納入全域通訊清單。詳情請參閱說明中心。可能的值包括:
  • true:群組已納入全域通訊清單。
  • false:全域通訊清單不包含群組。
whoCanLeaveGroup string 離開群組的權限。可能的值包括:
  • ALL_MANAGERS_CAN_LEAVE
  • ALL_MEMBERS_CAN_LEAVE
  • NONE_CAN_LEAVE
whoCanContactOwner string 透過網頁使用者介面與群組擁有者聯絡的權限。可能的值包括:
  • ALL_IN_DOMAIN_CAN_CONTACT
  • ALL_MANAGERS_CAN_CONTACT
  • ALL_MEMBERS_CAN_CONTACT
  • ANYONE_CAN_CONTACT
whoCanAddReferences string 已淘汰。Google 網路論壇使用者介面已不再支援這項功能。這個值一律為「NONE」。
whoCanAssignTopics string 已淘汰。這會合併至 whoCanAssistContent 設定。將論壇中的主題指派給其他使用者的權限。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
whoCanUnassignTopic string 已淘汰。這會合併至 whoCanAssistContent 設定。可取消指派論壇中的任何主題。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
whoCanTakeTopics string 已淘汰。這會合併至 whoCanAssistContent 設定。在論壇中接管主題的權限。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
whoCanMarkDuplicate string 已淘汰,這會合併至 whoCanAssistContent 設定。將主題標示為另一個主題的重複項目的權限。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
whoCanMarkNoResponseNeeded string 已淘汰。這個項目已併入 whoCanAssistContent 設定。將主題標示為不需要回應的權限。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
whoCanMarkFavoriteReplyOnAnyTopic string 已淘汰。這會合併至 whoCanAssistContent 設定。允許將其他使用者的貼文標示為最愛回覆的權限。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
whoCanMarkFavoriteReplyOnOwnTopic string 已淘汰,這個項目已併入 whoCanAssistContent 設定。在自己發起的主題中,將留言標示為最愛回覆。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
whoCanUnmarkFavoriteReplyOnAnyTopic string 已淘汰,這個項目已併入 whoCanAssistContent 設定。可取消標示任何貼文的「最愛回覆」。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
whoCanEnterFreeFormTags string 已淘汰。這會合併至 whoCanAssistContent 設定。在論壇中為主題輸入任意形式標記的權限。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
whoCanModifyTagsAndCategories string 已淘汰,這會合併至 whoCanAssistContent 設定。有權變更標記和類別。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
favoriteRepliesOnTop string 指出是否應將最愛回覆顯示在其他回覆之前。
  • true:系統會在其他回覆之前顯示最愛的回覆。
  • false:最愛回覆不會在其他回覆之前顯示。
whoCanApproveMembers string 指定誰能核准要求加入群組的成員。這項權限合併至 whoCanModerateMembers 設定後,就會淘汰。可能的值包括:
  • ALL_MEMBERS_CAN_APPROVE
  • ALL_MANAGERS_CAN_APPROVE
  • ALL_OWNERS_CAN_APPROVE
  • NONE_CAN_APPROVE
whoCanBanUsers string 指定可取消使用者成員資格的使用者。這項權限會在合併至 whoCanModerateMembers 設定後遭淘汰。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanModifyMembers string 已淘汰。這會合併至 whoCanModerateMembers 設定。指定可變更群組成員角色的使用者。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanApproveMessages string 已淘汰,這會合併至 whoCanModerateContent 設定。指定誰可以核准審核佇列中的待核准訊息。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanDeleteAnyPost string 已淘汰。這會合併至 whoCanModerateContent 設定。指定誰可以刪除主題的回覆。(作者一律可刪除自己的留言)。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanDeleteTopics string 已淘汰。這會合併至 whoCanModerateContent 設定。指定哪些使用者可以刪除主題。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanLockTopics string 已淘汰。這會合併至 whoCanModerateContent 設定。指定哪些使用者可以禁止其他使用者針對主題張貼回覆。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanMoveTopicsIn string 已淘汰,這會合併至 whoCanModerateContent 設定。指定哪些使用者可以將主題移入群組或論壇。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanMoveTopicsOut string 已淘汰。這會合併至 whoCanModerateContent 設定。指定誰可以將主題移出群組或論壇。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanPostAnnouncements string 已淘汰,這會合併至 whoCanModerateContent 設定。指定誰可以張貼公告 (一種特別的主題類型)。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanHideAbuse string 已淘汰。這會合併至 whoCanModerateContent 設定。指定誰可以透過檢舉濫用行為來隱藏相關不當留言。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanMakeTopicsSticky string 已淘汰。這個項目已併入 whoCanModerateContent 設定。指定哪些使用者可以讓主題顯示在主題清單頂端。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanModerateMembers string 指定誰可以管理成員。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanModerateContent string 指定誰可以審核內容。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
whoCanAssistContent string 指定誰可以審核中繼資料。可能的值包括:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE
customRolesEnabledForSettingsToBeMerged string 指出群組是否具備自訂角色。該角色適用於即將合併的其中一項設定。這個欄位為唯讀,系統會忽略對此欄位的 UPDATEPATCH 要求。可能的值包括:
  • true
  • false
enableCollaborativeInbox string 指定群組的協作收件匣是否維持啟用狀態。可能的值包括:
  • true
  • false
whoCanDiscoverGroup string 指定可發現這個群組的使用者組合。可能的值包括:
  • ANYONE_CAN_DISCOVER
  • ALL_IN_DOMAIN_CAN_DISCOVER
  • ALL_MEMBERS_CAN_DISCOVER
defaultSender string 可代表群組張貼訊息的使用者,預設的寄件者。可能的值包括:
  • DEFAULT_SELF
  • GROUP

方法

groupsSettings.groups.getgroupsSettings.groups.update 方法會針對指定的群組資源運作。

get
根據群組電子郵件地址,擷取群組的設定。
update
更新現有群組的設定,以群組電子郵件地址做為識別。
patch
更新現有資源。這個方法可支援 patch 語意。

支援的語言

系統支援下列語言代碼,用於群組的 primaryLanguage 欄位。

aa
ab
af
am
ar
as
ay
az
ba
be
bg
bh
bi
bn
bo
br
bs
ca
co
cs
cy
da
de
dz
el
en
en-GB
en-US-pseudo
en_US
eo
es
et
eu
fa
fi
fj
fo
fr
fr-CA
fy
ga
gd
gl
gn
gu
ha
hi
hr
hu
hy
ia
id
ie
ik
is
it
iu
iw
ja
jw
ka
kk
kl
km
kn
ko
ks
ku
ky
la
ln
lo
lt
lv
mg
mi
mk
ml
mn
mo
mr
ms
mt
my
na
ne
nl
nn
no
oc
om
or
pa
pl
ps
pt-BR
pt-PT
qu
rm
rn
ro
ru
rw
sa
sd
sg
sh
si
sk
sl
sm
sn
so
sq
sr
ss
st
su
sv
sw
ta
te
tg
th
ti
tk
tl
tn
to
tr
ts
tt
tw
ug
uk
ur
uz
vi
vo
wo
xh
xx-bork
xx-elmer
xx-hacker
xx-klingon
xx-piglatin
yi
yo
za
zh-CN
zh-TW
zu