Übersicht

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

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

Nachfolgend finden Sie eine Liste häufiger Begriffe, die in der Formulare API verwendet werden:

Form

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

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

Quiz

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

Benotung
Eine Punktzahl, ein Antwortschlüssel und Feedback zu einer Frage, die angewendet werden, wenn isQuiz den Wert true hat. Repräsentiert durch die Ressource Grading.
Feedback
Eine Antwort, die dem Endnutzer bei der Beantwortung einer Frage in einem Quiz gegeben wird. Sie wird durch die Ressource Feedback dargestellt.
Punkt

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

Question

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

Fragengruppe

Eine Gruppe von Fragen, die alle die gleichen möglichen Antworten haben (z. B. ein Raster mit Bewertungen von 1 bis 5). Repräsentiert durch die Ressource QuestionGroupItem.

Abschnitt

Ein Abschnitt ist eine Möglichkeit, ein Formular in mehrere Seiten zu unterteilen und eine bedingte Logik hinzuzufügen (z. B. werden bestimmte Fragen basierend darauf angezeigt, 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

Vom Endnutzer gesendete Formulare, dargestellt durch die Ressource FormResponse.

Ansehen

Ein Trigger, der Änderungen an Formularschemaänderungen (z. B. Änderungen an Fragen) oder an Einreichungen von Formularantworten verfolgt und eine Push-Benachrichtigung sendet, wenn eine Änderung erfolgt. Repräsentiert durch die Ressource Watch.

Formularstruktur

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

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

  • Weitere Informationen zur Entwicklung mit Google Workspace APIs, einschließlich der Authentifizierung und Autorisierung, finden Sie unter Erste Schritte als Workspace-Entwickler.
  • Wie Sie eine einfache Formulare API-Anwendung konfigurieren und ausführen, erfahren Sie in der Kurzanleitung.