Die Google Forms API ist eine RESTful-Oberfläche, mit der Sie Formulare und Quizze erstellen und ändern, Formularantworten und Quiznoten abrufen, Antwortschlüssel für Quizze mit automatischem Feedback einrichten und Push-Benachrichtigungen erhalten können. Die API wird unter anderem für folgende Aufgaben 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 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 wird durch eine
Form
-Ressource dargestellt und hat einen eindeutigenformId
-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
Eine bestimmte Art von Google Formulare-Dokument, mit dem die Formularantworten anhand eines Antwortschlüssels benotet werden können. Ein Quiz kann nur mit der Methode
batchUpdate()
erstellt werden, um die EinstellungisQuiz
für ein vorhandenes Formular auftrue
zu aktualisieren.- Punkt
Ein einzelnes Element in einem Formular, dargestellt durch die Ressource Item.
Item
ist ein sich wiederholendes Element, das einen Abschnitt, eine Fragengruppe, eine Frage, einen Text, ein Bild oder ein Video enthalten kann.- Frage
Eine einzelne Frage im Formular, dargestellt durch die Ressource
Question
.- Fragengruppe
Eine Gruppe von Fragen, die alle die gleichen möglichen Antworten haben (z. B. ein Bewertungsraster von 1 bis 5). Wird durch die Ressource
QuestionGroupItem
dargestellt.- Abschnitt
Ein Abschnitt ist eine Möglichkeit, ein Formular in mehrere Seiten aufzuteilen und bedingte Logik hinzuzufügen (z. B. werden nur bestimmte Fragen angezeigt, je nachdem, wie der Nutzer antwortet). Die 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
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 an Formularantworten verfolgt und eine Push-Benachrichtigung sendet, wenn eine Änderung vorgenommen wird. Wird durch die Ressource
Watch
dargestellt.
Formularstruktur
Bei der Verwaltung von Formularen und Quizfragen kann es kompliziert sein, verschiedene Felder anzugeben, da viele der Formularobjekte auf mehrere Arten ineinander verschachtelt werden können. Wenn Sie sehen möchten, wie die visuelle Darstellung eines Formulars den Feldern zugeordnet wird, sollten Sie auf der Benutzeroberfläche einige Beispiele für Formulare erstellen, die von Ihrer Anwendung generiert werden könnten. Rufen Sie dann die entsprechende JSON-Datei mit der Methode forms.get()
ab, damit Sie sie vergleichen können. 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 zum Entwickeln mit Google Workspace APIs, einschließlich der Authentifizierung und Autorisierung, finden Sie unter Erste Schritte als Workspace-Entwickler.
- Informationen zum Konfigurieren und Ausführen einer einfachen Forms API-Anwendung finden Sie in der Kurzanleitung zu Kurzanleitungen.