Anexos de tipo de conteúdo

Este é o quarto tutorial da série de complementos do Google Sala de Aula.

Neste tutorial, você vai interagir com a API Google Classroom para criar anexos. Você oferece rotas para que os usuários acessem o conteúdo do anexo. As visualizações são diferentes dependendo do papel do usuário na turma. Este tutorial aborda anexos de tipo conteúdo, que não exigem um envio do estudante.

Durante este tutorial, você vai concluir o seguinte:

• Extraia e use os seguintes parâmetros de consulta de complemento:
  • addOnToken: um token de autorização transmitido para a visualização de descoberta de anexos.
  • itemId: um identificador exclusivo do trabalho do curso, do material do trabalho do curso ou do anúncio que recebe o anexo do complemento.
  • itemType: "courseWork", "courseWorkMaterials" ou "announcement".
  • courseId: um identificador exclusivo do curso do Google Sala de Aula em que a atividade está sendo criada.
  • attachmentId: um identificador exclusivo atribuído pelo Google Sala de Aula a um anexo de complemento após a criação.
• Implemente o armazenamento permanente para anexos de tipo de conteúdo.
• Forneça rotas para criar anexos e exibir os iframes do modo de professor e do modo de estudante.
• Emita as seguintes solicitações para a API Google Classroom Add-ons:
  • Crie um novo anexo.
  • Receba o contexto do complemento, que identifica se o usuário conectado é um aluno ou professor.

Depois de terminar, você poderá criar anexos de tipo de conteúdo nas atividades pela interface do Google Sala de Aula quando estiver conectado como professor. Professores e estudantes da turma também podem acessar o conteúdo.

Importante: antes de seguir este tutorial, conclua os tutoriais anteriores da série. Este tutorial expande o app da Web desenvolvido nos tutoriais anteriores. Você pode fazer o download do código-fonte completo de todos os tutoriais na página "Visão geral". O código para este tutorial específico pode ser encontrado no diretório /04-content-attachments/.

Ativar a API Classroom

Faça chamadas para a API Classroom a partir desta etapa. A API precisa estar ativada no seu projeto do Google Cloud para que você possa fazer chamadas para ela. Navegue até a entrada da biblioteca da API Google Classroom e escolha Ativar.

Importante: verifique se a biblioteca da API Google Classroom está ativada antes de continuar.

Processar os parâmetros de consulta da visualização de descoberta de anexos

Como discutido anteriormente, o Google Sala de Aula transmite parâmetros de consulta ao carregar a visualização de descoberta de anexos no iframe:

• courseId: o ID do curso atual do Google Sala de Aula.
• itemId: um identificador exclusivo do trabalho do curso, do material do trabalho do curso ou do aviso que recebe o anexo do complemento.
• itemType: "courseWork", "courseWorkMaterials" ou "announcement".
• addOnToken: um token usado para autorizar determinadas ações de complementos do Google Sala de Aula.
• login_hint: o ID do Google do usuário atual.

Este tutorial aborda courseId, itemId, itemType e addOnToken. Mantenha e transmita esses dados ao emitir chamadas para a API Classroom.

Como na etapa anterior do tutorial, armazene os valores dos parâmetros de consulta transmitidos na nossa sessão. É importante fazer isso quando a visualização de descoberta de anexos é aberta pela primeira vez, porque essa é a única oportunidade para o Google Sala de Aula transmitir esses parâmetros de consulta.

Python

Observação: a partir deste tutorial, os métodos do servidor Flask no exemplo fornecido são divididos em vários arquivos.

• attachment_discovery_routes.py define rotas para a visualização de descoberta de anexos que foram desenvolvidas nas etapas de instruções anteriores.
• attachment_routes.py define rotas para a visualização do professor e a do estudante. Ele também fornece rotas para a visualização de descoberta de anexos em relação à criação de anexos.
• credential_handler.py fornece uma classe singleton para gerenciar as credenciais do usuário.

