Groups

A Groups resource is the root data class for the Groups Settings API. Each Groups resource is associated with a collection of settings.

For a list of methods for this resource, see the end of this page.

Resource representations

A Groups resource includes metadata with a summary of a specified group's settings. These settings manage the group's access, notifications, discussion archiving, message moderation, and customize your account's user groups.

By default, the Groups resource data is returned in the JSON data format.

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>
</entry>
Property name Value Description Notes
entry object A Group resource
entry/apps:allowExternalMembers object Identifies whether members external to your organization can join the group. Possible values are:
  • true: G Suite users external to your organization can become members of this group.
  • false: Users not belonging to the organization are not allowed to become members of this group.
entry/apps:allowExternalMembers/text() string
entry/apps:allowGoogleCommunication object Deprecated. Allows Google to contact administrator of the group.
  • true: Allow Google to contact managers of this group. Occasionally Google may send updates on the latest features, ask for input on new features, or ask for permission to highlight your group.
  • false: Google can not contact managers of this group.
entry/apps:allowGoogleCommunication/text() string
entry/apps:allowWebPosting object Allows posting from web. Possible values are:
  • true: Allows any member to post to the group forum.
  • false: Members only use Gmail to communicate with the group.
entry/apps:allowWebPosting/text() string
entry/apps:archiveOnly object Allows the group to be archived only. Possible values are:
  • true: Group is archived and the group is inactive. New messages to this group are rejected. The older archived messages are browseable and searchable.
    • If true, the whoCanPostMessage property is set to NONE_CAN_POST.
    • If reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST.
  • false: The group is active and can receive messages.
    • When false, updating whoCanPostMessage to NONE_CAN_POST, results in an error.
entry/apps:archiveOnly/text() string
entry/apps:customFooterText object Set the content of custom footer text. The maximum number of characters is 1000.
entry/apps:customFooterText/text() string
entry/apps:customReplyTo object An email address used when replying to a message if the replyTo property is set to REPLY_TO_CUSTOM. This address is defined by an account administrator.
  • When the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property holds a custom email address used when replying to a message.
  • If the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property must have a text value or an error is returned.
entry/apps:customReplyTo/text() string
entry/apps:customRolesEnabledForSettingsToBeMerged object Specifies whether the group has a custom role that's included in one of the settings being merged. This field is read-only and update/patch requests to it are ignored. Possible values are:
  • true
  • false
entry/apps:customRolesEnabledForSettingsToBeMerged/text() string
entry/apps:defaultMessageDenyNotificationText object When a message is rejected, this is text for the rejection notification sent to the message's author. By default, this property is empty and has no value in the API's response body. The maximum notification text size is 10,000 characters.
entry/apps:defaultMessageDenyNotificationText/text() string
entry/apps:description object The description of the group. This property value may be an empty string if no group description has been entered. If entered, the maximum group description is no more than 300 characters.
entry/apps:description/text() string
entry/apps:email object

The group's email address. This property can be updated using the Directory API.

entry/apps:email/text() string
entry/apps:enableCollaborativeInbox object Specifies whether a collaborative inbox will remain turned on for the group. Possible values are:
  • true
  • false
entry/apps:enableCollaborativeInbox/text() string
entry/apps:favoriteRepliesOnTop object Indicates if favorite replies should be displayed above other replies.
  • true: Favorite replies will be displayed above other replies.
  • false: Favorite replies will not be displayed above other replies.
entry/apps:favoriteRepliesOnTop/text() string
entry/apps:includeCustomFooter object Whether to include custom footer. Possible values are:
  • true
  • false
entry/apps:includeCustomFooter/text() string
entry/apps:includeInGlobalAddressList object Enables the group to be included in the Global Address List. For more information, see the help center. Possible values are:
  • true: Group is included in the Global Address List.
  • false: Group is not included in the Global Address List.
entry/apps:includeInGlobalAddressList/text() string
entry/apps:isArchived object Allows the Group contents to be archived. Possible values are:
  • true: Archive messages sent to the group.
  • false: Do not keep an archive of messages sent to this group. If false, previously archived messages remain in the archive.
