タイプと形式の概要
パラメータとスキーマの type
プロパティと format
プロパティを使用して、プロパティのデータ型を特定できます。type
プロパティは、JSON のリクエストおよびレスポンスで送信されるプロパティのタイプを示します(JSON は少数のデータ型をサポートしています。詳しくは json.org をご覧ください)。format
プロパティは、基になる型に関する追加情報を提供します。プロパティは type
プロパティを持ちますが、format
プロパティを持つプロパティもあります。
たとえば、64 ビット整数は JSON では表現できません(JavaScript と JSON が最大 2^53 の整数をサポートしているため)。したがって、64 ビット整数は JSON リクエスト/レスポンスの文字列として表す必要があります。したがって、type
プロパティは &stringt; string" に設定されますが、format
プロパティは "int64" に設定され、64 ビット整数であることを示します。
JSON スキーマ仕様では、すでに format
プロパティの共通の値のセットを定義しています。Google API Discovery Service では、これらの値のいくつかがサポートされ、他の値も定義されます。Google API Discovery Service でサポートされている type
と format
の値の完全なリストは次のとおりです。
値の入力 | フォーマット値 | 意味 |
---|---|---|
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 の日付(YYYY-MM-DD 形式)。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 です。 |