Importante: se você estiver executando o exemplo fornecido, verifique se /discovery-callback e /attachment-callback foram adicionados aos URIs de redirecionamento autorizados. Acesse suas credenciais do OAuth no Google Cloud e clique no ícone de edição ao lado das credenciais para modificar os URIs de redirecionamento autorizados.

Navegue até o arquivo do servidor Flask que fornece rotas para a visualização de descoberta de anexos (attachment-discovery-routes.py se você estiver seguindo o exemplo fornecido). Na parte de cima do caminho de destino do complemento (/classroom-addon no exemplo fornecido), extraia e armazene os parâmetros de consulta courseId, itemId, itemType e addOnToken.

# Retrieve the itemId, courseId, and addOnToken query parameters.
if flask.request.args.get("itemId"):
    flask.session["itemId"] = flask.request.args.get("itemId")
if flask.request.args.get("itemType"):
    flask.session["itemType"] = flask.request.args.get("itemType")
if flask.request.args.get("courseId"):
    flask.session["courseId"] = flask.request.args.get("courseId")
if flask.request.args.get("addOnToken"):
    flask.session["addOnToken"] = flask.request.args.get("addOnToken")

Grave esses valores na sessão somente se eles estiverem presentes. Eles não serão transmitidos novamente se o usuário retornar à visualização de descoberta de anexos mais tarde sem fechar o iframe.

Adicionar armazenamento permanente para anexos de tipo de conteúdo

Você precisa de um registro local de todos os anexos criados. Isso permite que você pesquise o conteúdo que o professor selecionou usando identificadores fornecidos pelo Google Sala de Aula.

Configurar um esquema de banco de dados para um Attachment. O exemplo apresentado mostra anexos com uma imagem e uma legenda. Um Attachment contém os seguintes atributos:

• attachment_id: um identificador exclusivo de um anexo. Atribuído pelo Classroom e retornado na resposta ao criar um anexo.
• image_filename: o nome de arquivo local da imagem a ser exibida.
• image_caption: a legenda que será mostrada com a imagem.

Observação: esses atributos são tipos de string.

Python

Estenda a implementação do SQLite e do flask_sqlalchemy das etapas anteriores.

Navegue até o arquivo em que você definiu a tabela de usuários (models.py se você estiver seguindo nosso exemplo). Adicione o seguinte na parte de baixo do arquivo abaixo da classe User.

class Attachment(db.Model):
    # The attachmentId is the unique identifier for the attachment.
    attachment_id = db.Column(db.String(120), primary_key=True)

    # The image filename to store.
    image_filename = db.Column(db.String(120))

    # The image caption to store.
    image_caption = db.Column(db.String(120))

Importe a nova classe de anexos para o arquivo do servidor com suas rotas de processamento de anexos.

Configurar novas rotas

Comece esta etapa de instrução configurando algumas páginas novas no aplicativo. Com eles, o usuário pode criar e acessar conteúdo usando nosso complemento.

Adicionar rotas de criação de anexos

Você precisa de páginas para que o professor selecione conteúdo e envie solicitações de criação de anexos. Implemente a rota /attachment-options para mostrar opções de conteúdo para o professor selecionar. Você também precisa de modelos para as páginas de seleção de conteúdo e confirmação de criação. Os exemplos fornecidos contêm modelos para isso e também podem mostrar as solicitações e respostas da API Classroom.

Você também pode modificar a página de destino da visualização de descoberta de anexos para mostrar as opções de conteúdo em vez de criar a nova página /attachment-options. Recomendamos criar uma nova página para este exercício para preservar o comportamento de SSO implementado na segunda etapa do tutorial, como a revogação das permissões do app. Elas podem ser úteis ao criar e testar seu complemento.

No exemplo fornecido, um professor pode selecionar um pequeno conjunto de imagens com legenda. Fornecemos quatro imagens de pontos turísticos famosos com legendas derivadas dos nomes dos arquivos.

