Anexos de tipo de conteúdo

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

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

Ao longo deste tutorial, você vai concluir o seguinte:

• Recupere e use os seguintes parâmetros de consulta de complementos:
  • addOnToken: um token de autorização transmitido à visualização de descoberta de anexos.
  • itemId: um identificador exclusivo para o CourseWork, CourseWorkMaterial ou Announcement que recebe o anexo do complemento.
  • itemType: "courseWork", "courseWorkMaterials" ou "announcement".
  • courseId: um identificador exclusivo para o 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 persistente para anexos de tipo de conteúdo.
• Forneça rotas para criar anexos e veicular os iframes da visualização do professor e do estudante.
• Emita as seguintes solicitações para a API de complementos do Google Sala de Aula:
  • Crie um novo anexo.
  • Receba o contexto do complemento, que identifica se o usuário conectado é um estudante ou professor.

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

Ativar a API Classroom

Faça chamadas para a API Classroom começando com esta etapa. A API precisa ser ativada para o projeto na nuvem do Google Cloud antes que você possa fazer chamadas para ela. Navegue até a entrada da biblioteca da API Google Classroom e escolha Ativar.

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 para o CourseWork, CourseWorkMaterial ou Announcement 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 valores ao emitir chamadas para a API Classroom.

Como na etapa anterior do tutorial, armazene os valores de parâmetro 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.

# 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")

Adicionar armazenamento persistente para anexos de tipo de conteúdo

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

Configure um esquema de banco de dados para um Attachment. Nosso exemplo fornecido apresenta anexos que mostram uma imagem e uma legenda. Um Attachment contém os seguintes atributos:

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

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))

Configurar novas rotas

Comece esta etapa do tutorial configurando algumas novas páginas no aplicativo. Elas permitem que um usuário crie e visualize conteúdo pelo nosso complemento.

Adicionar rotas de criação de anexos

Você precisa de páginas para o professor selecionar conteúdo e emitir solicitações de criação de anexos. Implemente a rota /attachment-options para mostrar as 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. Nossos exemplos fornecidos contêm modelos para isso e também podem mostrar as solicitações e respostas da API Classroom.

Como alternativa, você pode modificar sua 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. Isso será útil ao criar e testar seu complemento.

Um professor pode selecionar um pequeno conjunto de imagens legendadas no nosso exemplo fornecido. Fornecemos quatro imagens de pontos turísticos famosos cujas legendas são derivadas dos nomes dos arquivos.

@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,
    )

Emitir solicitações de criação de anexos

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

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

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 courses.courseWork.addOnAttachments endpoint. Para cada imagem selecionada pelo professor, primeiro construa um AddOnAttachment objeto:

# 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. Os campos teacherViewUri e studentViewUri representam os URLs carregados quando o anexo é aberto pelo tipo de usuário respectivo.

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.

# 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()

Crie uma entrada para esse anexo no 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. Observe também que o Google Sala de Aula transmite o parâmetro de consulta attachmentId ao abrir as visualizações do professor e do estudante:

# 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 encaminhar o usuário para uma página de confirmação neste momento, reconhecendo que ele criou anexos.

Permitir anexos do seu complemento

Agora é um bom momento para adicionar os endereços apropriados ao campo "Prefixos de URI de anexos permitidos" na página de 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 nesse campo, por exemplo, https://example.com. https://localhost:<your port number>/ funcionaria se você estiver usando sua máquina local como servidor da Web.

Adicionar rotas para as visualizações do professor e do 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 veicular os iframes da visualização do professor e do estudante também.

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

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

Para este exercício, crie uma única rota /load-content-attachment que veicule as visualizações do professor e do estudante. Use os métodos da API Classroom para determinar se o usuário é um professor ou estudante quando a página é carregada.

@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 neste momento. Você também precisa processar o parâmetro de consulta login_hint aqui e encaminhar o usuário para o fluxo de autorização, se necessário. Consulte os detalhes das orientações de login discutidos nos tutoriais anteriores para mais informações sobre esse fluxo.

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

# 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 turma. Altere a visualização apresentada ao usuário dependendo do papel dele. Exatamente um dos studentContext ou teacherContext campos é preenchido no objeto de resposta. Examine esses campos para determinar como abordar o usuário.

Em qualquer caso, 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 da visualização do professor ou do estudante.

# 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

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

• Faça login no [Google Sala de Aula] como um dos usuários de teste professor.
• Navegue até a guia Atividades e crie uma nova atividade.
• Clique no botão Complementos abaixo da área de texto e selecione seu complemento. O iframe é aberto e o complemento carrega o URI de configuração de anexos especificado na página de 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 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:

• Faça login no Google Sala de Aula como um usuário de teste estudante na mesma turma que o usuário de teste professor.
• Encontre a atividade de teste na guia "Atividades".
• Expanda a atividade e clique no card de anexo para abrir o iframe 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.