A API Groups Settings atualiza e recupera as configurações de um grupo do Google existente . Com ela, é possível fazer o seguinte:
- Modificar as configurações de um grupo para acesso interno e externo.
- Editar as notificações do grupo.
- Configurar o arquivamento de discussões e a moderação de mensagens.
- Personalizar os grupos de usuários da sua conta.
Para mais maneiras de trabalhar com os Grupos do Google ou gerenciar outros tipos de grupos, consulte a documentação do Cloud Identity.
Modelo de dados da API Groups Settings
A API Groups Settings opera em um recurso Groups que representa como os usuários de uma conta se comunicam e colaboram com grupos de outras pessoas.
Cada grupo é identificado pelo endereço de e-mail.
O modelo de dados da API é baseado na coleção Groups dos grupos da conta.
Cada grupo tem um conjunto exclusivo de configurações.
Operações da API Groups Settings
É possível chamar métodos de configurações de grupo na API Groups Settings, conforme descrito na tabela a seguir:
| Operação | Descrição | Mapeamentos HTTP REST |
|---|---|---|
get |
Recebe as configurações de um grupo para a conta de um cliente. Todas as operações de recebimento precisam ser autorizadas por um usuário autenticado. | GET em um URI de grupo. |
update |
Atualiza as configurações de um grupo para a conta de um cliente. Todas as operações de atualização precisam ser autorizadas por um usuário autenticado. | PUT em um URI de grupo. |
Formatos de dados JSON e Atom
Por padrão, a API Groups Settings retorna dados no formato JSON. A notação Atom é um formato de dados alternativo. Os formatos de dados JSON e Atom oferecem suporte a recursos completos de leitura e gravação.
JSON é um formato comum da Internet que oferece um método de representação de estruturas de dados arbitrárias. De acordo com json.org, JSON é um formato de texto totalmente independente de linguagem, mas usa convenções que são familiares aos programadores da família de linguagens C, incluindo C, C++, C#, Java, JavaScript, Perl e Python.
É possível mudar o formato de dados da API incluindo a string de consulta alt no URI da solicitação. Exemplo:
JSON
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=json
Atom
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=atom