Übersicht

Die Google Formulare API ist eine RESTful-Oberfläche. Sie können damit Formulare und Quizze erstellen und ändern, Formularantworten und Quiznoten abrufen, Antwortschlüssel für Quizfragen mit automatischem Feedback einrichten und Push-Benachrichtigungen erhalten. Diese API wird für die folgenden Aufgaben am häufigsten verwendet:

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

Nachfolgend finden Sie eine Liste häufig verwendeter Begriffe in der Formulare-API:

Form

Ein Google Formulare-Dokument, das in Google 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. Die Formular-ID finden Sie in der Google Formulare-URL:

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

Quiz

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

Benotung
Eine Punktzahl, ein Antwortschlüssel und Feedback zu einer Frage werden angewendet, wenn isQuiz den Wert true hat. Dargestellt durch die Ressource Grading.
Feedback
Eine Antwort, die der Endnutzer erhält, wenn er eine Frage in einem Quiz beantwortet. 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, die durch die Ressource Question dargestellt wird.

Fragengruppe

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

Section

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 geantwortet hat). Abschnitte entsprechen der Ressource PageBreakItem.

Antwort

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

Antwort

Die Einreichung eines Formulars durch den Endnutzer, dargestellt durch die Ressource FormResponse.

Ansehen

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

Struktur des Formulars

Bei der Verwaltung von Formularen und Quizzen kann es kompliziert sein, verschiedene Felder anzugeben, da viele 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.