entry/apps:isArchived/text() string
entry/apps:maxMessageBytes object Deprecated. The maximum size of a message is 25Mb.
entry/apps:maxMessageBytes/text() integer
entry/apps:membersCanPostAsTheGroup object Enables members to post messages as the group. Possible values are:
  • true: Group member can post messages using the group's email address instead of their own email address. Message appear to originate from the group itself.
  • false: Members can not post in behalf of the group's email address.
entry/apps:membersCanPostAsTheGroup/text() string
entry/apps:messageDisplayFont object Deprecated. The default message display font always has a value of DEFAULT_FONT.
entry/apps:messageDisplayFont/text() string
entry/apps:messageModerationLevel object Moderation level of incoming messages. Possible values are:
  • MODERATE_ALL_MESSAGES: All messages are sent to the group owner's email address for approval. If approved, the message is sent to the group.
  • MODERATE_NON_MEMBERS: All messages from non group members are sent to the group owner's email address for approval. If approved, the message is sent to the group.
  • MODERATE_NEW_MEMBERS: All messages from new members are sent to the group owner's email address for approval. If approved, the message is sent to the group.
  • MODERATE_NONE: No moderator approval is required. Messages are delivered directly to the group.
entry/apps:messageModerationLevel/text() string
entry/apps:name object The group name. A group's name has a maximum of 75 characters.
entry/apps:name/text() string
entry/apps:primaryLanguage object The primary language for group. For a group's primary language use the language tags from the G Suite languages found at G Suite Email Settings API Email Language Tags.
entry/apps:primaryLanguage/text() string
entry/apps:replyTo object Specifies who receives the default reply. Possible values are:
  • REPLY_TO_CUSTOM: For replies to messages, use the group's custom email address.

    When the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property holds the custom email address used when replying to a message. If the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property must have a value. Otherwise an error is returned.

  • REPLY_TO_SENDER: The reply sent to author of message.
  • REPLY_TO_LIST: This reply message is sent to the group.
  • REPLY_TO_OWNER: The reply is sent to the owners of the group. This doesn't include the group's managers.
  • REPLY_TO_IGNORE: Group users individually decide where the message reply is sent.
  • REPLY_TO_MANAGERS: This reply message is sent to the group's managers, which includes all managers and the group owner.
entry/apps:replyTo/text() string
entry/apps:sendMessageDenyNotification object Allows a member to be notified if the member's message to the group is denied by the group owner. Possible values are:
  • true: When a message is rejected, send the deny message notification to the message author.

    The defaultMessageDenyNotificationText property is dependent on the sendMessageDenyNotification property being true.

  • false: When a message is rejected, no notification is sent.
entry/apps:sendMessageDenyNotification/text() string
entry/apps:showInGroupDirectory object Deprecated. Use the whoCanDiscoverGroup property instead.
entry/apps:showInGroupDirectory/text() string
entry/apps:spamModerationLevel object Specifies moderation levels for messages detected as spam. Possible values are:
  • ALLOW: Post the message to the group.
  • MODERATE: Send the message to the moderation queue. This is the default.
  • SILENTLY_MODERATE: Send the message to the moderation queue, but do not send notification to moderators.
  • REJECT: Immediately reject the message.
entry/apps:spamModerationLevel/text() string
entry/apps:whoCanAdd object Deprecated. Use the whoCanModerateMembers property instead.

Permissions to directly add new members.

entry/apps:whoCanAdd/text() string
entry/apps:whoCanAddReferences object Deprecated. Permission to add references to a topic. This functionality is no longer supported in the Google Groups UI. The value is always NONE.
entry/apps:whoCanAddReferences/text() string
entry/apps:whoCanApproveMembers object Deprecated. Use the whoCanModerateMembers property instead.

Specifies who can approve members who ask to join groups.

entry/apps:whoCanApproveMembers/text() string
entry/apps:whoCanApproveMessages object Deprecated. Use the whoCanModerateContent property instead.