Python

No exemplo fornecido, isso está no arquivo webapp/attachment_routes.py.

@app.route("/attachment-options", methods=["GET", "POST"])
def attachment_options():
    """
    Render the attachment options page from the "attachment-options.html"
    template.

    This page displays a grid of images that the user can select using
    checkboxes.
    """

    # A list of the filenames in the static/images directory.
    image_filenames = os.listdir(os.path.join(app.static_folder, "images"))

    # The image_list_form_builder method creates a form that displays a grid
    # of images, checkboxes, and captions with a Submit button. All images
    # passed in image_filenames will be shown, and the captions will be the
    # title-cased filenames.

    # The form must be built dynamically due to limitations in WTForms. The
    # image_list_form_builder method therefore also returns a list of
    # attribute names in the form, which will be used by the HTML template
    # to properly render the form.
    form, var_names = image_list_form_builder(image_filenames)

    # If the form was submitted, validate the input and create the attachments.
    if form.validate_on_submit():

        # Build a dictionary that maps image filenames to captions.
        # There will be one dictionary entry per selected item in the form.
        filename_caption_pairs = construct_filename_caption_dictionary_list(
            form)

        # Check that the user selected at least one image, then proceed to
        # make requests to the Classroom API.
        if len(filename_caption_pairs) > 0:
            return create_attachments(filename_caption_pairs)
        else:
            return flask.render_template(
                "create-attachment.html",
                message="You didn't select any images.",
                form=form,
                var_names=var_names)

    return flask.render_template(
        "attachment-options.html",
        message=("You've reached the attachment options page. "
                "Select one or more images and click 'Create Attachment'."),
        form=form,
        var_names=var_names,
    )

Isso gera uma página "Criar anexos" semelhante a esta:

O professor pode selecionar várias imagens. Crie um anexo para cada imagem que o professor selecionou no método create_attachments.

Solicitações de criação de anexos de problemas

Agora que você sabe quais conteúdos o professor quer anexar, faça solicitações à API Classroom para criar anexos na atividade. Armazene os detalhes do anexo no seu banco de dados depois de receber uma resposta da API Classroom.

Comece acessando uma instância do serviço do Google Sala de Aula:

Python

No exemplo fornecido, isso está no arquivo webapp/attachment_routes.py.

def create_attachments(filename_caption_pairs):
    """
    Create attachments and show an acknowledgement page.

    Args:
        filename_caption_pairs: A dictionary that maps image filenames to
            captions.
    """
    # Get the Google Classroom service.
    classroom_service = googleapiclient.discovery.build(
        serviceName="classroom",
        version="v1",
        credentials=credentials)

Emita uma solicitação CREATE para o endpoint courses.courseWork.addOnAttachments. Para cada imagem selecionada pelo professor, primeiro construa um objeto AddOnAttachment:

Python

No exemplo fornecido, essa é uma continuação do método create_attachments.

# Create a new attachment for each image that was selected.
attachment_count = 0
for key, value in filename_caption_pairs.items():
    attachment_count += 1

    # Create a dictionary with values for the AddOnAttachment object fields.
    attachment = {
        # Specifies the route for a teacher user.
        "teacherViewUri": {
            "uri":
                flask.url_for(
                    "load_content_attachment", _scheme='https', _external=True),
        },
        # Specifies the route for a student user.
        "studentViewUri": {
            "uri":
                flask.url_for(
                    "load_content_attachment", _scheme='https', _external=True)
        },
        # The title of the attachment.
        "title": f"Attachment {attachment_count}",
    }

Pelo menos os campos teacherViewUri, studentViewUri e title precisam ser fornecidos para cada anexo. teacherViewUri e studentViewUri representam os URLs que são carregados quando o anexo é aberto pelo respectivo tipo de usuário.

Envie o objeto AddOnAttachment no corpo de uma solicitação para o endpoint addOnAttachments apropriado. Forneça os identificadores courseId, itemId, itemType e addOnToken com cada solicitação.

