Übersicht

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

  • Formular oder Quiz erstellen
  • Teilnehmer am Formular 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 der häufig verwendeten Begriffe in der Forms API:
Form

Ein Google Formular-Dokument, das in 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 enthält. Sie finden die Formular-ID in einer Formular-URL:

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

Quiz

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

Bewertung
Eine Punktzahl, ein Antwortschlüssel und Feedback für eine Frage, die angewendet werden, wenn isQuiz auf true gesetzt ist. Wird durch die Grading Ressource 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 Ressource „Posten“ 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 Question Ressource dargestellt wird.

Fragensammlung

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

Abschnitt

Ein Abschnitt ist eine Möglichkeit, ein Formular in mehrere Seiten aufzuteilen und bedingte Logik hinzuzufügen (z. B. bestimmte Fragen nur basierend auf den Antworten des Nutzers anzuzeigen). Abschnitte entsprechen der PageBreakItem Ressource.

Antwort

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

Antwort

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

Ansehen

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

Formularstruktur

Beim Verwalten von Formularen und Quiz kann es kompliziert sein, verschiedene Felder anzugeben, da viele der Formularobjekte auf verschiedene Arten ineinander verschachtelt werden können. Um zu sehen, wie die visuelle Darstellung eines Formulars den Feldern zugeordnet ist, empfehlen wir, in der Benutzeroberfläche einige Beispiele für Formulare zu erstellen, die Ihre Anwendung möglicherweise generiert. Rufen Sie dann das entsprechende JSON mit der forms.get() Methode ab, damit Sie es vergleichen können. Dieses Beispielquiz entspricht beispielsweise dem 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": "Famous Black Women"
  },
  "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