Specifies who can approve pending messages in the moderation queue.

entry/apps:whoCanApproveMessages/text() string
entry/apps:whoCanAssignTopics object Deprecated. Use the whoCanAssistContent property instead.

Specifies who can assign topics in a forum to another user.

entry/apps:whoCanAssignTopics/text() string
entry/apps:whoCanAssistContent object Specifies who can manage content assistant controls. For example, assigning topics or entering tags. Possible values are:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE

This is a parent property that merges similar deprecated properties.

  • Attempts to GET an associated merged property returns the value of this parent property.
  • Attempts to UPDATE or PATCH this parent property overrides all associated deprecated properties to the same value.
  • Attempts to UPDATE or PATCH an associated deprecated property changes all associated deprecated properties, but only if the new value is less restrictive than the current parent property value.
entry/apps:whoCanAssistContent/text() string
entry/apps:whoCanBanUsers object Deprecated. Use the whoCanModerateMembers property instead.

Specifies who can deny membership to users.

entry/apps:whoCanBanUsers/text() string
entry/apps:whoCanContactOwner object Specifies who can contact the group owner. Possible values are:
  • ALL_IN_DOMAIN_CAN_CONTACT
  • ALL_MANAGERS_CAN_CONTACT
  • ALL_MEMBERS_CAN_CONTACT
  • ANYONE_CAN_CONTACT
entry/apps:whoCanContactOwner/text() string
entry/apps:whoCanDeleteAnyPost object Deprecated. Use the whoCanModerateContent property instead.

Specifies who can delete replies to topics.

(Authors can always delete their own posts). Possible values are:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanDeleteAnyPost/text() string
entry/apps:whoCanDeleteTopics object Deprecated. Use the whoCanModerateContent property instead.

Specifies who can delete topics.

entry/apps:whoCanDeleteTopics/text() string
entry/apps:whoCanDiscoverGroup object Specifies the set of users for whom this group is discoverable. Possible values are:
  • ANYONE_CAN_DISCOVER
  • ALL_IN_DOMAIN_CAN_DISCOVER
  • ALL_MEMBERS_CAN_DISCOVER
entry/apps:whoCanDiscoverGroup/text() string
entry/apps:whoCanEnterFreeFormTags object Deprecated. Use the whoCanAssistContent property instead.

Specifies who can enter free form tags for topics in a forum.

entry/apps:whoCanEnterFreeFormTags/text() string
entry/apps:whoCanHideAbuse object Deprecated. Use the whoCanModerateContent property instead.

Specifies who can hide posts by reporting them as abuse.

Possible values are:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE
entry/apps:whoCanHideAbuse/text() string
entry/apps:whoCanInvite object Deprecated. Use the whoCanModerateMembers property instead.

Permissions to invite new members.

entry/apps:whoCanInvite/text() string
entry/apps:whoCanJoin object Permission to join group. Possible values are:
  • ANYONE_CAN_JOIN: Anyone in the account domain can join. This includes accounts with multiple domains.
  • ALL_IN_DOMAIN_CAN_JOIN: Any Internet user who is outside your domain can access your Google Groups service and view the list of groups in your Groups directory.
  • INVITED_CAN_JOIN: Candidates for membership can be invited to join.
  • CAN_REQUEST_TO_JOIN: Non members can request an invitation to join.
entry/apps:whoCanJoin/text() string
entry/apps:whoCanLeaveGroup object Specifies who can leave the group. Possible values are:
  • ALL_MANAGERS_CAN_LEAVE
  • ALL_MEMBERS_CAN_LEAVE
  • NONE_CAN_LEAVE
entry/apps:whoCanLeaveGroup/text() string
entry/apps:whoCanLockTopics object Deprecated. Use the whoCanModerateContent property instead.

Specifies who can prevent users from posting replies to topics.

entry/apps:whoCanLockTopics/text() string
entry/apps:whoCanMakeTopicsSticky object Deprecated. Use the whoCanModerateContent property instead.

Specifies who can make topics appear at the top of the topic list.

