Übersicht

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

  • Formular oder Quiz erstellen
  • Formular oder Quiz aktualisieren
  • Antworten aus einem Formular oder Quiz abrufen
  • Inhalt und Metadaten von Formularen lesen
  • Push-Benachrichtigungen einrichten und erhalten

Im Folgenden finden Sie eine Liste gebräuchlicher Begriffe, die in der Forms API verwendet werden:

Form

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

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

Quiz

Eine bestimmte Art von Google Formulare-Dokument, das die Benotung der Formularantworten anhand eines Antwortschlüssels ermöglicht. Ein Quiz kann nur mit der Methode batchUpdate() erstellt werden, um die Einstellung isQuiz eines vorhandenen Formulars auf true zu aktualisieren.

Benotung
Eine Punktzahl, ein Antwortschlüssel und Feedback für eine Frage, die angewendet wird, wenn isQuiz true ist. Wird durch die Ressource Grading dargestellt.
Feedback
Eine Antwort, die der Endnutzer erhält, wenn er auf eine Frage in einem Quiz antwortet und durch die Ressource Feedback dargestellt wird.
Punkt

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

Question

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

Fragegruppe

Eine Gruppe von Fragen, die alle dieselben Antworten haben (z. B. ein Raster mit Bewertungen von 1 bis 5). Wird durch die Ressource QuestionGroupItem dargestellt.

Section

Ein Abschnitt kann verwendet werden, um ein Formular in mehrere Seiten aufzuteilen und bedingte Logik hinzuzufügen. So werden beispielsweise nur bestimmte Fragen basierend auf den Antworten des Nutzers angezeigt. Die Abschnitte entsprechen der Ressource PageBreakItem.

Antwort

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

Antwort

Das Senden eines Formulars durch den Endnutzer, dargestellt durch die Ressource FormResponse.

Ansehen

Ein Trigger, der Änderungen an Formularschemaänderungen (z. B. Änderungen an Fragen) oder Antworten auf Formularantworten verfolgt und eine Push-Benachrichtigung sendet, wenn eine Änderung auftritt. Wird durch die Ressource Watch dargestellt.

Formularstruktur

Bei der Verwaltung von Formularen und Quizzen kann es schwierig sein, verschiedene Felder anzugeben, da viele Formularobjekte auf verschiedene Arten ineinander verschachtelt werden können. Wir empfehlen, einige Beispiele für Formulare zu verwenden, die von Ihrer Anwendung generiert werden können. Rufen Sie dann die entsprechende JSON-Datei mit der Methode forms.get() ab, damit Sie sie vergleichen können. Zum Beispiel entspricht dieses Beispielquiz 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"
              }
            ]
          }
        }
      }
    }
  ]
}

Nächste Schritte

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