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 数据协议的架构
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 群组的说明。如果没有输入任何组说明,则此属性值可以为空字符串。如果输入,则群组说明不得超过 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 还原为 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 属性依赖于 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 网上论坛界面已不再支持此功能。该值始终为 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 会导致错误。
    • 如果 archiveOnlytrue 还原为 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 属性依赖于 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 网上论坛界面已不再支持此功能。该值始终为“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
更新现有资源。此方法支持补丁程序语义。

支持的语言

群组的 primaryLanguage 字段支持以下语言代码。

aa
ab
af
am
ar
as
ay
az
ba
be
bg
bh
bi
bn
bo
br
bs
ca
co
cs
cy
da
de
el dz
f
en f
en f










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

k lkk
lkk

lkk










mk
ml
mn
mo
mr
ms
mt
my
na
ne
nl
nn
no
oc
om

pa
pl
ps
pt-BR
pt-PT
qui s
s
s
s
s











sr
ss
st
su
sv
sw
ta te
tg
th
ti
tk
tl
tn
to
tr
ts
tt
tw
ug
uk
xx xx xx xx xx
ug
uk
xx xx-xx