entry/apps:whoCanMakeTopicsSticky/text() string
entry/apps:whoCanMarkDuplicate object Deprecated. Use the whoCanAssistContent property instead.

Specifies who can mark a topic as a duplicate of another topic.

entry/apps:whoCanMarkDuplicate/text() string
entry/apps:whoCanMarkFavoriteReplyOnAnyTopic object Deprecated. Use the whoCanAssistContent property instead.

Specifies who can mark any other user’s post as a favorite reply.

entry/apps:whoCanMarkFavoriteReplyOnAnyTopic/text() string
entry/apps:whoCanMarkFavoriteReplyOnOwnTopic object Deprecated. Use the whoCanAssistContent property instead.

Specifies who can mark a post for a topic they started as a favorite reply.

entry/apps:whoCanMarkFavoriteReplyOnOwnTopic/text() string
entry/apps:whoCanMarkNoResponseNeeded object Deprecated. Use the whoCanAssistContent property instead.

Specifies who can mark a topic as not needing a response.

entry/apps:whoCanMarkNoResponseNeeded/text() string
entry/apps:whoCanModerateContent object Specifies who can moderate content. For example, deleting topics or approving messages. Possible values are:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE

This is a parent property that merges similar deprecated properties.

  • Attempts to GET an associated merged property returns the value of this parent property.
  • Attempts to UPDATE or PATCH this parent property overrides all associated deprecated properties to the same value.
  • Attempts to UPDATE or PATCH an associated deprecated property changes all associated deprecated properties, but only if the new value is more restrictive than the current parent property value.
entry/apps:whoCanModerateContent/text() string
entry/apps:whoCanModerateMembers object Specifies who can manage members. For example, invite, add, or ban members. Possible values are:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE

This is a parent property that merges similar deprecated properties.

  • Attempts to GET an associated merged property returns the value of this parent property.
  • Attempts to UPDATE or PATCH this parent property overrides all associated deprecated properties to the same value.
  • Attempts to UPDATE or PATCH an associated deprecated property changes all associated deprecated properties, but only if the new value is more restrictive than the current parent property value.
entry/apps:whoCanModerateMembers/text() string
entry/apps:whoCanModifyMembers object Deprecated. Use the whoCanModerateMembers property instead.

Specifies who can change group members' roles.

entry/apps:whoCanModifyMembers/text() string
entry/apps:whoCanModifyTagsAndCategories object Deprecated. Use the whoCanAssistContent property instead.

Specifies who can change tags and categories.

entry/apps:whoCanModifyTagsAndCategories/text() string
entry/apps:whoCanMoveTopicsIn object Deprecated. Use the whoCanModerateContent property instead.

Specifies who can move topics into the group or forum.

entry/apps:whoCanMoveTopicsIn/text() string
entry/apps:whoCanMoveTopicsOut object Deprecated. Use the whoCanModerateContent property instead.

Specifies who can move topics out of the group or forum.

entry/apps:whoCanMoveTopicsOut/text() string
entry/apps:whoCanPostAnnouncements object Deprecated. Use the whoCanModerateContent property instead.

Specifies who can post announcements, a special topic type.

entry/apps:whoCanPostAnnouncements/text() string
entry/apps:whoCanPostMessage object Permissions to post messages. Possible values are:
  • NONE_CAN_POST: The group is disabled and archived. No one can post a message to this group.
    • When archiveOnly is false, updating whoCanPostMessage to NONE_CAN_POST, results in an error.
    • If archiveOnly is reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST.
  • ALL_MANAGERS_CAN_POST: Managers, including group owners, can post messages.
  • ALL_MEMBERS_CAN_POST: Any group member can post a message.
  • ALL_OWNERS_CAN_POST: Only group owners can post a message.
  • ALL_IN_DOMAIN_CAN_POST: Anyone in the account can post a message.
  • ANYONE_CAN_POST: Any Internet user who outside your account can access your Google Groups service and post a message.
