Groups

Groups 资源是 Groups Settings API 的根数据类。每个 Google 群组资源都与一组设置相关联。

如需了解详情，请参阅此类资源的方法列表。

资源表示形式

群组资源包含包含指定群组设置摘要的元数据。 这些设置用于管理群组的访问权限、通知、讨论归档、消息审核，以及自定义账号的用户群组。

默认情况下，系统会以 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>

下表显示了 Google 群组资源：

属性名称 值 说明
entry object 群组资源
entry/xmlns string Atom 格式的架构
entry/xmlns:apps string Google Workspace I/O 格式的架构
entry/xmlns:gd string Google 数据协议的架构
entry/id object 群组资源的唯一标识符
entry/title object API 的 Atom 条目的标题，即 Groups Resource Entry
entry/content object Atom 条目的内容类型
entry/content/type string Atom Feed 的内容类型，即 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 还原为 false，则 whoCanPostMessages 会设为 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 已弃用。消息的大小上限为 25MB。
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：群组处于活跃状态，并且可以接收消息。
    • 当 false 时，将 whoCanPostMessage 更新为 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_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_CUSTOM 时，customReplyTo 属性会包含用于回复消息的自定义电子邮件地址。
  • 如果组的 ReplyTo 属性设置为 REPLY_TO_CUSTOM，则 customReplyTo 属性必须具有文本值，否则系统会返回错误。
entry/apps:includeCustomFooter object 是否添加自定义页脚。可能的值包括：
  • true
  • false
entry/apps:customFooterText object 设置自定义页脚文本的内容。字符数上限为 1000。
entry/apps:sendMessageDenyNotification object 当群组所有者拒绝某个成员向群组发送的消息时，可让该成员收到通知。可能的值包括：
  • true：当消息被拒时，向消息作者发送消息被拒通知。

    defaultMessageDenyNotificationText 属性依赖于设为 true 的 sendMessageDenyNotification 属性。

  • 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 指定该群组是否拥有自定义角色，且该角色包含在即将合并的某项设置中。此字段是只读字段，系统会忽略对其发出的 UPDATE 和 PATCH 请求。可能的值包括：
  • 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：群组已停用并归档。任何人都无法向此群组发帖。
    • 当 archiveOnly 为 false 时，将 whoCanPostMessage 更新为 NONE_CAN_POST 会导致错误。
    • 如果 archiveOnly 从 true 还原为 false，则 whoCanPostMessages 会设置为 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 已弃用。消息的大小上限为 25MB。
isArchived string 允许归档群组内容。可能的值包括：
  • true：归档发送到群组的消息。
  • false：不保留发送到此群组的消息归档。如果为 false，则之前归档的消息会保留在归档文件中。
archiveOnly string 仅允许将群组归档。可能的值包括：
  • true：群组已归档，而该群组处于非活动状态。系统会拒收发送到此群组的新邮件。可以浏览和搜索旧的归档邮件。
    • 如果为 true，则将 whoCanPostMessage 属性设置为 NONE_CAN_POST。
    • 如果从 true 还原为 false，则 whoCanPostMessages 会设置为 ALL_MANAGERS_CAN_POST。
  • false：群组处于活跃状态，并且可以接收消息。
    • 当 false 时，将 whoCanPostMessage 更新为 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_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_CUSTOM 时，customReplyTo 属性会包含用于回复消息的自定义电子邮件地址。
  • 如果组的 ReplyTo 属性设置为 REPLY_TO_CUSTOM，则 customReplyTo 属性必须具有文本值，否则系统会返回错误。
includeCustomFooter string 是否添加自定义页脚。可能的值包括：
  • true
  • false
customFooterText string 设置自定义页脚文本的内容。最多不能超过 1,000 个字符。
sendMessageDenyNotification string 如果群组所有者拒收成员发送给群组的邮件，则允许向该成员发送通知。可能的值包括：
  • true：当消息被拒时，向消息作者发送消息被拒通知。

    defaultMessageDenyNotificationText 属性依赖于设为 true 的 sendMessageDenyNotification 属性。

  • 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 指定该群组是否拥有自定义角色，且该角色包含在即将合并的某项设置中。此字段是只读字段，系统会忽略对其发出的 UPDATE 和 PATCH 请求。可能的值包括：
  • 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.get 和 groupsSettings.groups.update 方法对指定的 Google 群组资源进行操作。

get
检索群组电子邮件地址标识的群组设置。
update
更新现有群组的设置，该设置由群组电子邮件地址标识。
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




































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