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. Zu den häufigsten Verwendungszwecken dieser API gehören die folgenden Aufgaben:
- Formular oder Quiz erstellen
- Formular oder Quiz aktualisieren
- Antworten aus einem Formular oder Quiz abrufen
- Formularinhalte und -metadaten lesen
- Push-Benachrichtigungen einrichten und erhalten
Im Folgenden finden Sie eine Liste häufig verwendeter Begriffe in der Forms API:
- Form
Ein Google-Formulardokument, 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. Sie finden die Formular-ID in einer Google Forms-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 EinstellungisQuiz
in einem vorhandenen Formular auftrue
zu aktualisieren.- Benotung
- Punktzahl, Lösungsschlüssel und Feedback für eine Frage, die angewendet werden, wenn
isQuiz
=true
ist. Wird durch die RessourceGrading
dargestellt. - Feedback
- Eine Antwort, die dem Endnutzer gegeben wird, wenn er eine Frage in einem Quiz beantwortet, dargestellt durch die Ressource
Feedback
.
- Posten
Ein einzelnes Element in einem Formular, dargestellt durch die Ressource Element.
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, 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
Ein Abschnitt ist eine Möglichkeit, ein Formular in mehrere Seiten aufzuteilen und bedingte Logik hinzuzufügen (z. B. nur bestimmte Fragen anzeigen, je nachdem, wie der Nutzer antwortet). 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
Einreichen eines Formulars durch den Endnutzer, dargestellt durch die Ressource
FormResponse
.- Ansehen
Ein Trigger, der Änderungen an Formularschemata (z. B. Änderungen an Fragen) oder an Formularantworten erfasst und eine Push-Benachrichtigung sendet, wenn eine Änderung auftritt. 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, empfehlen wir Ihnen, mit der Benutzeroberfläche einige Beispiele für Formulare zu erstellen, die Ihre Anwendung generieren könnte. Rufen Sie dann mit der Methode forms.get()
die entsprechende JSON-Datei ab, um sie zu vergleichen. 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
- Weitere Informationen zur Entwicklung mit Google Workspace APIs, einschließlich Authentifizierung und Autorisierung, finden Sie unter Einstieg als Workspace-Entwickler.
- Informationen zum Konfigurieren und Ausführen einer einfachen Forms API-App finden Sie in der Übersicht über die Kurzanleitungen.