Method: userProfiles.guardians.list

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

Para listar os responsáveis de um estudante para quem o usuário solicitante pode ver os responsáveis, use o caractere literal - como ID de 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 ver as informações do responsável do estudante, se "-" for especificado como studentId e o usuário não for um 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 é um administrador do domínio ou para outros erros de acesso.
  • INVALID_ARGUMENT se um studentId for especificado, mas o formato não puder ser reconhecido (não é um endereço de e-mail, 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 puder ser reconhecido, mas o Google Sala de Aula não tiver um 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 a que o responsável está vinculado. 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 precisam 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 nesse link de responsável. Esse filtro só pode ser usado por administradores de domínio.

pageToken

string

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 devolvidos. Zero ou não especificado indica que o servidor pode atribuir um máximo.

O servidor pode retornar menos do que o número especificado de resultados.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta ao listar 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)

Responsáveis nesta 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 haverá mais resultados disponíveis.

Escopos de autorização

Requer um dos seguintes escopos de 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.