Aperçu

L'API Google Forms est une interface RESTful qui vous permet de créer et de modifier des formulaires. et questionnaires, récupérer les réponses aux formulaires et les notes, configurer des clés de réponse avec commentaires automatiques et recevoir des notifications push. Utilisations les plus courantes de cette API incluent les tâches suivantes:

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

Vous trouverez ci-dessous la 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 comporte une valeur formId unique, contenant des lettres, des chiffres, des traits d'union ou et des traits de soulignement. Vous trouverez l'ID du formulaire dans une URL Google Forms:

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

Quiz

Il s'agit d'un type de document Google Forms spécifique permettant de noter les les réponses du formulaire par rapport à un corrigé. Vous ne pouvez créer un quiz qu'en utilisant le batchUpdate() pour remplacer le paramètre isQuiz d'un formulaire existant par true.

Notation
Un barème de notation, un corrigé et un commentaire pour une question, appliqués lorsque "isQuiz" est "true". Représenté par la paire valeur/clé Ressource Grading.
Commentaires
Réponse donnée à l'utilisateur final lorsqu'il répond à une question dans un questionnaire représentées par les Feedback ressource.
Élément

Un seul élément dans une forme, représenté par le Item. Item est un élément répété pouvant contenir une section, un groupe de questions, une question de texte, d'image ou de vidéo.

Question

Une seule question sur le formulaire, représentée par le Ressource Question.

Groupe de questions

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

Section

Une section est un moyen de diviser un formulaire en plusieurs pages et d'ajouter logique conditionnelle (par exemple, n'afficher que certaines questions en fonction de la façon dont réponses de l'utilisateur). Les sections correspondent aux PageBreakItem ressource.

Réponse

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

Réponse

Envoi d'un formulaire par l'utilisateur final, représenté par l'icône Ressource FormResponse.

Montre

Un déclencheur qui suit les modifications apportées au schéma du formulaire (comme les modifications) aux questions) ou l'envoi de réponses à un formulaire, et envoie une notification push un changement se produit. Représenté par la paire valeur/clé Ressource Watch.

Structure du formulaire

Savoir spécifier différents champs pour gérer des formulaires et des questionnaires peut être compliqué, étant donné que de nombreux objets de formulaire peuvent être imbriqués dans les uns les autres de plusieurs manières. Pour voir comment la représentation visuelle d'un formulaire correspondent aux champs, nous vous recommandons d'utiliser l'interface utilisateur pour créer quelques exemples que votre application pourrait générer. Ensuite, récupérez le fichier JSON à l'aide de la méthode forms.get() ; pour que vous puissiez les comparer. Par exemple : cet exemple de quiz correspond au fichier 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