entry/apps:whoCanPostMessage/text() string
entry/apps:whoCanTakeTopics object Deprecated. Use the whoCanAssistContent property instead.

Specifies who can take topics in a forum.

entry/apps:whoCanTakeTopics/text() string
entry/apps:whoCanUnassignTopic object Deprecated. Use the whoCanAssistContent property instead.

Specifies who can unassign any topic in a forum.

entry/apps:whoCanUnassignTopic/text() string
entry/apps:whoCanUnmarkFavoriteReplyOnAnyTopic object Deprecated. Use the whoCanAssistContent property instead.

Specifies who can un-mark any post from a favorite reply.

entry/apps:whoCanUnmarkFavoriteReplyOnAnyTopic/text() string
entry/apps:whoCanViewGroup object Permissions to view group messages. Possible values are:
  • ANYONE_CAN_VIEW: Any Internet user can view the group's messages.
  • ALL_IN_DOMAIN_CAN_VIEW: Anyone in your account can view this group's messages.
  • ALL_MEMBERS_CAN_VIEW: All group members can view the group's messages.
  • ALL_MANAGERS_CAN_VIEW: Any group manager can view this group's messages.
entry/apps:whoCanViewGroup/text() string
entry/apps:whoCanViewMembership object Permissions to view membership. Possible values are:
  • ALL_IN_DOMAIN_CAN_VIEW: Anyone in the account can view the group members list.

    If a group already has external members, those members can still send email to this group.

  • ALL_MEMBERS_CAN_VIEW: The group members can view the group members list.
  • ALL_MANAGERS_CAN_VIEW: The group managers can view group members list.
entry/apps:whoCanViewMembership/text() string
entry/author object Author tag for Atom entry
entry/author/name object Name of the author, which is Google
entry/author/name/text() string
entry/content object Content type of Atom entry
entry/content/text() string
entry/content/type string Content type of the Atom feed, which is text
entry/id object Unique identifier for a Group resource
entry/id/text() string
entry/title object Title of the API's Atom entry, which is Groups Resource Entry
entry/title/text() string
entry/xmlns string Schema for Atom format
entry/xmlns:apps string Schema for G Suite I/O format
entry/xmlns:gd string Schema for Google Data protocol

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
}
Property name Value Description Notes
allowExternalMembers string Identifies whether members external to your organization can join the group. Possible values are:
  • true: G Suite users external to your organization can become members of this group.
  • false: Users not belonging to the organization are not allowed to become members of this group.
allowGoogleCommunication string Deprecated. Allows Google to contact administrator of the group.
  • true: Allow Google to contact managers of this group. Occasionally Google may send updates on the latest features, ask for input on new features, or ask for permission to highlight your group.
  • false: Google can not contact managers of this group.
allowWebPosting string Allows posting from web. Possible values are:
  • true: Allows any member to post to the group forum.
  • false: Members only use Gmail to communicate with the group.
archiveOnly string Allows the group to be archived only. Possible values are:
  • true: Group is archived and the group is inactive. New messages to this group are rejected. The older archived messages are browseable and searchable.
    • If true, the whoCanPostMessage property is set to NONE_CAN_POST.
    • If reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST.
  • false: The group is active and can receive messages.
    • When false, updating whoCanPostMessage to NONE_CAN_POST, results in an error.
customFooterText string Set the content of custom footer text. The maximum number of characters is 1,000.
customReplyTo string An email address used when replying to a message if the replyTo property is set to REPLY_TO_CUSTOM. This address is defined by an account administrator.
  • When the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property holds a custom email address used when replying to a message.
  • If the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property must have a text value or an error is returned.
customRolesEnabledForSettingsToBeMerged string Specifies whether the group has a custom role that's included in one of the settings being merged. This field is read-only and update/patch requests to it are ignored. Possible values are:
  • true
  • false
defaultMessageDenyNotificationText string When a message is rejected, this is text for the rejection notification sent to the message's author. By default, this property is empty and has no value in the API's response body. The maximum notification text size is 10,000 characters.
description string Description of the group. This property value may be an empty string if no group description has been entered. If entered, the maximum group description is no more than 300 characters.
email string The group's email address. This property can be updated using the Directory API.
enableCollaborativeInbox string Specifies whether a collaborative inbox will remain turned on for the group. Possible values are:
  • true
  • false
