Aperçu

L'API Google Forms est une interface RESTful qui vous permet de créer et de modifier des formulaires et des questionnaires, de récupérer les réponses aux formulaires et les notes des questionnaires, de configurer les réponses aux questionnaires avec des commentaires automatiques et de recevoir des notifications push. Les utilisations les plus courantes de cette API sont les suivantes:

  • Créer un formulaire ou un questionnaire
  • Mettre à jour un formulaire ou un questionnaire
  • Récupérer les réponses d'un formulaire ou d'un questionnaire
  • Lire le contenu d'un formulaire et les métadonnées
  • Configurer et recevoir des notifications push

Vous trouverez ci-dessous une liste des termes couramment utilisés dans l'API Forms:

Form

Un document Google Forms, créé et stocké dans Drive. Chaque formulaire est représenté par une ressource Form et possède une valeur formId unique contenant des lettres, des chiffres, des traits d'union ou des traits de soulignement. L'ID du formulaire se trouve dans une URL Google Forms:

https://docs.google.com/forms/d/FORM_ID/edit

Quiz

Type spécifique de document Google Forms qui permet de noter les réponses aux questions d'un formulaire. Vous ne pouvez créer un questionnaire qu'en utilisant la méthode batchUpdate() pour remplacer le paramètre isQuiz d'un formulaire existant par true.

Note
Barème de notation, barème de réponse et commentaires pour une question, appliqués lorsque isQuiz est true. Représenté par la ressource Grading.
Commentaires
Réponse donnée à l'utilisateur final lorsqu'il répond à une question d'un quiz, représentée par la ressource Feedback.
Élément

Un seul élément d'un formulaire, représenté par la ressource Item. Item est un élément récurrent qui peut contenir une section, un groupe de questions, une question, un texte, une image ou une vidéo.

Question

Une seule question du formulaire, représentée par la ressource Question.

Groupe de questions

Un groupe de questions qui partagent le même ensemble de réponses possibles (par exemple, une grille de notes de 1 à 5). Représenté par la ressource QuestionGroupItem.

Section

Une section permet de diviser un formulaire en plusieurs pages et d'ajouter une logique conditionnelle (par exemple, l'affichage de certaines questions selon la réponse de l'utilisateur). Les sections correspondent à la ressource PageBreakItem.

Réponse

Réponse de l'utilisateur final à une question, représentée par la ressource Answer. Inclut à la fois les informations sur les notes (le cas échéant), les métadonnées et le contenu de la réponse.

Response (Réponse)

Envoi d'un formulaire par l'utilisateur final, représenté par la ressource FormResponse.

Vidéos

Déclencheur qui suit les modifications apportées au schéma (par exemple, les modifications apportées aux questions) ou aux réponses envoyées et envoie une notification push lorsqu'un changement se produit. Représenté par la ressource Watch.

Structure du formulaire

Lorsque vous gérez des formulaires et des questionnaires, il peut être compliqué de comprendre comment spécifier différents champs, car de nombreux objets de formulaire peuvent être imbriqués les uns dans les autres de différentes manières. Pour voir comment la représentation visuelle d'un formulaire correspond aux champs, nous vous recommandons d'utiliser l'interface utilisateur pour créer quelques exemples de formulaires que votre application pourrait générer. Ensuite, récupérez le fichier JSON correspondant à l'aide de la méthode forms.get() afin de pouvoir comparer. Par exemple, cet exemple de quiz correspond au format JSON suivant:

{
  "formId": "FORM_ID",
  "info": {
    "title": "Famous Black Women",
    "description": "Please complete this quiz based off of this week's readings for class.",
    "documentTitle": "API Example Quiz"
  },
  "settings": {
    "quizSettings": {
      "isQuiz": true
    }
  },
  "revisionId": "00000021",
  "responderUri": "https://docs.google.com/forms/d/e/1FAIpQLSd0iBLPh4suZoGW938EU1WIxzObQv_jXto0nT2U8HH2KsI5dg/viewform",
  "items": [
    {
      "itemId": "5d9f9786",
      "imageItem": {
        "image": {
          "contentUri": "DIRECT_URL",
          "properties": {
            "alignment": "LEFT"
          }
        }
      }
    },
    {
      "itemId": "72b30353",
      "title": "Which African American woman authored \"I Know Why the Caged Bird Sings\"?",
      "questionItem": {
        "question": {
          "questionId": "25405d4e",
          "required": true,
          "grading": {
            "pointValue": 2,
            "correctAnswers": {
              "answers": [
                {
                  "value": "Maya Angelou"
                }
              ]
            }
          },
          "choiceQuestion": {
            "type": "RADIO",
            "options": [
              {
                "value": "Maya Angelou"
              },
              {
                "value": "bell hooks"
              },
              {
                "value": "Alice Walker"
              },
              {
                "value": "Roxane Gay"
              }
            ]
          }
        }
      }
    },
    {
      "itemId": "0a4859c8",
      "title": "Who was the first Dominican-American woman elected to state office?",
      "questionItem": {
        "question": {
          "questionId": "37fff47a",
          "grading": {
            "pointValue": 2,
            "correctAnswers": {
              "answers": [
                {
                  "value": "Grace Diaz"
                }
              ]
            }
          },
          "choiceQuestion": {
            "type": "RADIO",
            "options": [
              {
                "value": "Rosa Clemente"
              },
              {
                "value": "Grace Diaz"
              },
              {
                "value": "Juana Matias"
              },
              {
                "value": "Sabrina Matos"
              }
            ]
          }
        }
      }
    }
  ]
}

Étapes suivantes