Übersicht

Die Google Forms API ist eine RESTful-Schnittstelle, mit der Sie Formulare und Quizze erstellen und ändern, Formularantworten und Quiznoten abrufen, Antwortschlüssel für Quizze mit automatischem Feedback einrichten und Push-Benachrichtigungen empfangen können. Die häufigsten Anwendungsfälle dieser API sind die folgenden Aufgaben:

  • Formular oder Quiz erstellen
  • Antworten veröffentlichen und verwalten
  • 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 mit häufig verwendeten Begriffen in der Forms API:
Form

Ein Google-Formular, das in Drive erstellt und gespeichert wurde. Jedes Formular wird durch eine Form-Ressource dargestellt und hat einen eindeutigen formId-Wert, der Buchstaben, Ziffern, Bindestriche oder Unterstriche enthält. Sie finden die Formular-ID in einer Google Formulare-URL:

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

Quiz

Ein spezieller Typ von Google-Formulare-Dokument, mit dem die Antworten auf das Formular anhand eines Antwortschlüssels bewertet werden können. Ein Quiz kann nur erstellt werden, indem die Methode batchUpdate() verwendet wird, um die Einstellung isQuiz für ein vorhandenes Formular auf true zu aktualisieren.

Benotung
Ein Punktwert, ein Lösungsschlüssel und Feedback für eine Frage, die angewendet werden, wenn isQuiz gleich true ist. Wird durch die Ressource Grading dargestellt.
Feedback
Eine Antwort, die dem Endnutzer gegeben wird, wenn er auf eine Frage in einem Quiz antwortet, dargestellt durch die Feedback-Ressource.
Posten

Ein einzelnes Element in einem Formular, das durch die Item-Ressource dargestellt wird. Item ist ein sich wiederholendes Element, das einen Abschnitt, eine Fragensammlung, 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. eine Tabelle mit Bewertungen von 1 bis 5). Wird durch die Ressource QuestionGroupItem dargestellt.

Section

Mit Abschnitten können Sie ein Formular in mehrere Seiten unterteilen und bedingte Logik hinzufügen, z. B. bestimmte Fragen nur dann anzeigen, wenn der Nutzer bestimmte Antworten gibt. Abschnitte entsprechen der Ressource PageBreakItem.

Antwort

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

Antwort

Das 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 Formularantworten erfasst und eine Push-Benachrichtigung sendet, wenn eine Änderung erfolgt. Wird durch die Ressource Watch dargestellt.

Formularstruktur

Die Verwaltung von Formularen und Quiz kann kompliziert sein, da viele der Formularobjekte auf unterschiedliche Weise ineinander verschachtelt sein können. Um zu sehen, wie die visuelle Darstellung eines Formulars den Feldern zugeordnet wird, empfehlen wir, über die Benutzeroberfläche einige Beispiele für Formulare zu erstellen, die Ihre Anwendung möglicherweise generiert. Rufen Sie dann das entsprechende JSON-Dokument mit der Methode forms.get() ab, damit Sie es vergleichen können. Dieses Beispielquiz entspricht beispielsweise dem folgenden JSON-Code:

{
  "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"
              }
            ]
          }
        }
      }
    }
  ],
  "publishSettings" : {
    "isPublished": true,
    "isAcceptingResponses": true
  }
}

Nächste Schritte