favoriteRepliesOnTop string Indicates if favorite replies should be displayed above other replies.
  • true: Favorite replies will be displayed above other replies.
  • false: Favorite replies will not be displayed above other replies.
includeCustomFooter string Whether to include custom footer. Possible values are:
  • true
  • false
includeInGlobalAddressList string Enables the group to be included in the Global Address List. For more information, see the help center. Possible values are:
  • true: Group is included in the Global Address List.
  • false: Group is not included in the Global Address List.
isArchived string Allows the Group contents to be archived. Possible values are:
  • true: Archive messages sent to the group.
  • false: Do not keep an archive of messages sent to this group. If false, previously archived messages remain in the archive.
kind string The type of the resource. It is always groupsSettings#groups.
maxMessageBytes integer Deprecated. The maximum size of a message is 25Mb.
membersCanPostAsTheGroup string Enables members to post messages as the group. Possible values are:
  • true: Group member can post messages using the group's email address instead of their own email address. Message appear to originate from the group itself.
  • false: Members can not post in behalf of the group's email address.
messageDisplayFont string Deprecated. The default message display font always has a value of DEFAULT_FONT.
messageModerationLevel string Moderation level of incoming messages. Possible values are:
  • MODERATE_ALL_MESSAGES: All messages are sent to the group owner's email address for approval. If approved, the message is sent to the group.
  • MODERATE_NON_MEMBERS: All messages from non group members are sent to the group owner's email address for approval. If approved, the message is sent to the group.
  • MODERATE_NEW_MEMBERS: All messages from new members are sent to the group owner's email address for approval. If approved, the message is sent to the group.
  • MODERATE_NONE: No moderator approval is required. Messages are delivered directly to the group.
name string Name of the group, which has a maximum size of 75 characters.
primaryLanguage string The primary language for group. For a group's primary language use the language tags from the G Suite languages found at G Suite Email Settings API Email Language Tags.
replyTo string Specifies who receives the default reply. Possible values are:
  • REPLY_TO_CUSTOM: For replies to messages, use the group's custom email address.

    When the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property holds the custom email address used when replying to a message. If the group's ReplyTo property is set to REPLY_TO_CUSTOM, the customReplyTo property must have a value. Otherwise an error is returned.

  • REPLY_TO_SENDER: The reply sent to author of message.
  • REPLY_TO_LIST: This reply message is sent to the group.
  • REPLY_TO_OWNER: The reply is sent to the owner(s) of the group. This does not include the group's managers.
  • REPLY_TO_IGNORE: Group users individually decide where the message reply is sent.
  • REPLY_TO_MANAGERS: This reply message is sent to the group's managers, which includes all managers and the group owner.
sendMessageDenyNotification string Allows a member to be notified if the member's message to the group is denied by the group owner. Possible values are:
  • true: When a message is rejected, send the deny message notification to the message author.

    The defaultMessageDenyNotificationText property is dependent on the sendMessageDenyNotification property being true.

  • false: When a message is rejected, no notification is sent.
showInGroupDirectory string Deprecated. Use the whoCanDiscoverGroup property instead.

Allows the group to be visible in the Groups Directory.

Possible values are:
  • true: All groups in the account are listed in the Groups directory.
  • false: All groups in the account are not listed in the directory.
spamModerationLevel string Specifies moderation levels for messages detected as spam. Possible values are:
  • ALLOW: Post the message to the group.
  • MODERATE: Send the message to the moderation queue. This is the default.
  • SILENTLY_MODERATE: Send the message to the moderation queue, but do not send notification to moderators.
  • REJECT: Immediately reject the message.
whoCanAdd string Deprecated. Use the whoCanModerateMembers property instead.

Permissions to add members.