Python

No exemplo fornecido, essa é uma continuação do método create_attachments.

# Use the itemType to determine which stream item type the teacher created
match flask.session["itemType"]:
    case "announcements":
        parent = classroom_service.courses().announcements()
    case "courseWorkMaterials":
        parent = classroom_service.courses().courseWorkMaterials()
    case _:
        parent = classroom_service.courses().courseWork()

# Issue a request to create the attachment.
resp = parent.addOnAttachments().create(
    courseId=flask.session["courseId"],
    itemId=flask.session["itemId"],
    addOnToken=flask.session["addOnToken"],
    body=attachment).execute()

Importante: capture a resposta desta solicitação de criação.

Crie uma entrada para esse anexo no seu banco de dados local para que você possa carregar o conteúdo correto mais tarde. O Google Sala de Aula retorna um valor id exclusivo na resposta à solicitação de criação. Use esse valor como a chave primária no banco de dados. O Google Sala de Aula também transmite o parâmetro de consulta attachmentId ao abrir as visualizações do professor e do estudante:

Python

No exemplo fornecido, essa é uma continuação do método create_attachments.

# Store the value by id.
new_attachment = Attachment(
    # The new attachment's unique ID, returned in the CREATE response.
    attachment_id=resp.get("id"),
    image_filename=key,
    image_caption=value)
db.session.add(new_attachment)
db.session.commit()

Considere redirecionar o usuário para uma página de confirmação nesse ponto, confirmando que ele criou os anexos.

Permitir anexos do seu complemento

Agora é uma boa hora para adicionar endereços apropriados ao campo Prefixos de URI de anexos permitidos na página Configuração do app do SDK do Google Workspace Marketplace. Seu complemento só pode criar anexos de um dos prefixos de URI listados nesta página. Essa é uma medida de segurança para ajudar a reduzir a possibilidade de ataques "man-in-the-middle".

A abordagem mais simples é fornecer seu domínio de nível superior neste campo, por exemplo, https://example.com. https://localhost:<your port number>/ funcionaria se você estivesse usando sua máquina local como o servidor da Web.

Aviso: adicione os prefixos à Configuração do app antes de testar o complemento. Você recebe um erro ao tentar criar anexos de um URL que não pertence a um dos prefixos listados.

Adicionar rotas para as visualizações de professor e estudante

Há quatro iframes em que um complemento do Google Sala de Aula pode ser carregado. Até agora, você só criou rotas que veiculam o iframe da visualização de descoberta de anexos. Em seguida, adicione rotas para exibir os iframes do modo de professor e de estudante.

O iframe da Visualização do professor é necessário para mostrar uma prévia da experiência do estudante, mas pode incluir informações ou recursos de edição adicionais.

A visualização do estudante é a página que aparece para cada estudante quando ele abre um anexo de complemento.

Para este exercício, crie uma única rota /load-content-attachment que sirva para a visualização do professor e do estudante. Use os métodos da API do Google Sala de Aula para determinar se o usuário é professor ou estudante quando a página é carregada.

Python

No exemplo fornecido, isso está no arquivo webapp/attachment_routes.py.

@app.route("/load-content-attachment")
def load_content_attachment():
    """
    Load the attachment for the user's role."""

    # Since this is a landing page for the Teacher and Student View iframes, we
    # need to preserve the incoming query parameters.
    if flask.request.args.get("itemId"):
        flask.session["itemId"] = flask.request.args.get("itemId")
    if flask.request.args.get("itemType"):
        flask.session["itemType"] = flask.request.args.get("itemType")
    if flask.request.args.get("courseId"):
        flask.session["courseId"] = flask.request.args.get("courseId")
    if flask.request.args.get("attachmentId"):
        flask.session["attachmentId"] = flask.request.args.get("attachmentId")

