Method: userProfiles.guardians.list

Retorna uma lista de responsáveis que o usuário solicitante tem permissão para visualizar, restrita àqueles que correspondem à solicitação.

Para listar os responsáveis de qualquer estudante que o usuário solicitante possa consultar, use o caractere literal - para o ID do estudante.

Esse método retorna os seguintes códigos de erro:

  • PERMISSION_DENIED se um studentId for especificado e o usuário solicitante não tiver permissão para acessar as informações do responsável do estudante, se "-" for especificado como studentId e o usuário não for administrador do domínio, se os responsáveis não estiverem ativados para o domínio em questão, se o filtro invitedEmailAddress for definido por um usuário que não é administrador do domínio ou para outros erros de acesso.
  • INVALID_ARGUMENT se um studentId for especificado, mas o formato dele não puder ser reconhecido (não é um endereço de e-mail, nem um studentId da API, nem a string literal me). Também pode ser retornado se um pageToken inválido for fornecido.
  • NOT_FOUND se um studentId for especificado e o formato dele puder ser reconhecido, mas o Google Sala de Aula não tiver registro desse estudante.

Solicitação HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
studentId

string

Filtre os resultados pelo estudante vinculado ao responsável. O identificador pode ser um dos seguintes:

  • o identificador numérico do usuário
  • o endereço de e-mail do usuário
  • o literal de string "me", indicando o usuário solicitante
  • o literal de string "-", indicando que os resultados devem ser retornados para todos os estudantes que o usuário solicitante tem acesso para visualizar.

Parâmetros de consulta

Parâmetros
invitedEmailAddress

string

Filtre os resultados pelo endereço de e-mail para o qual o convite original foi enviado, resultando neste link do responsável. Esse filtro só pode ser usado por administradores de domínio.
pageToken

string

O valor nextPageToken retornado de uma chamada list anterior, indicando que a página de resultados subsequente precisa ser retornada.

A solicitação list precisa ser idêntica à que resultou nesse token.
pageSize

integer

Número máximo de itens a serem retornados. Zero ou indefinido indica que o servidor pode atribuir um valor máximo.

O servidor pode retornar menos resultados do que o especificado.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta ao listar os responsáveis.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
Campos
guardians[]

object (Guardian)

Os responsáveis na página de resultados que atenderam aos critérios especificados na solicitação.
nextPageToken

string

Token que identifica a próxima página de resultados a serem retornados. Se estiver vazio, não há mais resultados disponíveis.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Para mais informações, consulte o guia de autorização.