Обзор

API Google Forms — это интерфейс RESTful, который позволяет создавать и изменять формы и тесты, получать ответы на формы и оценки, настраивать ключи ответов на тесты с автоматической обратной связью и получать push-уведомления. Наиболее распространенное использование этого API включает в себя следующие задачи:

  • Создайте форму или тест
  • Обновите форму или тест
  • Получение ответов из формы или теста
  • Чтение содержимого формы и метаданных
  • Настройте и получайте push-уведомления

Ниже приведен список общих терминов, используемых в API форм:

Форма

Документ Google Forms, созданный и сохраненный на Диске. Каждая форма представлена ​​ресурсом Form и имеет уникальное значение formId , содержащее буквы, цифры, дефисы или символы подчеркивания. Идентификатор формы можно найти в URL-адресе Google Forms:

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

Контрольный опрос

Особый тип документа Google Forms, который позволяет оценивать ответы формы по ключу ответа. Тест можно создать только с помощью метода batchUpdate() для обновления параметра isQuiz в существующей форме до значения true .

Оценка
Значение балла, ключ ответа и отзыв на вопрос, применяемые, когда isQuiz имеет значение true . Представлен ресурсом Grading .
Обратная связь
Ответ, предоставляемый конечному пользователю при ответе на вопрос викторины, представленный ресурсом Feedback .
Элемент

Одиночный элемент в форме, представленный ресурсом Item . Item — повторяющийся элемент, который может содержать раздел, группу вопросов, вопрос, текст, изображение или видео.

Вопрос

Один вопрос в форме, представленной ресурсом Question .

Группа вопросов

Группа вопросов, которые имеют один и тот же набор возможных ответов (например, сетка оценок от 1 до 5). Представлен ресурсом QuestionGroupItem .

Раздел

Раздел – это способ разбить форму на несколько страниц и добавить условную логику (например, показывать только определенные вопросы в зависимости от ответов пользователя). Разделы соответствуют ресурсу PageBreakItem .

Отвечать

Ответ конечного пользователя на вопрос, представленный ресурсом Answer . Включает как информацию об оценках (если есть), метаданные, так и содержание ответа.

Ответ

Отправка формы конечным пользователем, представленная ресурсом FormResponse .

Смотреть

Триггер, который отслеживает изменения в схеме формы (например, изменения в вопросах) или отправке ответов на форму и отправляет push-уведомление при возникновении изменения. Представлен ресурсом Watch .

Структура формы

При управлении формами и тестами понимание того, как указывать различные поля, может оказаться сложным, поскольку многие объекты форм могут быть вложены друг в друга разными способами. Чтобы увидеть, как визуальное представление формы сопоставляется с полями, мы рекомендуем использовать пользовательский интерфейс для создания нескольких примеров форм, которые может генерировать ваше приложение. Затем получите соответствующий JSON с помощью метода forms.get() чтобы можно было сравнить. Например, этот пример теста соответствует следующему 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"
              }
            ]
          }
        }
      }
    }
  ]
}

Следующие шаги