Przegląd

Interfejs Formularzy Google to interfejs typu REST do tworzenia i modyfikowania formularzy i quizy, pobieranie odpowiedzi z formularzy i ocen, konfigurowanie kluczy odpowiedzi w quizach z automatycznymi opiniami i powiadomieniami push. Najczęstsze zastosowania tego interfejsu API obejmuje następujące zadania:

• Tworzenie formularza lub testu
• Aktualizowanie formularza lub testu
• Pobieranie odpowiedzi z formularza lub testu
• Odczytywanie treści i metadanych formularza
• Konfigurowanie i odbieranie powiadomień push

Poniżej znajduje się lista popularnych terminów używanych w interfejsie Formularzy API:

Formularz

Dokument z Formularzy Google utworzony i zapisany na Dysku. Każdy formularz jest reprezentowany przez zasób Form i ma unikalną wartość formId, która zawiera litery, cyfry, łączniki lub podkreśleń. Identyfikator formularza znajdziesz w adresie URL Formularzy Google:

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

Test

Konkretny typ dokumentu w Formularzach Google, który umożliwia ocenianie odpowiedzi z formularza z kluczem odpowiedzi. Test można utworzyć tylko przy użyciu: batchUpdate() zmiany ustawienia isQuiz w istniejącym formularzu na true.

Ocenianie

Wartość punktowa, klucz odpowiedzi i opinia na temat pytania stosowane, gdy isQuiz – true. Reprezentowane przez Grading.

Prześlij opinię

Odpowiedź udzielana użytkownikowi podczas odpowiadania na pytanie w quizie. reprezentowane przez Feedback .

Element

Pojedynczy element w formie reprezentowany przez Zasób Item. Item to powtarzający się element, który może zawierać sekcję, grupę pytań, pytanie tekstowych, graficznych czy wideo.

Pytanie

Jedno pytanie w formularzu, wyświetlane symbolem Question.

Grupa pytań

Grupa pytań, które mają taki sam zestaw możliwych odpowiedzi (na np. siatkę ocen od 1 do 5). Reprezentowane przez QuestionGroupItem .

Sekcja

Sekcja to sposób na podzielenie formularza na wiele stron i dodanie do niego logiki warunkowej (np. wyświetlanie tylko niektórych pytań na podstawie tego, jak odpowiedzi użytkowników). Sekcje odpowiadają PageBreakItem .

Odpowiedź

Odpowiedź użytkownika na pytanie, reprezentowana przez Answer . Zawiera zarówno informacje o ocenie (jeśli są dostępne), metadane treść odpowiedzi.

Odpowiedź

przesłany przez użytkownika formularz, reprezentowany przez FormResponse.

Oglądaj

Reguła śledząca zmiany w schemacie jednego z formularzy (np. edycje) na pytania) lub formularza odpowiedzi i wysyła powiadomienie push, nastąpi zmiana. Reprezentowane przez Watch.

Struktura formularza

Znajomość sposobu określania różnych pól podczas zarządzania formularzami i testami może być skomplikowane, ponieważ wiele obiektów formularza może być zagnieżdżonych wewnątrz na różne sposoby. Aby zobaczyć, jak wizualna reprezentacja formularza mapuje się na pola, zalecamy użycie interfejsu użytkownika do utworzenia kilku przykładów które może generować Twoja aplikacja. Następnie pobierz odpowiedni plik JSON za pomocą metody forms.get() i móc porównać. Przykład: ten przykładowy quiz odpowiada temu plikowi 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"
              }
            ]
          }
        }
      }
    }
  ]
}

Dalsze kroki

• Aby dowiedzieć się więcej o programowaniu z użyciem interfejsów Google Workspace API, w tym o obsłudze uwierzytelnianie i autoryzacja, zapoznaj się z artykułem Wypróbuj Workspace jako deweloper
• Aby dowiedzieć się, jak skonfigurować i uruchomić prostą aplikację Formularzy API, przeczytaj Krótkie wprowadzenia