Serviço de configurações do Grupos do SDK Admin

O serviço de configurações do Grupos do SDK Admin permite usar a API Groups Settings do SDK Admin no Apps Script. Essa API permite que administradores de domínios do Google Workspace (incluindo revendedores) gerenciem as configurações de grupos na conta do Google Workspace.

Referência

Para informações detalhadas sobre esse serviço, consulte a documentação de referência da API Groups Settings do Admin SDK. Assim como todos os serviços avançados no Apps Script, o serviço Admin SDK Groups Settings usa os mesmos objetos, métodos e parâmetros que a API pública. Para mais informações, consulte Como as assinaturas de método são determinadas.

Para informar problemas e encontrar outras opções de suporte, consulte o guia de suporte das configurações de grupos do SDK Admin.

Código de amostra

O exemplo de código abaixo usa a versão 1 da API.

Acessar as configurações de um grupo

Este exemplo recebe as configurações de um grupo e as registra no console.

advanced/adminSDK.gs
/**
 * Gets a group's settings and logs them to the console.
 */
function getGroupSettings() {
  // TODO (developer) - Replace groupId value with yours
  const groupId = 'exampleGroup@example.com';
  try {
    const group = AdminGroupsSettings.Groups.get(groupId);
    console.log(JSON.stringify(group, null, 2));
  } catch (err) {
    // TODO (developer)- Handle exception from the API
    console.log('Failed with error %s', err.message);
  }
}

Atualizar as configurações de um grupo

Este exemplo mostra como as configurações de um grupo podem ser alteradas. Aqui, a descrição é modificada, mas várias outras configurações podem ser alteradas da mesma forma.

advanced/adminSDK.gs
/**
 * Updates group's settings. Here, the description is modified, but various
 * other settings can be changed in the same way.
 * @see https://developers.google.com/admin-sdk/groups-settings/v1/reference/groups/patch
 */
function updateGroupSettings() {
  const groupId = 'exampleGroup@example.com';
  try {
    const group = AdminGroupsSettings.newGroups();
    group.description = 'Newly changed group description';
    AdminGroupsSettings.Groups.patch(group, groupId);
  } catch (err) {
    // TODO (developer)- Handle exception from the API
    console.log('Failed with error %s', err.message);
  }
}