Übersicht

Die Google Forms API ist eine RESTful-Schnittstelle, mit der Sie Formulare und Quizze erstellen und ändern, Formularantworten und Quiznoten abrufen, Quiz-Antwortschlüssel mit automatischem Feedback einrichten und Push-Benachrichtigungen erhalten können. Zu den häufigsten Verwendungszwecken dieser API gehören die folgenden Aufgaben:

  • Formular oder Quiz erstellen
  • Formular oder Quiz aktualisieren
  • Antworten aus einem Formular oder Quiz abrufen
  • Formularinhalte und Metadaten lesen
  • Push-Benachrichtigungen einrichten und empfangen

Im Folgenden finden Sie eine Liste häufig verwendeter Begriffe in der Forms API:

Form

Ein Google-Formulardokument, das in Google Drive erstellt und gespeichert wurde. Jedes Formular wird durch eine Form-Ressource dargestellt und hat einen eindeutigen formId-Wert, der Buchstaben, Zahlen, Bindestriche oder Unterstriche enthalten kann. Sie finden die Formular-ID in einer Google Forms-URL:

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

Quiz

Ein bestimmter Google-Formulardokumenttyp, mit dem die Formularantworten anhand eines Antwortschlüssels benotet werden können. Ein Quiz kann nur mit der Methode batchUpdate() erstellt werden, um die Einstellung isQuiz in einem vorhandenen Formular auf true zu aktualisieren.

Benotung
Punktzahl, Lösungsschlüssel und Feedback für eine Frage, die angewendet werden, wenn isQuiz = true ist. Wird durch die Ressource Grading dargestellt.
Feedback
Eine Antwort, die dem Endnutzer gegeben wird, wenn er eine Frage in einem Quiz beantwortet. Sie wird durch die Ressource Feedback dargestellt.
Posten

Ein einzelnes Element in einem Formular, dargestellt durch die Ressource Element. Item ist ein wiederkehrendes Element, das einen Abschnitt, eine Fragegruppe, eine Frage, Text, ein Bild oder ein Video enthalten kann.

Frage

Eine einzelne Frage im Formular, die durch die Ressource Question dargestellt wird.

Fragegruppe

Eine Gruppe von Fragen, die alle dieselben möglichen Antworten haben (z. B. ein Bewertungsraster von 1 bis 5). Wird durch die Ressource QuestionGroupItem dargestellt.

Section

Mit einem Abschnitt können Sie ein Formular in mehrere Seiten unterteilen und bedingte Logik hinzufügen, z. B. nur bestimmte Fragen anzeigen, je nachdem, wie der Nutzer antwortet. Abschnitte entsprechen der Ressource PageBreakItem.

Antwort

Die Antwort des Endnutzers auf eine Frage, dargestellt durch die Ressource Answer. Enthält sowohl Informationen zur Note (falls vorhanden), Metadaten als auch den Inhalt der Antwort.

Antwort

Einreichen eines Formulars durch den Endnutzer, dargestellt durch die Ressource FormResponse.

Ansehen

Ein Trigger, der Änderungen am Formularschema (z. B. Änderungen an Fragen) oder an den gesendeten Formularantworten erfasst und bei einer Änderung eine Push-Benachrichtigung sendet. Wird durch die Ressource Watch dargestellt.

Formularstruktur

Beim Verwalten von Formularen und Quizzen kann es schwierig sein, verschiedene Felder anzugeben, da viele der Formularobjekte auf unterschiedliche Weise verschachtelt werden können. Wenn Sie sehen möchten, wie die visuelle Darstellung eines Formulars den Feldern zugeordnet wird, empfehlen wir Ihnen, über die Benutzeroberfläche einige Beispiele für Formulare zu erstellen, die Ihre Anwendung generieren könnte. Rufen Sie dann mit der Methode forms.get() die entsprechende JSON-Datei ab, um sie zu vergleichen. Dieses Beispielquiz entspricht beispielsweise der folgenden JSON-Datei:

{
  "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"
              }
            ]
          }
        }
      }
    }
  ]
}

Nächste Schritte