Сводка по типу и формату

Свойства type и format параметров и схем можно использовать для определения типа данных свойства. Свойство type указывает тип свойства при его отправке в запросах и ответах JSON (JSON поддерживает небольшой набор типов данных, подробности см. на json.org ). Свойство format предоставляет дополнительную информацию о базовом типе. Свойства всегда будут иметь свойство type , но некоторые могут также иметь свойство format .

Например, 64-битное целое число не может быть представлено в формате JSON (поскольку JavaScript и JSON поддерживают целые числа до 2^53). Поэтому 64-битное целое число должно быть представлено в виде строки в запросах/ответах JSON. Таким образом, для свойства type будет установлено значение «строка», а для свойства format будет установлено значение «int64», чтобы указать, что это 64-битное целое число.

Спецификация схемы JSON уже определяет набор общих значений для свойства format . Служба обнаружения API Google поддерживает некоторые из этих значений, а также определяет другие. Полный список значений type и format , поддерживаемых службой обнаружения API Google, приведен ниже.

Введите значение Значение формата Значение
any Свойство может иметь любой тип. Определяется спецификацией схемы JSON .
array Массив значений JavaScript. Свойство items указывает схему для значений массива. Определяется спецификацией схемы JSON.
boolean Логическое значение, либо "true", либо "false". Определяется спецификацией схемы JSON.
integer int32 32-битное целое число со знаком. Он имеет минимальное значение -2 147 483 648 и максимальное значение 2 147 483 647 (включительно).
integer uint32 32-битное целое число без знака. Он имеет минимальное значение 0 и максимальное значение 4 294 967 295 (включительно).
number double 64-битный IEEE 754 с плавающей запятой двойной точности.
number float 32-разрядная IEEE 754 с плавающей запятой одинарной точности.
object Объект JavaScript. Определяется спецификацией схемы JSON.
string Произвольная строка. Определяется спецификацией схемы JSON.
string byte Дополненная строка байтов в кодировке base64, закодированная с помощью URL-адреса и безопасного алфавита имени файла (иногда называемого «веб-безопасным» или «base64url»). Определяется RFC4648 .
string date Дата RFC3339 в формате ГГГГ-ММ-ДД. Определено в спецификации схемы JSON.
string date-time Временная метка RFC3339 в формате UTC. Это в формате yyyy-MM-ddTHH:mm:ss.SSSZ. Часть миллисекунд ("".SSS") является необязательной. Определено в спецификации схемы JSON.
string google-datetime Временная метка RFC3339 в формате UTC. Это в формате yyyy-MM-ddTHH:mm:ss.SSSZ. Часть миллисекунд ("".SSS") является необязательной.
string google-duration Строка заканчивается суффиксом «s» (указывающим секунды) и предшествует количеству секунд, при этом наносекунды выражаются в долях секунды. Точка всегда используется как десятичная точка, а не запятая.
string google-fieldmask Строка, в которой имена полей разделены запятой. Имена полей представлены в соответствии с соглашениями об именах нижнего верблюда.
string int64 64-битное целое число со знаком. Он имеет минимальное значение -9 223 372 036 854 775 808 и максимальное значение 9 223 372 036 854 775 807 (включительно).
string uint64 64-битное целое число без знака. Он имеет минимальное значение 0 и максимальное значение (2^64)-1 (включительно).