Blame - docs/dyn/groupssettings_v1.groups.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

372

<code class="details" id="patch">patch(groupUniqueId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

373

<pre>Updates an existing resource. This method supports patch semantics.

374

375

Args:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

376

groupUniqueId: string, The group's email address. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

377

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

378

The object takes the form of:

379

380

{ # JSON template for Group resource

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

381

"allowExternalMembers": "A String", # Identifies whether members external to your organization can join the group. Possible values are:

382

# - true: G Suite users external to your organization can become members of this group.

383

# - false: Users not belonging to the organization are not allowed to become members of this group.

384

"allowGoogleCommunication": "A String", # Deprecated. Allows Google to contact administrator of the group.

385

# - 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.

386

# - false: Google can not contact managers of this group.

387

"allowWebPosting": "A String", # Allows posting from web. Possible values are:

388

# - true: Allows any member to post to the group forum.

389

# - false: Members only use Gmail to communicate with the group.

390

"archiveOnly": "A String", # Allows the group to be archived only. Possible values are:

391

# - true: Group is archived and the group is inactive. New messages to this group are rejected. The older archived messages are browseable and searchable.

392

# - If true, the whoCanPostMessage property is set to NONE_CAN_POST.

393

# - If reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST.

394

# - false: The group is active and can receive messages.

395

# - When false, updating whoCanPostMessage to NONE_CAN_POST, results in an error.

396

"customFooterText": "A String", # Set the content of custom footer text. The maximum number of characters is 1,000.

397

"customReplyTo": "A 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.

398

# - 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.

399

# - 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.

400

"customRolesEnabledForSettingsToBeMerged": "A 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:

401

# - true

402

# - false

403

"defaultMessageDenyNotificationText": "A 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. Note: Requires sendMessageDenyNotification property to be true.

404

"description": "A 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.

405

"email": "A String", # The group's email address. This property can be updated using the Directory API. Note: Only a group owner can change a group's email address. A group manager can't do this.

406

# When you change your group's address using the Directory API or the control panel, you are changing the address your subscribers use to send email and the web address people use to access your group. People can't reach your group by visiting the old address.

407

"enableCollaborativeInbox": "A String", # Specifies whether a collaborative inbox will remain turned on for the group. Possible values are:

408

# - true

409

# - false

410

"favoriteRepliesOnTop": "A String", # Indicates if favorite replies should be displayed above other replies.

411

# - true: Favorite replies will be displayed above other replies.

412

# - false: Favorite replies will not be displayed above other replies.

413

"includeCustomFooter": "A String", # Whether to include custom footer. Possible values are:

414

# - true

415

# - false

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

416

"includeInGlobalAddressList": "A String", # Enables the group to be included in the Global Address List. For more information, see the help center. Possible values are:

417

# - true: Group is included in the Global Address List.

418

# - false: Group is not included in the Global Address List.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

419

"isArchived": "A String", # Allows the Group contents to be archived. Possible values are:

420

# - true: Archive messages sent to the group.

421

# - false: Do not keep an archive of messages sent to this group. If false, previously archived messages remain in the archive.

422

"kind": "groupsSettings#groups", # The type of the resource. It is always groupsSettings#groups.

423

"maxMessageBytes": 42, # Deprecated. The maximum size of a message is 25Mb.

424

"membersCanPostAsTheGroup": "A String", # Enables members to post messages as the group. Possible values are:

425

# - 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. Note: When true, any message moderation settings on individual users or new members do not apply to posts made on behalf of the group.

426

# - false: Members can not post in behalf of the group's email address.

427

"messageDisplayFont": "A String", # Deprecated. The default message display font always has a value of "DEFAULT_FONT".

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

428

"messageModerationLevel": "A String", # Moderation level of incoming messages. Possible values are:

429

# - 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.

430

# - 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.

431

# - 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.

432

# - MODERATE_NONE: No moderator approval is required. Messages are delivered directly to the group. Note: When the whoCanPostMessage is set to ANYONE_CAN_POST, we recommend the messageModerationLevel be set to MODERATE_NON_MEMBERS to protect the group from possible spam.

433

# When memberCanPostAsTheGroup is true, any message moderation settings on individual users or new members will not apply to posts made on behalf of the group.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

434

"name": "A String", # Name of the group, which has a maximum size of 75 characters.

435

"primaryLanguage": "A 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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

436

"replyTo": "A String", # Specifies who receives the default reply. Possible values are:

437

# - REPLY_TO_CUSTOM: For replies to messages, use the group's custom email address.

438

# 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.

439

#

440

# - REPLY_TO_SENDER: The reply sent to author of message.

441

# - REPLY_TO_LIST: This reply message is sent to the group.

442

# - REPLY_TO_OWNER: The reply is sent to the owner(s) of the group. This does not include the group's managers.

443

# - REPLY_TO_IGNORE: Group users individually decide where the message reply is sent.

444

# - REPLY_TO_MANAGERS: This reply message is sent to the group's managers, which includes all managers and the group owner.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

445

"sendMessageDenyNotification": "A String", # Allows a member to be notified if the member's message to the group is denied by the group owner. Possible values are:

446

# - true: When a message is rejected, send the deny message notification to the message author.

447

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

448

#

449

# - false: When a message is rejected, no notification is sent.

450

"showInGroupDirectory": "A String", # Deprecated. This is merged into the new whoCanDiscoverGroup setting. Allows the group to be visible in the Groups Directory. Possible values are:

451

# - true: All groups in the account are listed in the Groups directory.

452

# - false: All groups in the account are not listed in the directory.

453

"spamModerationLevel": "A String", # Specifies moderation levels for messages detected as spam. Possible values are:

454

# - ALLOW: Post the message to the group.

455

# - MODERATE: Send the message to the moderation queue. This is the default.

456

# - SILENTLY_MODERATE: Send the message to the moderation queue, but do not send notification to moderators.

457

# - REJECT: Immediately reject the message.

458

"whoCanAdd": "A String", # Deprecated. This is merged into the new whoCanModerateMembers setting. Permissions to add members. Possible values are:

459

# - ALL_MEMBERS_CAN_ADD: Managers and members can directly add new members.

460

# - ALL_MANAGERS_CAN_ADD: Only managers can directly add new members. this includes the group's owner.

461

# - ALL_OWNERS_CAN_ADD: Only owners can directly add new members.

462

# - NONE_CAN_ADD: No one can directly add new members.

463

"whoCanAddReferences": "A String", # Deprecated. This functionality is no longer supported in the Google Groups UI. The value is always "NONE".

464

"whoCanApproveMembers": "A String", # Specifies who can approve members who ask to join groups. This permission will be deprecated once it is merged into the new whoCanModerateMembers setting. Possible values are:

465

# - ALL_MEMBERS_CAN_APPROVE

466

# - ALL_MANAGERS_CAN_APPROVE

467

# - ALL_OWNERS_CAN_APPROVE

468

# - NONE_CAN_APPROVE

469

"whoCanApproveMessages": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can approve pending messages in the moderation queue. Possible values are:

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

470

# - ALL_MEMBERS

471

# - OWNERS_AND_MANAGERS

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

472

# - OWNERS_ONLY

473

# - NONE

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

474

"whoCanAssignTopics": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to assign topics in a forum to another user. Possible values are:

475

# - ALL_MEMBERS

476

# - OWNERS_AND_MANAGERS

477

# - MANAGERS_ONLY

478

# - OWNERS_ONLY

479

# - NONE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

480

"whoCanAssistContent": "A String", # Specifies who can moderate metadata. Possible values are:

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

481

# - ALL_MEMBERS

482

# - OWNERS_AND_MANAGERS

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

483

# - MANAGERS_ONLY

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

484

# - OWNERS_ONLY

485

# - NONE

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

486

"whoCanBanUsers": "A String", # Specifies who can deny membership to users. This permission will be deprecated once it is merged into the new whoCanModerateMembers setting. Possible values are:

487

# - ALL_MEMBERS

488

# - OWNERS_AND_MANAGERS

489

# - OWNERS_ONLY

490

# - NONE

491

"whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are:

492

# - ALL_IN_DOMAIN_CAN_CONTACT

493

# - ALL_MANAGERS_CAN_CONTACT

494

# - ALL_MEMBERS_CAN_CONTACT

495

# - ANYONE_CAN_CONTACT

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

496

"whoCanDeleteAnyPost": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can delete replies to topics. (Authors can always delete their own posts). Possible values are:

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

497

# - ALL_MEMBERS

498

# - OWNERS_AND_MANAGERS

499

# - OWNERS_ONLY

500

# - NONE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

501

"whoCanDeleteTopics": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can delete topics. Possible values are:

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

502

# - ALL_MEMBERS

503

# - OWNERS_AND_MANAGERS

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

504

# - OWNERS_ONLY

505

# - NONE

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

506

"whoCanDiscoverGroup": "A String", # Specifies the set of users for whom this group is discoverable. Possible values are:

507

# - ANYONE_CAN_DISCOVER

508

# - ALL_IN_DOMAIN_CAN_DISCOVER

509

# - ALL_MEMBERS_CAN_DISCOVER

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

510

"whoCanEnterFreeFormTags": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to enter free form tags for topics in a forum. Possible values are:

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

511

# - ALL_MEMBERS

512

# - OWNERS_AND_MANAGERS

513

# - MANAGERS_ONLY

514

# - OWNERS_ONLY

515

# - NONE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

516

"whoCanHideAbuse": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can hide posts by reporting them as abuse. Possible values are:

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

517

# - ALL_MEMBERS

518

# - OWNERS_AND_MANAGERS

519

# - OWNERS_ONLY

520

# - NONE

521

"whoCanInvite": "A String", # Deprecated. This is merged into the new whoCanModerateMembers setting. Permissions to invite new members. Possible values are:

522

# - ALL_MEMBERS_CAN_INVITE: Managers and members can invite a new member candidate.

523

# - ALL_MANAGERS_CAN_INVITE: Only managers can invite a new member. This includes the group's owner.

524

# - ALL_OWNERS_CAN_INVITE: Only owners can invite a new member.

525

# - NONE_CAN_INVITE: No one can invite a new member candidate.

526

"whoCanJoin": "A String", # Permission to join group. Possible values are:

527

# - ANYONE_CAN_JOIN: Anyone in the account domain can join. This includes accounts with multiple domains.

528

# - 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. Warning: Group owners can add external addresses, outside of the domain to their groups. They can also allow people outside your domain to join their groups. If you later disable this option, any external addresses already added to users' groups remain in those groups.

529

# - INVITED_CAN_JOIN: Candidates for membership can be invited to join.

530

# - CAN_REQUEST_TO_JOIN: Non members can request an invitation to join.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

531

"whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are:

532

# - ALL_MANAGERS_CAN_LEAVE

533

# - ALL_MEMBERS_CAN_LEAVE

534

# - NONE_CAN_LEAVE

535

"whoCanLockTopics": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can prevent users from posting replies to topics. Possible values are:

536

# - ALL_MEMBERS

537

# - OWNERS_AND_MANAGERS

538

# - OWNERS_ONLY

539

# - NONE

540

"whoCanMakeTopicsSticky": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can make topics appear at the top of the topic list. Possible values are:

541

# - ALL_MEMBERS

542

# - OWNERS_AND_MANAGERS

543

# - OWNERS_ONLY

544

# - NONE

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

545

"whoCanMarkDuplicate": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a topic as a duplicate of another topic. Possible values are:

546

# - ALL_MEMBERS

547

# - OWNERS_AND_MANAGERS

548

# - MANAGERS_ONLY

549

# - OWNERS_ONLY

550

# - NONE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

551

"whoCanMarkFavoriteReplyOnAnyTopic": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark any other user's post as a favorite reply. Possible values are:

552

# - ALL_MEMBERS

553

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanMarkFavoriteReplyOnOwnTopic": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a post for a topic they started as a favorite reply. Possible values are:

558

# - ALL_MEMBERS

559

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanMarkNoResponseNeeded": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a topic as not needing a response. Possible values are:

564

# - ALL_MEMBERS

565

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanModerateContent": "A String", # Specifies who can moderate content. Possible values are:

570

# - ALL_MEMBERS

571

# - OWNERS_AND_MANAGERS

572

# - OWNERS_ONLY

573

# - NONE

574

"whoCanModerateMembers": "A String", # Specifies who can manage members. Possible values are:

575

# - ALL_MEMBERS

576

# - OWNERS_AND_MANAGERS

577

# - OWNERS_ONLY

578

# - NONE

579

"whoCanModifyMembers": "A String", # Deprecated. This is merged into the new whoCanModerateMembers setting. Specifies who can change group members' roles. Possible values are:

580

# - ALL_MEMBERS

581

# - OWNERS_AND_MANAGERS

582

# - OWNERS_ONLY

583

# - NONE

584

"whoCanModifyTagsAndCategories": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to change tags and categories. Possible values are:

585

# - ALL_MEMBERS

586

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanMoveTopicsIn": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can move topics into the group or forum. Possible values are:

591

# - ALL_MEMBERS

592

# - OWNERS_AND_MANAGERS

593

# - OWNERS_ONLY

594

# - NONE

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

595

"whoCanMoveTopicsOut": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can move topics out of the group or forum. Possible values are:

596

# - ALL_MEMBERS

597

# - OWNERS_AND_MANAGERS

598

# - OWNERS_ONLY

599

# - NONE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

600

"whoCanPostAnnouncements": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can post announcements, a special topic type. Possible values are:

601

# - ALL_MEMBERS

602

# - OWNERS_AND_MANAGERS

603

# - OWNERS_ONLY

604

# - NONE

605

"whoCanPostMessage": "A String", # Permissions to post messages. Possible values are:

606

# - NONE_CAN_POST: The group is disabled and archived. No one can post a message to this group.

607

# - When archiveOnly is false, updating whoCanPostMessage to NONE_CAN_POST, results in an error.

608

# - If archiveOnly is reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST.

609

# - ALL_MANAGERS_CAN_POST: Managers, including group owners, can post messages.

610

# - ALL_MEMBERS_CAN_POST: Any group member can post a message.

611

# - ALL_OWNERS_CAN_POST: Only group owners can post a message.

612

# - ALL_IN_DOMAIN_CAN_POST: Anyone in the account can post a message.

613

# - ANYONE_CAN_POST: Any Internet user who outside your account can access your Google Groups service and post a message. Note: When whoCanPostMessage is set to ANYONE_CAN_POST, we recommend the messageModerationLevel be set to MODERATE_NON_MEMBERS to protect the group from possible spam.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

614

"whoCanTakeTopics": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to take topics in a forum. Possible values are:

615

# - ALL_MEMBERS

616

# - OWNERS_AND_MANAGERS

617

# - MANAGERS_ONLY

618

# - OWNERS_ONLY

619

# - NONE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

620

"whoCanUnassignTopic": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to unassign any topic in a forum. Possible values are:

621

# - ALL_MEMBERS

622

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanUnmarkFavoriteReplyOnAnyTopic": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to unmark any post from a favorite reply. Possible values are:

627

# - ALL_MEMBERS

628

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanViewGroup": "A String", # Permissions to view group messages. Possible values are:

633

# - ANYONE_CAN_VIEW: Any Internet user can view the group's messages.

634

# - ALL_IN_DOMAIN_CAN_VIEW: Anyone in your account can view this group's messages.

635

# - ALL_MEMBERS_CAN_VIEW: All group members can view the group's messages.

636

# - ALL_MANAGERS_CAN_VIEW: Any group manager can view this group's messages.

637

"whoCanViewMembership": "A String", # Permissions to view membership. Possible values are:

638

# - ALL_IN_DOMAIN_CAN_VIEW: Anyone in the account can view the group members list.

639

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

640

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

641

# - ALL_MEMBERS_CAN_VIEW: The group members can view the group members list.

642

# - ALL_MANAGERS_CAN_VIEW: The group managers can view group members list.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

}

Returns:

An object of the form:

648

649

{ # JSON template for Group resource

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

650

"allowExternalMembers": "A String", # Identifies whether members external to your organization can join the group. Possible values are:

651

# - true: G Suite users external to your organization can become members of this group.

652

# - false: Users not belonging to the organization are not allowed to become members of this group.

653

"allowGoogleCommunication": "A String", # Deprecated. Allows Google to contact administrator of the group.

654

# - 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.

655

# - false: Google can not contact managers of this group.

656

"allowWebPosting": "A String", # Allows posting from web. Possible values are:

657

# - true: Allows any member to post to the group forum.

658

# - false: Members only use Gmail to communicate with the group.

659

"archiveOnly": "A String", # Allows the group to be archived only. Possible values are:

660

# - true: Group is archived and the group is inactive. New messages to this group are rejected. The older archived messages are browseable and searchable.

661

# - If true, the whoCanPostMessage property is set to NONE_CAN_POST.

662

# - If reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST.

663

# - false: The group is active and can receive messages.

664

# - When false, updating whoCanPostMessage to NONE_CAN_POST, results in an error.

665

"customFooterText": "A String", # Set the content of custom footer text. The maximum number of characters is 1,000.

666

"customReplyTo": "A 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.

667

# - 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.

668

# - 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.

669

"customRolesEnabledForSettingsToBeMerged": "A 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:

670

# - true

671

# - false

672

"defaultMessageDenyNotificationText": "A 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. Note: Requires sendMessageDenyNotification property to be true.

673

"description": "A 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.

674

"email": "A String", # The group's email address. This property can be updated using the Directory API. Note: Only a group owner can change a group's email address. A group manager can't do this.

675

# When you change your group's address using the Directory API or the control panel, you are changing the address your subscribers use to send email and the web address people use to access your group. People can't reach your group by visiting the old address.

676

"enableCollaborativeInbox": "A String", # Specifies whether a collaborative inbox will remain turned on for the group. Possible values are:

677

# - true

678

# - false

679

"favoriteRepliesOnTop": "A String", # Indicates if favorite replies should be displayed above other replies.

680

# - true: Favorite replies will be displayed above other replies.

681

# - false: Favorite replies will not be displayed above other replies.

682

"includeCustomFooter": "A String", # Whether to include custom footer. Possible values are:

683

# - true

684

# - false

685

"includeInGlobalAddressList": "A String", # Enables the group to be included in the Global Address List. For more information, see the help center. Possible values are:

686

# - true: Group is included in the Global Address List.

687

# - false: Group is not included in the Global Address List.

688

"isArchived": "A String", # Allows the Group contents to be archived. Possible values are:

689

# - true: Archive messages sent to the group.

690

# - false: Do not keep an archive of messages sent to this group. If false, previously archived messages remain in the archive.

691

"kind": "groupsSettings#groups", # The type of the resource. It is always groupsSettings#groups.

692

"maxMessageBytes": 42, # Deprecated. The maximum size of a message is 25Mb.

693

"membersCanPostAsTheGroup": "A String", # Enables members to post messages as the group. Possible values are:

694

# - 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. Note: When true, any message moderation settings on individual users or new members do not apply to posts made on behalf of the group.

695

# - false: Members can not post in behalf of the group's email address.

696

"messageDisplayFont": "A String", # Deprecated. The default message display font always has a value of "DEFAULT_FONT".

697

"messageModerationLevel": "A String", # Moderation level of incoming messages. Possible values are:

698

# - 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.

699

# - 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.

700

# - 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.

701

# - MODERATE_NONE: No moderator approval is required. Messages are delivered directly to the group. Note: When the whoCanPostMessage is set to ANYONE_CAN_POST, we recommend the messageModerationLevel be set to MODERATE_NON_MEMBERS to protect the group from possible spam.

702

# When memberCanPostAsTheGroup is true, any message moderation settings on individual users or new members will not apply to posts made on behalf of the group.

703

"name": "A String", # Name of the group, which has a maximum size of 75 characters.

704

"primaryLanguage": "A 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.

705

"replyTo": "A String", # Specifies who receives the default reply. Possible values are:

706

# - REPLY_TO_CUSTOM: For replies to messages, use the group's custom email address.

707

# 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.

708

#

709

# - REPLY_TO_SENDER: The reply sent to author of message.

710

# - REPLY_TO_LIST: This reply message is sent to the group.

711

# - REPLY_TO_OWNER: The reply is sent to the owner(s) of the group. This does not include the group's managers.

712

# - REPLY_TO_IGNORE: Group users individually decide where the message reply is sent.

713

# - REPLY_TO_MANAGERS: This reply message is sent to the group's managers, which includes all managers and the group owner.

714

"sendMessageDenyNotification": "A String", # Allows a member to be notified if the member's message to the group is denied by the group owner. Possible values are:

715

# - true: When a message is rejected, send the deny message notification to the message author.

716

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

717

#

718

# - false: When a message is rejected, no notification is sent.

719

"showInGroupDirectory": "A String", # Deprecated. This is merged into the new whoCanDiscoverGroup setting. Allows the group to be visible in the Groups Directory. Possible values are:

720

# - true: All groups in the account are listed in the Groups directory.

721

# - false: All groups in the account are not listed in the directory.

722

"spamModerationLevel": "A String", # Specifies moderation levels for messages detected as spam. Possible values are:

723

# - ALLOW: Post the message to the group.

724

# - MODERATE: Send the message to the moderation queue. This is the default.

725

# - SILENTLY_MODERATE: Send the message to the moderation queue, but do not send notification to moderators.

726

# - REJECT: Immediately reject the message.

727

"whoCanAdd": "A String", # Deprecated. This is merged into the new whoCanModerateMembers setting. Permissions to add members. Possible values are:

728

# - ALL_MEMBERS_CAN_ADD: Managers and members can directly add new members.

729

# - ALL_MANAGERS_CAN_ADD: Only managers can directly add new members. this includes the group's owner.

730

# - ALL_OWNERS_CAN_ADD: Only owners can directly add new members.

731

# - NONE_CAN_ADD: No one can directly add new members.

732

"whoCanAddReferences": "A String", # Deprecated. This functionality is no longer supported in the Google Groups UI. The value is always "NONE".

733

"whoCanApproveMembers": "A String", # Specifies who can approve members who ask to join groups. This permission will be deprecated once it is merged into the new whoCanModerateMembers setting. Possible values are:

734

# - ALL_MEMBERS_CAN_APPROVE

735

# - ALL_MANAGERS_CAN_APPROVE

736

# - ALL_OWNERS_CAN_APPROVE

737

# - NONE_CAN_APPROVE

738

"whoCanApproveMessages": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can approve pending messages in the moderation queue. Possible values are:

739

# - ALL_MEMBERS

740

# - OWNERS_AND_MANAGERS

741

# - OWNERS_ONLY

742

# - NONE

743

"whoCanAssignTopics": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to assign topics in a forum to another user. Possible values are:

744

# - ALL_MEMBERS

745

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanAssistContent": "A String", # Specifies who can moderate metadata. Possible values are:

750

# - ALL_MEMBERS

751

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanBanUsers": "A String", # Specifies who can deny membership to users. This permission will be deprecated once it is merged into the new whoCanModerateMembers setting. Possible values are:

756

# - ALL_MEMBERS

757

# - OWNERS_AND_MANAGERS

758

# - OWNERS_ONLY

759

# - NONE

760

"whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are:

761

# - ALL_IN_DOMAIN_CAN_CONTACT

762

# - ALL_MANAGERS_CAN_CONTACT

763

# - ALL_MEMBERS_CAN_CONTACT

764

# - ANYONE_CAN_CONTACT

765

"whoCanDeleteAnyPost": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can delete replies to topics. (Authors can always delete their own posts). Possible values are:

766

# - ALL_MEMBERS

767

# - OWNERS_AND_MANAGERS

768

# - OWNERS_ONLY

769

# - NONE

770

"whoCanDeleteTopics": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can delete topics. Possible values are:

771

# - ALL_MEMBERS

772

# - OWNERS_AND_MANAGERS

773

# - OWNERS_ONLY

774

# - NONE

775

"whoCanDiscoverGroup": "A String", # Specifies the set of users for whom this group is discoverable. Possible values are:

776

# - ANYONE_CAN_DISCOVER

777

# - ALL_IN_DOMAIN_CAN_DISCOVER

778

# - ALL_MEMBERS_CAN_DISCOVER

779

"whoCanEnterFreeFormTags": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to enter free form tags for topics in a forum. Possible values are:

780

# - ALL_MEMBERS

781

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanHideAbuse": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can hide posts by reporting them as abuse. Possible values are:

786

# - ALL_MEMBERS

787

# - OWNERS_AND_MANAGERS

788

# - OWNERS_ONLY

789

# - NONE

790

"whoCanInvite": "A String", # Deprecated. This is merged into the new whoCanModerateMembers setting. Permissions to invite new members. Possible values are:

791

# - ALL_MEMBERS_CAN_INVITE: Managers and members can invite a new member candidate.

792

# - ALL_MANAGERS_CAN_INVITE: Only managers can invite a new member. This includes the group's owner.

793

# - ALL_OWNERS_CAN_INVITE: Only owners can invite a new member.

794

# - NONE_CAN_INVITE: No one can invite a new member candidate.

795

"whoCanJoin": "A String", # Permission to join group. Possible values are:

796

# - ANYONE_CAN_JOIN: Anyone in the account domain can join. This includes accounts with multiple domains.

797

# - 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. Warning: Group owners can add external addresses, outside of the domain to their groups. They can also allow people outside your domain to join their groups. If you later disable this option, any external addresses already added to users' groups remain in those groups.

798

# - INVITED_CAN_JOIN: Candidates for membership can be invited to join.

799

# - CAN_REQUEST_TO_JOIN: Non members can request an invitation to join.

800

"whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are:

801

# - ALL_MANAGERS_CAN_LEAVE

802

# - ALL_MEMBERS_CAN_LEAVE

803

# - NONE_CAN_LEAVE

804

"whoCanLockTopics": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can prevent users from posting replies to topics. Possible values are:

805

# - ALL_MEMBERS

806

# - OWNERS_AND_MANAGERS

807

# - OWNERS_ONLY

808

# - NONE

809

"whoCanMakeTopicsSticky": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can make topics appear at the top of the topic list. Possible values are:

810

# - ALL_MEMBERS

811

# - OWNERS_AND_MANAGERS

812

# - OWNERS_ONLY

813

# - NONE

814

"whoCanMarkDuplicate": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a topic as a duplicate of another topic. Possible values are:

815

# - ALL_MEMBERS

816

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanMarkFavoriteReplyOnAnyTopic": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark any other user's post as a favorite reply. Possible values are:

821

# - ALL_MEMBERS

822

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanMarkFavoriteReplyOnOwnTopic": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a post for a topic they started as a favorite reply. Possible values are:

827

# - ALL_MEMBERS

828

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanMarkNoResponseNeeded": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a topic as not needing a response. Possible values are:

833

# - ALL_MEMBERS

834

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanModerateContent": "A String", # Specifies who can moderate content. Possible values are:

839

# - ALL_MEMBERS

840

# - OWNERS_AND_MANAGERS

841

# - OWNERS_ONLY

842

# - NONE

843

"whoCanModerateMembers": "A String", # Specifies who can manage members. Possible values are:

844

# - ALL_MEMBERS

845

# - OWNERS_AND_MANAGERS

846

# - OWNERS_ONLY

847

# - NONE

848

"whoCanModifyMembers": "A String", # Deprecated. This is merged into the new whoCanModerateMembers setting. Specifies who can change group members' roles. Possible values are:

849

# - ALL_MEMBERS

850

# - OWNERS_AND_MANAGERS

851

# - OWNERS_ONLY

852

# - NONE

853

"whoCanModifyTagsAndCategories": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to change tags and categories. Possible values are:

854

# - ALL_MEMBERS

855

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanMoveTopicsIn": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can move topics into the group or forum. Possible values are:

860

# - ALL_MEMBERS

861

# - OWNERS_AND_MANAGERS

862

# - OWNERS_ONLY

863

# - NONE

864

"whoCanMoveTopicsOut": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can move topics out of the group or forum. Possible values are:

865

# - ALL_MEMBERS

866

# - OWNERS_AND_MANAGERS

867

# - OWNERS_ONLY

868

# - NONE

869

"whoCanPostAnnouncements": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can post announcements, a special topic type. Possible values are:

870

# - ALL_MEMBERS

871

# - OWNERS_AND_MANAGERS

872

# - OWNERS_ONLY

873

# - NONE

874

"whoCanPostMessage": "A String", # Permissions to post messages. Possible values are:

875

# - NONE_CAN_POST: The group is disabled and archived. No one can post a message to this group.

876

# - When archiveOnly is false, updating whoCanPostMessage to NONE_CAN_POST, results in an error.

877

# - If archiveOnly is reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST.

878

# - ALL_MANAGERS_CAN_POST: Managers, including group owners, can post messages.

879

# - ALL_MEMBERS_CAN_POST: Any group member can post a message.

880

# - ALL_OWNERS_CAN_POST: Only group owners can post a message.

881

# - ALL_IN_DOMAIN_CAN_POST: Anyone in the account can post a message.

882

# - ANYONE_CAN_POST: Any Internet user who outside your account can access your Google Groups service and post a message. Note: When whoCanPostMessage is set to ANYONE_CAN_POST, we recommend the messageModerationLevel be set to MODERATE_NON_MEMBERS to protect the group from possible spam.

883

"whoCanTakeTopics": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to take topics in a forum. Possible values are:

884

# - ALL_MEMBERS

885

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanUnassignTopic": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to unassign any topic in a forum. Possible values are:

890

# - ALL_MEMBERS

891

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanUnmarkFavoriteReplyOnAnyTopic": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to unmark any post from a favorite reply. Possible values are:

896

# - ALL_MEMBERS

897

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanViewGroup": "A String", # Permissions to view group messages. Possible values are:

902

# - ANYONE_CAN_VIEW: Any Internet user can view the group's messages.

903

# - ALL_IN_DOMAIN_CAN_VIEW: Anyone in your account can view this group's messages.

904

# - ALL_MEMBERS_CAN_VIEW: All group members can view the group's messages.

905

# - ALL_MANAGERS_CAN_VIEW: Any group manager can view this group's messages.

906

"whoCanViewMembership": "A String", # Permissions to view membership. Possible values are:

907

# - ALL_IN_DOMAIN_CAN_VIEW: Anyone in the account can view the group members list.

908

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

909

#

910

# - ALL_MEMBERS_CAN_VIEW: The group members can view the group members list.

911

# - ALL_MANAGERS_CAN_VIEW: The group managers can view group members list.

912

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

916

<code class="details" id="update">update(groupUniqueId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

917

<pre>Updates an existing resource.

918

919

Args:

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

920

groupUniqueId: string, The group's email address. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

921

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

922

The object takes the form of:

923

924

{ # JSON template for Group resource

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

925

"allowExternalMembers": "A String", # Identifies whether members external to your organization can join the group. Possible values are:

926

# - true: G Suite users external to your organization can become members of this group.

927

# - false: Users not belonging to the organization are not allowed to become members of this group.

928

"allowGoogleCommunication": "A String", # Deprecated. Allows Google to contact administrator of the group.

929

# - 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.

930

# - false: Google can not contact managers of this group.

931

"allowWebPosting": "A String", # Allows posting from web. Possible values are:

932

# - true: Allows any member to post to the group forum.

933

# - false: Members only use Gmail to communicate with the group.

934

"archiveOnly": "A String", # Allows the group to be archived only. Possible values are:

935

# - true: Group is archived and the group is inactive. New messages to this group are rejected. The older archived messages are browseable and searchable.

936

# - If true, the whoCanPostMessage property is set to NONE_CAN_POST.

937

# - If reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST.

938

# - false: The group is active and can receive messages.

939

# - When false, updating whoCanPostMessage to NONE_CAN_POST, results in an error.

940

"customFooterText": "A String", # Set the content of custom footer text. The maximum number of characters is 1,000.

941

"customReplyTo": "A 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.

942

# - 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.

943

# - 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.

944

"customRolesEnabledForSettingsToBeMerged": "A 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:

945

# - true

946

# - false

947

"defaultMessageDenyNotificationText": "A 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. Note: Requires sendMessageDenyNotification property to be true.

948

"description": "A 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.

949

"email": "A String", # The group's email address. This property can be updated using the Directory API. Note: Only a group owner can change a group's email address. A group manager can't do this.

950

# When you change your group's address using the Directory API or the control panel, you are changing the address your subscribers use to send email and the web address people use to access your group. People can't reach your group by visiting the old address.

951

"enableCollaborativeInbox": "A String", # Specifies whether a collaborative inbox will remain turned on for the group. Possible values are:

952

# - true

953

# - false

954

"favoriteRepliesOnTop": "A String", # Indicates if favorite replies should be displayed above other replies.

955

# - true: Favorite replies will be displayed above other replies.

956

# - false: Favorite replies will not be displayed above other replies.

957

"includeCustomFooter": "A String", # Whether to include custom footer. Possible values are:

958

# - true

959

# - false

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

960

"includeInGlobalAddressList": "A String", # Enables the group to be included in the Global Address List. For more information, see the help center. Possible values are:

961

# - true: Group is included in the Global Address List.

962

# - false: Group is not included in the Global Address List.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

963

"isArchived": "A String", # Allows the Group contents to be archived. Possible values are:

964

# - true: Archive messages sent to the group.

965

# - false: Do not keep an archive of messages sent to this group. If false, previously archived messages remain in the archive.

966

"kind": "groupsSettings#groups", # The type of the resource. It is always groupsSettings#groups.

967

"maxMessageBytes": 42, # Deprecated. The maximum size of a message is 25Mb.

968

"membersCanPostAsTheGroup": "A String", # Enables members to post messages as the group. Possible values are:

969

# - 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. Note: When true, any message moderation settings on individual users or new members do not apply to posts made on behalf of the group.

970

# - false: Members can not post in behalf of the group's email address.

971

"messageDisplayFont": "A String", # Deprecated. The default message display font always has a value of "DEFAULT_FONT".

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

972

"messageModerationLevel": "A String", # Moderation level of incoming messages. Possible values are:

973

# - 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.

974

# - 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.

975

# - 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.

976

# - MODERATE_NONE: No moderator approval is required. Messages are delivered directly to the group. Note: When the whoCanPostMessage is set to ANYONE_CAN_POST, we recommend the messageModerationLevel be set to MODERATE_NON_MEMBERS to protect the group from possible spam.

977

# When memberCanPostAsTheGroup is true, any message moderation settings on individual users or new members will not apply to posts made on behalf of the group.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

978

"name": "A String", # Name of the group, which has a maximum size of 75 characters.

979

"primaryLanguage": "A 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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

980

"replyTo": "A String", # Specifies who receives the default reply. Possible values are:

981

# - REPLY_TO_CUSTOM: For replies to messages, use the group's custom email address.

982

# 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.

983

#

984

# - REPLY_TO_SENDER: The reply sent to author of message.

985

# - REPLY_TO_LIST: This reply message is sent to the group.

986

# - REPLY_TO_OWNER: The reply is sent to the owner(s) of the group. This does not include the group's managers.

987

# - REPLY_TO_IGNORE: Group users individually decide where the message reply is sent.

988

# - REPLY_TO_MANAGERS: This reply message is sent to the group's managers, which includes all managers and the group owner.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

989

"sendMessageDenyNotification": "A String", # Allows a member to be notified if the member's message to the group is denied by the group owner. Possible values are:

990

# - true: When a message is rejected, send the deny message notification to the message author.

991

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

992

#

993

# - false: When a message is rejected, no notification is sent.

994

"showInGroupDirectory": "A String", # Deprecated. This is merged into the new whoCanDiscoverGroup setting. Allows the group to be visible in the Groups Directory. Possible values are:

995

# - true: All groups in the account are listed in the Groups directory.

996

# - false: All groups in the account are not listed in the directory.

997

"spamModerationLevel": "A String", # Specifies moderation levels for messages detected as spam. Possible values are:

998

# - ALLOW: Post the message to the group.

999

# - MODERATE: Send the message to the moderation queue. This is the default.

1000

# - SILENTLY_MODERATE: Send the message to the moderation queue, but do not send notification to moderators.

1001

# - REJECT: Immediately reject the message.

1002

"whoCanAdd": "A String", # Deprecated. This is merged into the new whoCanModerateMembers setting. Permissions to add members. Possible values are:

1003

# - ALL_MEMBERS_CAN_ADD: Managers and members can directly add new members.

1004

# - ALL_MANAGERS_CAN_ADD: Only managers can directly add new members. this includes the group's owner.

1005

# - ALL_OWNERS_CAN_ADD: Only owners can directly add new members.

1006

# - NONE_CAN_ADD: No one can directly add new members.

1007

"whoCanAddReferences": "A String", # Deprecated. This functionality is no longer supported in the Google Groups UI. The value is always "NONE".

1008

"whoCanApproveMembers": "A String", # Specifies who can approve members who ask to join groups. This permission will be deprecated once it is merged into the new whoCanModerateMembers setting. Possible values are:

1009

# - ALL_MEMBERS_CAN_APPROVE

1010

# - ALL_MANAGERS_CAN_APPROVE

1011

# - ALL_OWNERS_CAN_APPROVE

1012

# - NONE_CAN_APPROVE

1013

"whoCanApproveMessages": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can approve pending messages in the moderation queue. Possible values are:

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1014

# - ALL_MEMBERS

1015

# - OWNERS_AND_MANAGERS

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1016

# - OWNERS_ONLY

1017

# - NONE

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1018

"whoCanAssignTopics": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to assign topics in a forum to another user. Possible values are:

1019

# - ALL_MEMBERS

1020

# - OWNERS_AND_MANAGERS

1021

# - MANAGERS_ONLY

1022

# - OWNERS_ONLY

1023

# - NONE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1024

"whoCanAssistContent": "A String", # Specifies who can moderate metadata. Possible values are:

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1025

# - ALL_MEMBERS

1026

# - OWNERS_AND_MANAGERS

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1027

# - MANAGERS_ONLY

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1028

# - OWNERS_ONLY

1029

# - NONE

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1030

"whoCanBanUsers": "A String", # Specifies who can deny membership to users. This permission will be deprecated once it is merged into the new whoCanModerateMembers setting. Possible values are:

1031

# - ALL_MEMBERS

1032

# - OWNERS_AND_MANAGERS

1033

# - OWNERS_ONLY

1034

# - NONE

1035

"whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are:

1036

# - ALL_IN_DOMAIN_CAN_CONTACT

1037

# - ALL_MANAGERS_CAN_CONTACT

1038

# - ALL_MEMBERS_CAN_CONTACT

1039

# - ANYONE_CAN_CONTACT

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1040

"whoCanDeleteAnyPost": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can delete replies to topics. (Authors can always delete their own posts). Possible values are:

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1041

# - ALL_MEMBERS

1042

# - OWNERS_AND_MANAGERS

1043

# - OWNERS_ONLY

1044

# - NONE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1045

"whoCanDeleteTopics": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can delete topics. Possible values are:

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1046

# - ALL_MEMBERS

1047

# - OWNERS_AND_MANAGERS

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1048

# - OWNERS_ONLY

1049

# - NONE

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1050

"whoCanDiscoverGroup": "A String", # Specifies the set of users for whom this group is discoverable. Possible values are:

1051

# - ANYONE_CAN_DISCOVER

1052

# - ALL_IN_DOMAIN_CAN_DISCOVER

1053

# - ALL_MEMBERS_CAN_DISCOVER

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1054

"whoCanEnterFreeFormTags": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to enter free form tags for topics in a forum. Possible values are:

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

1055

# - ALL_MEMBERS

1056

# - OWNERS_AND_MANAGERS

1057

# - MANAGERS_ONLY

1058

# - OWNERS_ONLY

1059

# - NONE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1060

"whoCanHideAbuse": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can hide posts by reporting them as abuse. Possible values are:

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1061

# - ALL_MEMBERS

1062

# - OWNERS_AND_MANAGERS

1063

# - OWNERS_ONLY

1064

# - NONE

1065

"whoCanInvite": "A String", # Deprecated. This is merged into the new whoCanModerateMembers setting. Permissions to invite new members. Possible values are:

1066

# - ALL_MEMBERS_CAN_INVITE: Managers and members can invite a new member candidate.

1067

# - ALL_MANAGERS_CAN_INVITE: Only managers can invite a new member. This includes the group's owner.

1068

# - ALL_OWNERS_CAN_INVITE: Only owners can invite a new member.

1069

# - NONE_CAN_INVITE: No one can invite a new member candidate.

1070

"whoCanJoin": "A String", # Permission to join group. Possible values are:

1071

# - ANYONE_CAN_JOIN: Anyone in the account domain can join. This includes accounts with multiple domains.

1072

# - 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. Warning: Group owners can add external addresses, outside of the domain to their groups. They can also allow people outside your domain to join their groups. If you later disable this option, any external addresses already added to users' groups remain in those groups.

1073

# - INVITED_CAN_JOIN: Candidates for membership can be invited to join.

1074

# - CAN_REQUEST_TO_JOIN: Non members can request an invitation to join.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1075

"whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are:

1076

# - ALL_MANAGERS_CAN_LEAVE

1077

# - ALL_MEMBERS_CAN_LEAVE

1078

# - NONE_CAN_LEAVE

1079

"whoCanLockTopics": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can prevent users from posting replies to topics. Possible values are:

1080

# - ALL_MEMBERS

1081

# - OWNERS_AND_MANAGERS

1082

# - OWNERS_ONLY

1083

# - NONE

1084

"whoCanMakeTopicsSticky": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can make topics appear at the top of the topic list. Possible values are:

1085

# - ALL_MEMBERS

1086

# - OWNERS_AND_MANAGERS

1087

# - OWNERS_ONLY

1088

# - NONE

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1089

"whoCanMarkDuplicate": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a topic as a duplicate of another topic. Possible values are:

1090

# - ALL_MEMBERS

1091

# - OWNERS_AND_MANAGERS

1092

# - MANAGERS_ONLY

1093

# - OWNERS_ONLY

1094

# - NONE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1095

"whoCanMarkFavoriteReplyOnAnyTopic": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark any other user's post as a favorite reply. Possible values are:

1096

# - ALL_MEMBERS

1097

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanMarkFavoriteReplyOnOwnTopic": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a post for a topic they started as a favorite reply. Possible values are:

1102

# - ALL_MEMBERS

1103

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanMarkNoResponseNeeded": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to mark a topic as not needing a response. Possible values are:

1108

# - ALL_MEMBERS

1109

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanModerateContent": "A String", # Specifies who can moderate content. Possible values are:

1114

# - ALL_MEMBERS

1115

# - OWNERS_AND_MANAGERS

1116

# - OWNERS_ONLY

1117

# - NONE

1118

"whoCanModerateMembers": "A String", # Specifies who can manage members. Possible values are:

1119

# - ALL_MEMBERS

1120

# - OWNERS_AND_MANAGERS

1121

# - OWNERS_ONLY

1122

# - NONE

1123

"whoCanModifyMembers": "A String", # Deprecated. This is merged into the new whoCanModerateMembers setting. Specifies who can change group members' roles. Possible values are:

1124

# - ALL_MEMBERS

1125

# - OWNERS_AND_MANAGERS

1126

# - OWNERS_ONLY

1127

# - NONE

1128

"whoCanModifyTagsAndCategories": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to change tags and categories. Possible values are:

1129

# - ALL_MEMBERS

1130

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanMoveTopicsIn": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can move topics into the group or forum. Possible values are:

1135

# - ALL_MEMBERS

1136

# - OWNERS_AND_MANAGERS

1137

# - OWNERS_ONLY

1138

# - NONE

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1139

"whoCanMoveTopicsOut": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can move topics out of the group or forum. Possible values are:

1140

# - ALL_MEMBERS

1141

# - OWNERS_AND_MANAGERS

1142

# - OWNERS_ONLY

1143

# - NONE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1144

"whoCanPostAnnouncements": "A String", # Deprecated. This is merged into the new whoCanModerateContent setting. Specifies who can post announcements, a special topic type. Possible values are:

1145

# - ALL_MEMBERS

1146

# - OWNERS_AND_MANAGERS

1147

# - OWNERS_ONLY

1148

# - NONE

1149

"whoCanPostMessage": "A String", # Permissions to post messages. Possible values are:

1150

# - NONE_CAN_POST: The group is disabled and archived. No one can post a message to this group.

1151

# - When archiveOnly is false, updating whoCanPostMessage to NONE_CAN_POST, results in an error.

1152

# - If archiveOnly is reverted from true to false, whoCanPostMessages is set to ALL_MANAGERS_CAN_POST.

1153

# - ALL_MANAGERS_CAN_POST: Managers, including group owners, can post messages.

1154

# - ALL_MEMBERS_CAN_POST: Any group member can post a message.

1155

# - ALL_OWNERS_CAN_POST: Only group owners can post a message.

1156

# - ALL_IN_DOMAIN_CAN_POST: Anyone in the account can post a message.

1157

# - ANYONE_CAN_POST: Any Internet user who outside your account can access your Google Groups service and post a message. Note: When whoCanPostMessage is set to ANYONE_CAN_POST, we recommend the messageModerationLevel be set to MODERATE_NON_MEMBERS to protect the group from possible spam.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1158

"whoCanTakeTopics": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to take topics in a forum. Possible values are:

1159

# - ALL_MEMBERS

1160

# - OWNERS_AND_MANAGERS

1161

# - MANAGERS_ONLY

1162

# - OWNERS_ONLY

1163

# - NONE

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1164

"whoCanUnassignTopic": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to unassign any topic in a forum. Possible values are:

1165

# - ALL_MEMBERS

1166

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanUnmarkFavoriteReplyOnAnyTopic": "A String", # Deprecated. This is merged into the new whoCanAssistContent setting. Permission to unmark any post from a favorite reply. Possible values are:

1171

# - ALL_MEMBERS

1172

# - OWNERS_AND_MANAGERS

# - MANAGERS_ONLY

# - OWNERS_ONLY

# - NONE

"whoCanViewGroup": "A String", # Permissions to view group messages. Possible values are:

1177

# - ANYONE_CAN_VIEW: Any Internet user can view the group's messages.

1178

# - ALL_IN_DOMAIN_CAN_VIEW: Anyone in your account can view this group's messages.

1179

# - ALL_MEMBERS_CAN_VIEW: All group members can view the group's messages.

1180

# - ALL_MANAGERS_CAN_VIEW: Any group manager can view this group's messages.

1181

"whoCanViewMembership": "A String", # Permissions to view membership. Possible values are:

1182

# - ALL_IN_DOMAIN_CAN_VIEW: Anyone in the account can view the group members list.

1183

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

1184

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1185

# - ALL_MEMBERS_CAN_VIEW: The group members can view the group members list.

1186

# - ALL_MANAGERS_CAN_VIEW: The group managers can view group members list.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

}

Returns:

An object of the form:

1192

1193

{ # JSON template for Group resource

Yoshi Automation Bot