whoCanAddReferences string Deprecated. Permission to add references to a topic. This functionality is no longer supported in the Google Groups UI. The value is always NONE.
whoCanApproveMembers string
whoCanApproveMessages string Deprecated. Use the whoCanModerateContent property instead.

Specifies who can approve pending messages in the moderation queue.

whoCanAssignTopics string Deprecated. Use the whoCanAssistContent property instead.

Permission to assign topics in a forum to another user.

whoCanAssistContent string Specifies who can manage content assistant controls. For example, assigning topics or entering tags. Possible values are:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • MANAGERS_ONLY
  • OWNERS_ONLY
  • NONE

This is a parent property that merges similar deprecated properties.

  • Attempts to GET an associated merged property returns the value of this parent property.
  • Attempts to UPDATE or PATCH this parent property overrides all associated deprecated properties to the same value.
  • Attempts to UPDATE or PATCH an associated deprecated property changes all associated deprecated properties, but only if the new value is less restrictive than the current parent property value.
whoCanBanUsers string Deprecated. Use the whoCanModerateMembers property instead.

Specifies who can deny membership to users.

whoCanContactOwner string Permission to contact owner of the group via web UI. Possible values are:
  • ALL_IN_DOMAIN_CAN_CONTACT
  • ALL_MANAGERS_CAN_CONTACT
  • ALL_MEMBERS_CAN_CONTACT
  • ANYONE_CAN_CONTACT
whoCanDeleteAnyPost string Deprecated. Use the whoCanModerateContent property instead.

Specifies who can delete replies to topics.

Authors can always delete their own posts.
whoCanDeleteTopics string Deprecated. Use the whoCanModerateContent property instead.

Specifies who can delete topics.

whoCanDiscoverGroup string Specifies the set of users for whom this group is discoverable. Possible values are:
  • ANYONE_CAN_DISCOVER
  • ALL_IN_DOMAIN_CAN_DISCOVER
  • ALL_MEMBERS_CAN_DISCOVER
whoCanEnterFreeFormTags string Deprecated. Use the whoCanAssistContent property instead.

Permission to enter free form tags for topics in a forum.

whoCanHideAbuse string Deprecated. Use the whoCanAssistContent property instead.

Specifies who can hide posts by reporting them as abuse.

whoCanInvite string Deprecated. Use the whoCanModerateMembers property instead.

Permissions to invite new members.

whoCanJoin string Permission to join group. Possible values are:
  • ANYONE_CAN_JOIN: Anyone in the account domain can join. This includes accounts with multiple domains.
  • ALL_IN_DOMAIN_CAN_JOIN: Any Internet user who is outside your domain can access your Google Groups service and view the list of groups in your Groups directory.
  • INVITED_CAN_JOIN: Candidates for membership can be invited to join.
  • CAN_REQUEST_TO_JOIN: Non members can request an invitation to join.
whoCanLeaveGroup string Permission to leave the group. Possible values are:
  • ALL_MANAGERS_CAN_LEAVE
  • ALL_MEMBERS_CAN_LEAVE
  • NONE_CAN_LEAVE
whoCanLockTopics string Deprecated. Use the whoCanModerateContent property instead.

Specifies who can prevent users from posting replies to topics.

whoCanMakeTopicsSticky string Deprecated. Use the whoCanAssistContent property instead.

Specifies who can make topics appear at the top of the topic list.

whoCanMarkDuplicate string Deprecated. Use the whoCanAssistContent property instead.

Permission to mark a topic as a duplicate of another topic.

whoCanMarkFavoriteReplyOnAnyTopic string Deprecated. Use the whoCanAssistContent property instead.

Permission to mark any other user's post as a favorite reply.

whoCanMarkFavoriteReplyOnOwnTopic string Deprecated. Use the whoCanAssistContent property instead.

Permission to mark a post for a topic they started as a favorite reply.

whoCanMarkNoResponseNeeded string Deprecated. Use the whoCanAssistContent property instead.

Permission to mark a topic as not needing a response.

whoCanModerateContent string Specifies who can moderate content. For example, deleting topics or approving messages. Possible values are:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE

