Übersicht

Die Google Forms API ist eine RESTful-Oberfläche, mit der Sie Formulare erstellen und ändern können. und Quizfragen, Formularantworten und Quiznoten abrufen, Antwortschlüssel für Quizze einrichten mit automatischem Feedback und Push-Benachrichtigungen. 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 Formulare-Dokument, 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

Eine spezielle Art von Google Formulare-Dokument, mit dem Sie die Formularantworten gegen einen Antwortschlüssel an. Ein Quiz kann nur mit der batchUpdate() zum Aktualisieren der isQuiz-Einstellung für ein vorhandenes Formular auf true.

Benotung

Eine Punktzahl, ein Antwortschlüssel und ein Feedback für eine Frage werden angewendet, wenn isQuiz hat den Wert true. 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. Item ist ein sich wiederholendes Element, das einen Abschnitt, eine Fragengruppe, eine Frage Text, Bild oder Video.

Frage

Eine einzelne Frage im Formular, dargestellt durch das Question-Ressource.

Fragengruppe

Eine Gruppe von Fragen, die alle die gleichen möglichen Antworten haben (für ein Raster von Bewertungen von 1 bis 5). Vertreten durch die QuestionGroupItem .

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). Die Abschnitte entsprechen den PageBreakItem .

Antwort

Die Antwort der Endanwendenden auf eine Frage, dargestellt durch das Answer . Enthält Noteninformationen (falls vorhanden), Metadaten und Inhalt der Antwort.

Antwort

Das Einreichen eines Formulars durch den Endnutzer, dargestellt durch das FormResponse-Ressource.

Ansehen

Ein Trigger, der Änderungen an Formularschema-Änderungen (z. B. Bearbeitungen) verfolgt oder das Senden von Formularantworten und sendet eine Push-Benachrichtigung, dass eine Änderung auftritt. Vertreten durch die Watch-Ressource.

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. Beispiel: dieses Beispielquiz entspricht 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

• Um mehr über die Entwicklung mit Google Workspace APIs zu erfahren, einschließlich der Handhabung von Authentifizierung und Autorisierung, siehe Erste Schritte als Workspace-Entwickler
• Informationen zum Konfigurieren und Ausführen einer einfachen Forms API-Anwendung finden Sie in der Kurzanleitungen