Übersicht

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

  • 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 gebräuchlicher Begriffe, die in der Forms API verwendet werden:

Form

Ein Google-Formulardokument, das in Google Drive erstellt und gespeichert wurde. Jedes Formular ist dargestellt durch eine Form-Ressource und einen eindeutigen formId-Wert haben, der Buchstaben, Ziffern, Bindestriche oder Unterstriche enthalten. Die Formular-ID finden Sie in der Google Formulare-URL:

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

Quiz

Ein bestimmter Google-Formulardokumenttyp, mit dem die Formularantworten anhand eines Antwortschlüssels benotet werden können. Ein Quiz kann nur mit der Methode batchUpdate() erstellt werden, um die Einstellung isQuiz in einem vorhandenen Formular auf true zu aktualisieren.

Benotung
Punktzahl, Lösungsschlüssel und Feedback für eine Frage, die angewendet werden, wenn isQuiz = true ist. Vertreten durch die Grading.
Feedback
Die Antwort, die der Endnutzer erhält, wenn er eine Frage zu einem Quiz beantwortet. dargestellt durch die Feedback .
Posten

Ein einzelnes Element in einem Formular, dargestellt durch das Item-Ressource angezeigt wird. Item ist ein wiederkehrendes Element, das einen Abschnitt, eine Fragegruppe, 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. ein Bewertungsraster von 1 bis 5). Wird durch die Ressource QuestionGroupItem dargestellt.

Section

Mithilfe von Abschnitten können Sie ein Formular in mehrere Seiten unterteilen und bedingte Logik (z. B. die Anzeige bestimmter Fragen basierend darauf, die Antworten der Nutzenden). 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

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 den gesendeten Formularantworten erfasst und bei einer Änderung eine Push-Benachrichtigung sendet. Vertreten durch die Watch.

Formularstruktur

Bei der Verwaltung von Formularen und Quizzen: Kenntnisse über die Angabe verschiedener Felder kann kompliziert sein, da viele der Formularobjekte in sich gegenseitig auf mehrere Arten nutzen. Um zu sehen, wie die visuelle Darstellung eines Formulars den Feldern zugeordnet ist, empfehlen wir die Verwendung der Benutzeroberfläche, um einige Beispiele Formulare, die Ihre Anwendung generieren könnte. Rufen Sie dann die entsprechende JSON-Datei ab, mit der Methode forms.get() damit Sie sie vergleichen können. Dieses Beispielquiz entspricht beispielsweise der folgenden JSON-Datei:

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