Lembre-se de que você também precisa autenticar o usuário nesse ponto. Você também precisa processar o parâmetro de consulta login_hint aqui e encaminhar o usuário para seu fluxo de autorização, se necessário. Consulte os detalhes da orientação de login discutidos em tutoriais anteriores para mais informações sobre esse fluxo.

Em seguida, envie uma solicitação para o endpoint getAddOnContext que corresponde ao tipo de item.

Python

No exemplo fornecido, essa é uma continuação do método load_content_attachment.

# Create an instance of the Classroom service.
classroom_service = googleapiclient.discovery.build(
    serviceName="classroom"
    version="v1",
    credentials=credentials)

# Use the itemType to determine which stream item type the teacher created
match flask.session["itemType"]:
    case "announcements":
        parent = classroom_service.courses().announcements()
    case "courseWorkMaterials":
        parent = classroom_service.courses().courseWorkMaterials()
    case _:
        parent = classroom_service.courses().courseWork()

addon_context_response = parent.getAddOnContext(
    courseId=flask.session["courseId"],
    itemId=flask.session["itemId"]).execute()

Esse método retorna informações sobre o papel do usuário atual na classe. Alterar a visualização apresentada ao usuário dependendo da função dele. Exatamente um dos campos studentContext ou teacherContext é preenchido no objeto de resposta. Analise-as para determinar como abordar o usuário.

De qualquer forma, use o valor do parâmetro de consulta attachmentId para saber qual anexo recuperar do nosso banco de dados. Esse parâmetro de consulta é fornecido ao abrir os URIs de visualização do professor ou do estudante.

Python

No exemplo fornecido, essa é uma continuação do método load_content_attachment.

# Determine which view we are in by testing the returned context type.
user_context = "student" if addon_context_response.get(
    "studentContext") else "teacher"

# Look up the attachment in the database.
attachment = Attachment.query.get(flask.session["attachmentId"])

# Set the text for the next page depending on the user's role.
message_str = f"I see that you're a {user_context}! "
message_str += (
    f"I've loaded the attachment with ID {attachment.attachment_id}. "
    if user_context == "teacher" else
    "Please enjoy this image of a famous landmark!")

# Show the content with the customized message text.
return flask.render_template(
    "show-content-attachment.html",
    message=message_str,
    image_filename=attachment.image_filename,
    image_caption=attachment.image_caption,
    responses=response_strings)

Testar o complemento

Importante: neste ponto do desenvolvimento, só é possível testar seu aplicativo nos iframes de complementos do Google Sala de Aula. Leia a página de iframe e parâmetros de consulta para conferir uma descrição de cada iframe. Todas as instruções fornecidas neste tutorial pressupõem que o complemento possa ser usado no contexto de um iframe.

Siga estas etapas para testar a criação de anexos:

• Faça login no [Google Sala de Aula] como um dos seus professores de teste.
• Acesse a guia Atividades e crie uma nova Atividade.
• Clique no botão Complementos abaixo da área de texto e selecione o complemento. O iframe é aberto e o complemento carrega o URI de configuração de anexo que você especificou na página Configuração do app do SDK do Google Workspace Marketplace.
• Escolha um conteúdo para anexar à atividade.
• Feche o iframe depois que o fluxo de criação de anexos for concluído.

Um card de anexo vai aparecer na interface de criação de atividades no Google Google Sala de Aula. Clique no card para abrir o iframe da visualização do professor e confirmar se o anexo correto aparece. Clique no botão Atribuir.

Siga estas etapas para testar a experiência do estudante:

• Em seguida, faça login no Google Sala de Aula como um usuário de teste estudante na mesma turma que o usuário de teste do professor.
• Encontre a atividade de teste na guia "Atividades".
• Abra a atividade e clique no card de anexo para abrir o frame da visualização do estudante.

Confirme se o anexo correto aparece para o estudante.

Parabéns! Você está pronto para passar para a próxima etapa: criar anexos de tipo de atividade.