This is a parent property that merges similar deprecated properties.

  • Attempts to GET an associated merged property returns the value of this parent property.
  • Attempts to UPDATE or PATCH this parent property overrides all associated deprecated properties to the same value.
  • Attempts to UPDATE or PATCH an associated deprecated property changes all associated deprecated properties, but only if the new value is more restrictive than the current parent property value.
whoCanModerateMembers string Specifies who can manage members. For example, invite, add, or ban members. Possible values are:
  • ALL_MEMBERS
  • OWNERS_AND_MANAGERS
  • OWNERS_ONLY
  • NONE

This is a parent property that merges similar deprecated properties.

  • Attempts to GET an associated merged property returns the value of this parent property.
  • Attempts to UPDATE or PATCH this parent property overrides all associated deprecated properties to the same value.
  • Attempts to UPDATE or PATCH an associated deprecated property changes all associated deprecated properties, but only if the new value is more restrictive than the current parent property value.
whoCanModifyMembers string Deprecated. Use the whoCanModerateMembers property instead.

Specifies who can change group members' roles.

whoCanModifyTagsAndCategories string Deprecated. Use the whoCanAssistContent property instead.

Permission to change tags and categories.

whoCanMoveTopicsIn string Deprecated. Use the whoCanModerateContent property instead.

Specifies who can move topics into the group or forum.

whoCanMoveTopicsOut string Deprecated. Use the whoCanModerateContent property instead.

Specifies who can move topics out of the group or forum.

whoCanPostAnnouncements string Deprecated. Use the whoCanModerateContent property instead.

Specifies who can post announcements, a special topic type.

whoCanPostMessage string Permissions to post messages. Possible values are:
  • NONE_CAN_POST: The group is disabled and archived. No one can post a message to this group.
    • When archiveOnly is false, updating whoCanPostMessage to NONE_CAN_POST, results in an error.
    • If archiveOnly is reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST.
  • ALL_MANAGERS_CAN_POST: Managers, including group owners, can post messages.
  • ALL_MEMBERS_CAN_POST: Any group member can post a message.
  • ALL_OWNERS_CAN_POST: Only group owners can post a message.
  • ALL_IN_DOMAIN_CAN_POST: Anyone in the account can post a message.
  • ANYONE_CAN_POST: Any Internet user who outside your account can access your Google Groups service and post a message.
whoCanTakeTopics string Deprecated. Use the whoCanAssistContent property instead.

Permission to take topics in a forum.

whoCanUnassignTopic string Deprecated. Use the whoCanAssistContent property instead.

Permission to unassign any topic in a forum.

whoCanUnmarkFavoriteReplyOnAnyTopic string Deprecated. Use the whoCanAssistContent property instead.

Permission to unmark any post from a favorite reply.

whoCanViewGroup string Permissions to view group messages. Possible values are:
  • ANYONE_CAN_VIEW: Any Internet user can view the group's messages.
  • ALL_IN_DOMAIN_CAN_VIEW: Anyone in your account can view this group's messages.
  • ALL_MEMBERS_CAN_VIEW: All group members can view the group's messages.
  • ALL_MANAGERS_CAN_VIEW: Any group manager can view this group's messages.
whoCanViewMembership string Permissions to view membership. Possible values are:
  • ALL_IN_DOMAIN_CAN_VIEW: Anyone in the account can view the group members list.

    If a group already has external members, those members can still send email to this group.

  • ALL_MEMBERS_CAN_VIEW: The group members can view the group members list.
  • ALL_MANAGERS_CAN_VIEW: The group managers can view group members list.

Methods

The groupsSettings.groups.get and groupsSettings.groups.update methods operate on a specified Groups Resource.

get
Retrieves a group's settings identified by the group email address.
patch
Updates an existing resource. This method supports patch semantics.
update
Updates an existing group's settings, which is identified by the group email address.

Palautteen aihe:

Tämä sivu
Groups Settings API
Groups Settings API
Tarvitsetko apua? Siirry tukisivullemme.