Groups

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

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

資源表示法

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

根據預設,系統會以 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 群組的說明。如未輸入群組說明,這個屬性值可以是空白字串。如果輸入的群組說明長度不超過 300 個半形字元,
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:群組已封存,且群組處於閒置狀態。傳送到這個群組的新訊息遭到拒絕。您可以瀏覽及搜尋先前的封存訊息。
    • 如果值為 truewhoCanPostMessage 屬性會設為 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_CUSTOMcustomReplyTo 屬性會保留回覆訊息時使用的自訂電子郵件地址。如果群組的 ReplyTo 屬性設為 REPLY_TO_CUSTOM,則 customReplyTo 屬性必須含有值。否則系統會傳回錯誤。

  • 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_CUSTOMcustomReplyTo 屬性會保留回覆訊息時使用的自訂電子郵件地址。
  • 如果群組的 ReplyTo 屬性設為 REPLY_TO_CUSTOM,則 customReplyTo 屬性必須有文字值或傳回錯誤。
entry/apps:includeCustomFooter object 是否納入自訂頁尾。可能的值包括:
  • true
  • false
entry/apps:customFooterText object 設定自訂頁尾文字的內容。長度上限為 1000 個半形字元。
entry/apps:sendMessageDenyNotification object 允許在版主拒絕群組成員時,通知群組成員。可能的值包括:
  • true:訊息遭拒時,傳送拒絕訊息通知給訊息作者。

    defaultMessageDenyNotificationText 屬性依附於 truesendMessageDenyNotification 屬性。

  • 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 網路論壇 UI 已不再支援此功能。此值一律為 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 群組說明。如未輸入群組說明,這個屬性值可以是空白字串。如果輸入的群組說明長度不超過 300 個半形字元,
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 會導致錯誤。
    • 如果 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 網路論壇服務並張貼留言。
allowWebPosting string 允許從網頁張貼留言。可能的值包括:
  • true:允許所有成員在群組論壇中張貼訊息。
  • false:成員只能使用 Gmail 與群組通訊。
primaryLanguage string 群組的主要語言。請使用支援的語言表格中的語言標記。
maxMessageBytes integer 已淘汰。訊息大小上限為 25 MB。
isArchived string 允許封存群組內容。可能的值包括:
  • true:封存傳送至群組的訊息。
  • false:不要封存傳送給這個群組的訊息。如果是 false,先前封存的郵件仍會留存在封存區中。
archiveOnly string 僅允許封存群組。可能的值包括:
  • true:群組已封存,且群組處於閒置狀態。傳送到這個群組的新訊息遭到拒絕。您可以瀏覽及搜尋先前的封存訊息。
    • 如果值為 truewhoCanPostMessage 屬性會設為 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_CUSTOMcustomReplyTo 屬性會保留回覆訊息時使用的自訂電子郵件地址。如果群組的 ReplyTo 屬性設為 REPLY_TO_CUSTOM,則 customReplyTo 屬性必須含有值。否則系統會傳回錯誤。

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

    defaultMessageDenyNotificationText 屬性依附於 truesendMessageDenyNotification 屬性。

  • 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 網路論壇 UI 已不再支援此功能。此值一律為「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 方法運作於指定的群組資源

取得
擷取群組電子郵件地址識別的群組設定。
更新
更新由群組電子郵件地址識別的現有群組設定。
修補
更新現有資源。這個方法可支援 patch 語意。

支援的語言

群組的 primaryLanguage 欄位支援下列語言代碼。

aa
ab
af
am
ar
as
ay
az
ba

bg
bh
bi
bn
bo
br
bs
ca
co
cs
cy
da
de
cy
da
de
cy










fr-CA
fy
ga
gd
gl
gn
gu
ha
hi
hr
hu
hy
ia
ie
ik
is
it
iu
iw
iw
jw
ka















mk
ml
mn
mo
mr
ms
mt
我的
na
ne
nl
nn
no
oc
om
or
pa
pt-ps
pt-PT
qu
qu
















sr
ss
xx xx
sv
sw
ta
te
tg
th
tk
tl
tn

tr
ts
ts
tw
ugx