خلاصه تایپ و قالب
ویژگی‌های type و format روی پارامترها و طرحواره‌ها می‌تواند برای تعیین نوع داده ویژگی استفاده شود. ویژگی type نشان دهنده نوع خاصیت زمانی است که در JSON درخواست و پاسخ می دهد (JSON از مجموعه کوچکی از انواع داده ها پشتیبانی می کند، برای جزئیات به json.org مراجعه کنید). ویژگی format اطلاعات بیشتری در مورد نوع اصلی ارائه می دهد. ویژگی ها همیشه دارای یک خاصیت type هستند، اما برخی ممکن است دارای ویژگی format نیز باشند.
به عنوان مثال، یک عدد صحیح 64 بیتی را نمی توان در JSON نشان داد (زیرا جاوا اسکریپت و JSON از اعداد صحیح تا 2^53 پشتیبانی می کنند). بنابراین، یک عدد صحیح 64 بیتی باید به عنوان یک رشته در درخواست ها/پاسخ های JSON نمایش داده شود. بنابراین ویژگی type روی "string" تنظیم می شود، اما ویژگی format روی "int64" تنظیم می شود تا نشان دهد که یک عدد صحیح 64 بیتی است.
مشخصات طرحواره JSON قبلاً مجموعه ای از مقادیر مشترک را برای ویژگی format تعریف می کند. Google APIs Discovery Service از برخی از این مقادیر پشتیبانی می کند و برخی دیگر را نیز تعریف می کند. لیست کامل مقادیر type و format پشتیبانی شده توسط Google APIs Discovery Service در زیر خلاصه شده است.
| مقدار را تایپ کنید | مقدار فرمت | معنی |
|---|---|---|
any | | ملک ممکن است هر نوع داشته باشد. توسط مشخصات طرحواره JSON تعریف شده است. |
array | | آرایه ای از مقادیر جاوا اسکریپت. ویژگی items طرحواره مقادیر آرایه را نشان می دهد. توسط مشخصات JSON Schema تعریف شده است. |
boolean | | یک مقدار بولی، یا "درست" یا "نادرست". توسط مشخصات JSON Schema تعریف شده است. |
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 | | یک شی جاوا اسکریپت توسط مشخصات JSON Schema تعریف شده است. |
string | | یک رشته دلخواه توسط مشخصات JSON Schema تعریف شده است. |
string | byte | رشته‌ای از بایت‌های محفظه‌شده و کدگذاری‌شده با base64، که با URL و نام فایل الفبای ایمن کدگذاری شده است (گاهی اوقات به عنوان "web-safe" یا "base64url" شناخته می‌شود). توسط RFC4648 تعریف شده است. |
string | date | تاریخ RFC3339 در قالب YYYY-MM-DD. در مشخصات JSON Schema تعریف شده است. |
string | date-time | یک مهر زمانی RFC3339 در زمان UTC. این در قالب yyyy-MM-ddTHH:mm:ss.SSSZ. بخش میلی ثانیه ای (."SSS") اختیاری است. در مشخصات JSON Schema تعریف شده است. |
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 (شامل). |