سند کشف

اسناد کشف برای نسخه‌های خاصی از اکثر APIها در دسترس هستند. سند کشف هر API، سطح API، نحوه دسترسی به API و نحوه ساختار درخواست‌ها و پاسخ‌های API را شرح می‌دهد. اطلاعات ارائه شده توسط سند کشف شامل ویژگی‌های سطح API مانند شرح API، طرحواره‌های منابع، حوزه‌های احراز هویت و روش‌ها است.

روش‌ها

سند Discovery بر روی روش RESTful برای فراخوانی یک API تمرکز دارد. متد discovery.apis.list لیستی از تمام API های پشتیبانی شده توسط سرویس کشف API های گوگل، از جمله آدرس های اینترنتی برای بازیابی اسناد کشف مبتنی بر REST را برمی گرداند.

فهرست

فهرست APIهای پشتیبانی‌شده در این نقطه پایانی را بازیابی کنید.

بازنمایی منابع

{
  "kind": "discovery#restDescription",
  "discoveryVersion": "v1",
  "id": string,
  "name": string,
  "canonicalName": string,
  "version": string,
  "revision": string,
  "title": string,
  "description": string,
  "icons": {
    "x16": string,
    "x32": string
  },
  "documentationLink": string,
  "labels": [
    string
  ],
  "protocol": "rest",
  "baseUrl": string,
  "basePath": string,
  "rootUrl": string,
  "servicePath": string,
  "batchPath": "batch",
  "endpoints": [
    {
      "endpointUrl": string,
      "location": string,
      "deprecated": boolean,
      "description": string
    }
  ],
  "parameters": {
    (key): {
      "id": string,
      "type": string,
      "$ref": string,
      "description": string,
      "default": string,
      "required": boolean,
      "format": string,
      "pattern": string,
      "minimum": string,
      "maximum": string,
      "enum": [
        string
      ],
      "enumDescriptions": [
        string
      ],
      "repeated": boolean,
      "location": string,
      "properties": {
        (key): (JsonSchema)
      },
      "additionalProperties": (JsonSchema),
      "items": (JsonSchema),
      "annotations": {
        "required": [
          string
        ]
      }
    }
  },
  "auth": {
    "oauth2": {
      "scopes": {
        (key): {
          "description": string
        }
      }
    }
  },
  "features": [
    string
  ],
  "schemas": {
    (key): {
      "id": string,
      "type": string,
      "$ref": string,
      "description": string,
      "default": string,
      "required": boolean,
      "deprecated": boolean,
      "format": string,
      "pattern": string,
      "minimum": string,
      "maximum": string,
      "enum": [
        string
      ],
      "enumDescriptions": [
        string
      ],
      "enumDeprecated": [
        boolean
      ],
      "repeated": boolean,
      "location": string,
      "properties": {
        (key): (JsonSchema)
      },
      "additionalProperties": (JsonSchema),
      "items": (JsonSchema),
      "annotations": {
        "required": [
          string
        ]
      }
    }
  },
  "methods": {
    (key): {
      "id": string,
      "path": string,
      "httpMethod": string,
      "description": string,
      "deprecated": boolean,
      "parameters": {
        (key): {
          "id": string,
          "type": string,
          "$ref": string,
          "description": string,
          "default": string,
          "required": boolean,
          "deprecated": boolean,
          "format": string,
          "pattern": string,
          "minimum": string,
          "maximum": string,
          "enum": [
            string
          ],
          "enumDescriptions": [
            string
          ],
          "enumDeprecated": [
            boolean
          ],
          "repeated": boolean,
          "location": string,
          "properties": {
            (key): (JsonSchema)
          },
          "additionalProperties": (JsonSchema),
          "items": (JsonSchema),
          "annotations": {
            "required": [
              string
            ]
          }
        }
      },
      "parameterOrder": [
        string
      ],
      "request": {
        "$ref": string
      },
      "response": {
        "$ref": string
      },
      "scopes": [
        (value)
      ],
      "supportsMediaDownload": boolean,
      "supportsMediaUpload": boolean,
      "mediaUpload": {
        "accept": [
          string
        ],
        "maxSize": string,
        "protocols": {
          "simple": {
            "multipart": true,
            "path": string
          },
          "resumable": {
            "multipart": true,
            "path": string
          }
        }
      },
      "supportsSubscription": boolean
    }
  },
  "resources": {
    (key): {
      "methods": {
        (key): {
          "id": string,
          "path": string,
          "httpMethod": string,
          "description": string,
          "deprecated": boolean,
          "parameters": {
            (key): {
              "id": string,
              "type": string,
              "$ref": string,
              "description": string,
              "default": string,
              "required": boolean,
              "deprecated": boolean,
              "format": string,
              "pattern": string,
              "minimum": string,
              "maximum": string,
              "enum": [
                string
              ],
              "enumDescriptions": [
                string
              ],
              "enumDeprecated": [
                boolean
              ],
              "repeated": boolean,
              "location": string,
              "properties": {
                (key): (JsonSchema)
              },
              "additionalProperties": (JsonSchema),
              "items": (JsonSchema),
              "annotations": {
                "required": [
                  string
                ]
              }
            }
          },
          "parameterOrder": [
            string
          ],
          "request": {
            "$ref": string
          },
          "response": {
            "$ref": string
          },
          "scopes": [
            (value)
          ],
          "supportsMediaDownload": boolean,
          "supportsMediaUpload": boolean,
          "mediaUpload": {
            "accept": [
              string
            ],
            "maxSize": string,
            "protocols": {
              "simple": {
                "multipart": true,
                "path": string
              },
              "resumable": {
                "multipart": true,
                "path": string
              }
            }
          },
          "supportsSubscription": boolean
        }
      },
      "deprecated": boolean,
      "resources": {
        (key): (RestResource)
      }
    }
  }
}

نام ملک	ارزش	توضیحات
kind	string	نوع این پاسخ. رشته ثابت discovery#restDescription .
discoveryVersion	string	نسخه API دیسکاوری مورد استفاده برای تولید این سند را مشخص کنید.
id	string	شناسه سند Discovery برای API. برای مثال، urlshortener:v1 .
name	string	نام API. برای مثال، urlshortener .
canonicalName	string	نام متعارف API. برای مثال، Url Shortener .
version	string	نسخه API. برای مثال، v1 .
revision	string	بازنگری API.
title	string	عنوان API. برای مثال، «API کوتاه‌کننده آدرس اینترنتی گوگل».
description	string	توضیحات این API.
icons	object	لینک‌هایی به آیکون‌های ۱۶x۱۶ و ۳۲x۳۲ که نشان‌دهنده‌ی API هستند.
icons. x16	string	آدرس اینترنتی (URL) آیکون ۱۶x۱۶.
icons. x32	string	آدرس اینترنتی (URL) آیکون ۳۲x۳۲.
documentationLink	string	پیوندی به مستندات قابل خواندن توسط انسان برای API.
labels[]	list	برچسب‌هایی برای وضعیت این API. مقادیر معتبر شامل limited_availability یا deprecated .
protocol	string	پروتکلی که در سند شرح داده شده است. برای مثال، REST.
rootUrl	string	آدرس اینترنتی ریشه‌ای که تمام سرویس‌های API تحت آن قرار دارند.
endpoints[]	list	فهرستی از اشیاء نقطه پایانی مبتنی بر مکان برای این API. هر شیء شامل URL نقطه پایانی، مکان، توضیحات و وضعیت منسوخ شدن است.
endpoints[]. endpointUrl	string	آدرس اینترنتی (URL) میزبان هدفِ نقطه پایانی.
endpoints[]. location	string	محل نقطه پایانی.
endpoints[]. description	string	رشته‌ای که میزبان تعیین‌شده توسط URL را توصیف می‌کند.
endpoints[]. deprecated	boolean	اینکه آیا این نقطه پایانی منسوخ شده است یا خیر.
parameters	object	پارامترهای مشترکی که در همه APIها اعمال می‌شوند.
parameters. (key)	nested object	شرح یک پارامتر واحد.
parameters.(key). id	string	شناسه منحصر به فرد برای این طرحواره.
parameters.(key). type	string	نوع مقدار برای این طرحواره. لیستی از مقادیر را می‌توانید در بخش "نوع" در طرحواره JSON پیدا کنید.
parameters.(key). $ref	string	ارجاعی به یک طرحواره دیگر. مقدار این ویژگی، شناسه یک طرحواره دیگر است.
parameters.(key). description	string	شرحی از این شیء.
parameters.(key). default	string	مقدار پیش‌فرض این ویژگی (در صورت وجود).
parameters.(key). required	boolean	اینکه آیا پارامتر مورد نیاز است یا خیر.
parameters.(key). format	string	یک عبارت منظم یا کلید اضافی که به محدود کردن مقدار کمک می‌کند. برای جزئیات بیشتر، به خلاصه نوع و قالب مراجعه کنید.
parameters.(key). pattern	string	عبارت منظمی که این پارامتر باید با آن مطابقت داشته باشد.
parameters.(key). minimum	string	حداقل مقدار این پارامتر.
parameters.(key). maximum	string	حداکثر مقدار این پارامتر.
parameters.(key). enum[]	list	مقادیری که این پارامتر می‌تواند بگیرد (اگر از نوع شمارشی باشد).
parameters.(key). enumDescriptions[]	list	توضیحات مربوط به enumها. هر موقعیت به مقدار مربوطه در آرایه enum نگاشت می‌شود.
parameters.(key). repeated	boolean	اینکه آیا این پارامتر ممکن است چندین بار ظاهر شود یا خیر.
parameters.(key). location	string	اینکه آیا این پارامتر در کوئری قرار می‌گیرد یا در مسیر درخواست‌های REST.
parameters.(key). properties	object	اگر این یک طرحواره برای یک شیء است، طرحواره مربوط به هر ویژگی این شیء را فهرست کنید.
parameters.(key).properties. (key)	nested object	یک ویژگی واحد از این شیء. مقدار، خود یک شیء JSON Schema است که این ویژگی را توصیف می‌کند.
parameters.(key). additionalProperties	nested object	اگر این یک طرحواره برای یک شیء باشد، این ویژگی، طرحواره‌ای برای هر ویژگی اضافی با کلیدهای پویا روی این شیء است.
parameters.(key). items	nested object	اگر این یک طرحواره برای یک آرایه باشد، این ویژگی، طرحواره‌ای برای هر عنصر در آرایه است.
parameters.(key). annotations	object	اطلاعات تکمیلی در مورد این ملک.
parameters.(key).annotations. required[]	list	فهرستی از متدهایی که در درخواست‌ها به این ویژگی نیاز دارند.
auth	object	اطلاعات احراز هویت.
auth. oauth2	object	اطلاعات احراز هویت OAuth 2.0.
auth.oauth2. scopes	object	دامنه‌های موجود OAuth 2.0.
auth.oauth2.scopes. (key)	object	مقدار دامنه.
auth.oauth2.scopes.(key). description	string	شرح دامنه.
features[]	list	فهرستی از ویژگی‌های پشتیبانی‌شده برای این API.
schemas	object	طرحواره‌های این API.
schemas. (key)	nested object	شرح طرحواره فردی.
schemas.(key). id	string	شناسه منحصر به فرد برای این طرحواره. مثال: URL
schemas.(key). type	string	نوع مقدار برای این طرحواره. لیستی از مقادیر را می‌توانید در بخش "نوع" در طرحواره JSON پیدا کنید .
schemas.(key). $ref	string	ارجاعی به یک طرحواره دیگر. مقدار این ویژگی، شناسه یک طرحواره دیگر است.
schemas.(key). description	string	شرحی از این شیء.
schemas.(key). default	string	مقدار پیش‌فرض این ویژگی (در صورت وجود).
schemas.(key). required	boolean	اینکه آیا پارامتر مورد نیاز است یا خیر.
schemas.(key). deprecated	boolean	اینکه آیا این طرحواره منسوخ شده است یا خیر.
schemas.(key). format	string	یک عبارت منظم یا کلید اضافی که به محدود کردن مقدار کمک می‌کند. برای جزئیات بیشتر، به خلاصه نوع و قالب مراجعه کنید.
schemas.(key). pattern	string	عبارت منظمی که این پارامتر باید با آن مطابقت داشته باشد.
schemas.(key). minimum	string	حداقل مقدار این پارامتر.
schemas.(key). maximum	string	حداکثر مقدار این پارامتر.
schemas.(key). enum[]	list	مقادیری که این پارامتر می‌تواند بگیرد (اگر از نوع شمارشی باشد).
schemas.(key). enumDescriptions[]	list	The descriptions for the enums. Each position maps to the corresponding value in the enum array.
schemas.(key). enumDeprecated[]	list	وضعیت منسوخ شدن enumها. هر موقعیت به مقدار مربوطه در آرایه enum نگاشت می‌شود.
schemas.(key). repeated	boolean	اینکه آیا این پارامتر ممکن است چندین بار ظاهر شود یا خیر.
schemas.(key). location	string	اینکه آیا این پارامتر در کوئری قرار می‌گیرد یا در مسیر درخواست‌های REST.
schemas.(key). properties	object	اگر این یک طرحواره برای یک شیء است، طرحواره مربوط به هر ویژگی این شیء را فهرست کنید.
schemas.(key).properties. (key)	nested object	یک ویژگی واحد از این شیء. مقدار، خود یک شیء JSON Schema است که این ویژگی را توصیف می‌کند.
schemas.(key). additionalProperties	nested object	اگر این یک طرحواره برای یک شیء باشد، این ویژگی، طرحواره‌ای برای هر ویژگی اضافی با کلیدهای پویا روی این شیء است.
schemas.(key). items	nested object	اگر این یک طرحواره برای یک آرایه باشد، این ویژگی، طرحواره‌ای برای هر عنصر در آرایه است.
schemas.(key). annotations	object	اطلاعات تکمیلی در مورد این ملک.
schemas.(key).annotations. required[]	list	فهرستی از متدهایی که در درخواست‌ها به این ویژگی نیاز دارند.
methods	object	متدهای سطح API برای این API.
methods. (key)	nested object	شرح روش فردی.
methods.(key). id	string	یک شناسه منحصر به فرد برای این متد. این ویژگی می‌تواند برای تطبیق متدها بین نسخه‌های مختلف Discovery استفاده شود.
methods.(key). description	string	شرح این روش.
methods.(key). deprecated	boolean	اینکه آیا این روش منسوخ شده است یا خیر.
methods.(key). parameters	object	جزئیات مربوط به تمام پارامترها در این روش.
methods.(key).parameters. (key)	nested object	جزئیات مربوط به یک پارامتر واحد در این روش.
methods.(key).parameters.(key). id	string	شناسه منحصر به فرد برای این طرحواره.
methods.(key).parameters.(key). type	string	نوع مقدار برای این طرحواره. لیستی از مقادیر را می‌توانید در بخش "نوع" در طرحواره JSON پیدا کنید .
methods.(key).parameters.(key). $ref	string	ارجاعی به یک طرحواره دیگر. مقدار این ویژگی، شناسه یک طرحواره دیگر است.
methods.(key).parameters.(key). description	string	شرحی از این شیء.
methods.(key).parameters.(key). default	string	مقدار پیش‌فرض این ویژگی (در صورت وجود).
methods.(key).parameters.(key). required	boolean	اینکه آیا پارامتر مورد نیاز است یا خیر.
methods.(key).parameters.(key). deprecated	boolean	اینکه آیا پارامتر منسوخ شده است یا خیر.
methods.(key).parameters.(key). format	string	یک عبارت منظم یا کلید اضافی که به محدود کردن مقدار کمک می‌کند. برای جزئیات بیشتر، به خلاصه نوع و قالب مراجعه کنید.
methods.(key).parameters.(key). pattern	string	عبارت منظمی که این پارامتر باید با آن مطابقت داشته باشد.
methods.(key).parameters.(key). minimum	string	حداقل مقدار این پارامتر.
methods.(key).parameters.(key). maximum	string	حداکثر مقدار این پارامتر.
methods.(key).parameters.(key). enum[]	list	مقادیری که این پارامتر می‌تواند بگیرد (اگر از نوع شمارشی باشد).
methods.(key).parameters.(key). enumDescriptions[]	list	توضیحات مربوط به enumها. هر موقعیت به مقدار مربوطه در آرایه enum نگاشت می‌شود.
methods.(key).parameters.(key). enumDeprecated[]	list	وضعیت منسوخ شدن enumها. هر موقعیت به مقدار مربوطه در آرایه enum نگاشت می‌شود.
methods.(key).parameters.(key). repeated	boolean	اینکه آیا این پارامتر ممکن است چندین بار ظاهر شود یا خیر.
methods.(key).parameters.(key). location	string	اینکه آیا این پارامتر در کوئری قرار می‌گیرد یا در مسیر درخواست‌های REST.
methods.(key).parameters.(key). properties	object	اگر این یک طرحواره برای یک شیء است، طرحواره مربوط به هر ویژگی این شیء را فهرست کنید.
methods.(key).parameters.(key).properties. (key)	nested object	یک ویژگی واحد از این شیء. مقدار، خود یک شیء JSON Schema است که این ویژگی را توصیف می‌کند.
methods.(key).parameters.(key). additionalProperties	nested object	اگر این یک طرحواره برای یک شیء باشد، این ویژگی، طرحواره‌ای برای هر ویژگی اضافی با کلیدهای پویا روی این شیء است.
methods.(key).parameters.(key). items	nested object	اگر این یک طرحواره برای یک آرایه باشد، این ویژگی، طرحواره‌ای برای هر عنصر در آرایه است.
methods.(key).parameters.(key). annotations	object	اطلاعات تکمیلی در مورد این ملک.
methods.(key).parameters.(key).annotations. required[]	list	فهرستی از روش‌هایی که این ویژگی در درخواست‌ها برای آنها مورد نیاز است.
methods.(key). parameterOrder[]	list	فهرست مرتب‌شده‌ای از پارامترهای مورد نیاز. این به عنوان راهنمایی برای کلاینت‌ها در مورد نحوه ساختاردهی امضاهای متدشان عمل می‌کند. آرایه به گونه‌ای مرتب شده است که مهم‌ترین پارامتر ابتدا ظاهر می‌شود.
methods.(key). scopes[]	list	دامنه‌های OAuth 2.0 قابل اجرا برای این روش.
methods.(key). supportsMediaDownload	boolean	آیا این روش از دانلود رسانه‌ها پشتیبانی می‌کند یا خیر.
methods.(key). supportsMediaUpload	boolean	آیا این روش از آپلود رسانه پشتیبانی می‌کند؟
methods.(key). mediaUpload	object	پارامترهای آپلود رسانه
methods.(key).mediaUpload. accept[]	list	محدوده‌های رسانه‌ای MIME برای آپلودهای رسانه‌ای قابل قبول در این روش.
methods.(key).mediaUpload. maxSize	string	حداکثر حجم آپلود رسانه، مانند "۱ مگابایت"، "۲ گیگابایت" یا "۳ ترابایت".
methods.(key). supportsSubscription	boolean	آیا این روش از اشتراک‌ها پشتیبانی می‌کند؟
baseUrl	string	[منسوخ شده] آدرس اینترنتی پایه برای درخواست‌های REST.
basePath	string	[منسوخ شده] مسیر پایه برای درخواست‌های REST.
servicePath	string	مسیر پایه برای همه درخواست‌های REST.
batchPath	string	مسیر درخواست‌های دسته‌ای REST.
methods.(key). path	string	مسیر URI این متد REST. باید همراه با ویژگی servicePath در سطح API استفاده شود.
methods.(key). httpMethod	string	روش HTTP که توسط این روش استفاده می‌شود.
methods.(key). request	object	طرحواره (Schema) برای درخواست.
methods.(key).request. $ref	string	شناسه طرحواره برای طرحواره درخواست.
methods.(key).request. parameterName	string	[منسوخ شده] برخی از APIها این فیلد را به دلایل سازگاری با نسخه‌های قبلی دارند. می‌توان با خیال راحت آن را نادیده گرفت.
methods.(key). response	object	طرحواره برای پاسخ.
methods.(key).response. $ref	string	شناسه طرحواره برای طرحواره پاسخ.
methods.(key).mediaUpload. protocols	object	پروتکل‌های آپلود پشتیبانی‌شده
methods.(key).mediaUpload.protocols. simple	object	از آپلود به عنوان یک درخواست HTTP واحد پشتیبانی می‌کند.
methods.(key).mediaUpload.protocols.simple. multipart	boolean	اگر این نقطه پایانی از آپلود رسانه‌های چندبخشی پشتیبانی کند، صحیح است.
methods.(key).mediaUpload.protocols.simple. path	string	مسیر URI که برای آپلود استفاده می‌شود. باید همراه با ویژگی rootURL در سطح API استفاده شود.
methods.(key).mediaUpload.protocols. resumable	object	از پروتکل Resumable Media Upload پشتیبانی می‌کند.
methods.(key).mediaUpload.protocols.resumable. multipart	boolean	اگر این نقطه پایانی از آپلود رسانه‌های چندبخشی پشتیبانی کند، true .
methods.(key).mediaUpload.protocols.resumable. path	string	The URI path to be used for upload. Should be used in conjunction with the rootURL property at the API-level.
resources	object	منابع موجود در این API.
resources. (key)	nested object	شرح یک منبع منحصر به فرد. شامل روش‌ها و زیرمنابع مرتبط با این منبع.
resources.(key). methods	object	روش‌های موجود در این منبع.
resources.(key).methods. (key)	nested object	توضیحات مربوط به هر روش در این منبع.
resources.(key).methods.(key). id	string	یک شناسه منحصر به فرد برای این متد. این ویژگی می‌تواند برای تطبیق متدها بین نسخه‌های مختلف Discovery استفاده شود.
resources.(key).methods.(key). path	string	مسیر URI این متد REST. باید همراه با ویژگی servicePath در سطح API استفاده شود.
resources.(key).methods.(key). flatPath	string	مسیر URI این متد REST در قالب (RFC 6570) بدون ویژگی‌های سطح ۲ ({+var}). مکمل ویژگی path .
resources.(key).methods.(key). httpMethod	string	روش HTTP که توسط این روش استفاده می‌شود.
resources.(key).methods.(key). description	string	شرح این روش.
resources.(key).methods.(key). deprecated	boolean	اینکه آیا این روش منسوخ شده است یا خیر.
resources.(key).methods.(key). parameters	object	جزئیات مربوط به تمام پارامترها در این روش.
resources.(key).methods.(key).parameters. (key)	nested object	جزئیات مربوط به یک پارامتر واحد در این روش.
resources.(key).methods.(key).parameters.(key). id	string	شناسه منحصر به فرد برای این طرحواره.
resources.(key).methods.(key).parameters.(key). type	string	نوع مقدار برای این طرحواره. لیستی از مقادیر را می‌توانید در بخش "نوع" در طرحواره JSON پیدا کنید .
resources.(key).methods.(key).parameters.(key). $ref	string	ارجاع به یک طرحواره دیگر. مقدار این ویژگی "ID" یک طرحواره دیگر است.
resources.(key).methods.(key).parameters.(key). description	string	شرحی از این شیء.
resources.(key).methods.(key).parameters.(key). default	string	مقدار پیش‌فرض این ویژگی (در صورت وجود).
resources.(key).methods.(key).parameters.(key). required	boolean	اینکه آیا پارامتر مورد نیاز است یا خیر.
resources.(key).methods.(key).parameters.(key). deprecated	boolean	اینکه آیا پارامتر منسوخ شده است یا خیر.
resources.(key).methods.(key).parameters.(key). format	string	یک عبارت منظم یا کلید اضافی که به محدود کردن مقدار کمک می‌کند. برای جزئیات بیشتر، به خلاصه نوع و قالب مراجعه کنید.
resources.(key).methods.(key).parameters.(key). pattern	string	عبارت منظمی که این پارامتر باید با آن مطابقت داشته باشد.
resources.(key).methods.(key).parameters.(key). minimum	string	حداقل مقدار این پارامتر.
resources.(key).methods.(key).parameters.(key). maximum	string	حداکثر مقدار این پارامتر.
resources.(key).methods.(key).parameters.(key). enum[]	list	مقادیری که این پارامتر می‌تواند بگیرد (اگر از نوع شمارشی باشد).
resources.(key).methods.(key).parameters.(key). enumDescriptions[]	list	توضیحات مربوط به enumها. هر موقعیت به مقدار مربوطه در آرایه enum نگاشت می‌شود.
resources.(key).methods.(key).parameters.(key). enumDeprecated[]	list	وضعیت منسوخ شدن enumها. هر موقعیت به مقدار مربوطه در آرایه enum نگاشت می‌شود.
resources.(key).methods.(key).parameters.(key). repeated	boolean	اینکه آیا این پارامتر ممکن است چندین بار ظاهر شود یا خیر.
resources.(key).methods.(key).parameters.(key). location	string	اینکه آیا این پارامتر در کوئری قرار می‌گیرد یا در مسیر درخواست‌های REST.
resources.(key).methods.(key).parameters.(key). properties	object	اگر این یک طرحواره برای یک شیء است، طرحواره مربوط به هر ویژگی این شیء را فهرست کنید.
resources.(key).methods.(key).parameters.(key).properties. (key)	nested object	یک ویژگی واحد از این شیء. مقدار، خود یک شیء JSON Schema است که این ویژگی را توصیف می‌کند.
resources.(key).methods.(key).parameters.(key). additionalProperties	nested object	اگر این یک طرحواره برای یک شیء باشد، این ویژگی، طرحواره‌ای برای هر ویژگی اضافی با کلیدهای پویا روی این شیء است.
resources.(key).methods.(key).parameters.(key). items	nested object	اگر این یک طرحواره برای یک آرایه باشد، این ویژگی، طرحواره‌ای برای هر عنصر در آرایه است.
resources.(key).methods.(key).parameters.(key). annotations	object	اطلاعات تکمیلی در مورد این ملک.
resources.(key).methods.(key).parameters.(key).annotations. required[]	list	فهرستی از متدهایی که در درخواست‌ها به این ویژگی نیاز دارند.
resources.(key).methods.(key). parameterOrder[]	list	فهرست مرتب‌شده‌ای از پارامترهای مورد نیاز. این به عنوان راهنمایی برای کلاینت‌ها در مورد نحوه ساختاردهی امضاهای متدشان عمل می‌کند. آرایه به گونه‌ای مرتب شده است که مهم‌ترین پارامتر ابتدا ظاهر می‌شود.
resources.(key).methods.(key). request	object	طرحواره (Schema) برای درخواست.
resources.(key).methods.(key).request. $ref	string	شناسه طرحواره برای طرحواره درخواست.
resources.(key).methods.(key). response	object	طرحواره برای پاسخ.
resources.(key).methods.(key).response. $ref	string	شناسه طرحواره برای طرحواره پاسخ.
resources.(key).methods.(key). scopes[]	list	دامنه‌های OAuth 2.0 قابل اجرا برای این روش.
resources.(key).methods.(key). supportsMediaDownload	boolean	آیا این روش از دانلود رسانه‌ها پشتیبانی می‌کند یا خیر.
resources.(key).methods.(key). supportsMediaUpload	boolean	آیا این روش از آپلود رسانه پشتیبانی می‌کند؟
resources.(key).methods.(key). mediaUpload	object	پارامترهای آپلود رسانه
resources.(key).methods.(key).mediaUpload. accept[]	list	محدوده‌های رسانه‌ای MIME برای آپلودهای رسانه‌ای قابل قبول در این روش.
resources.(key).methods.(key).mediaUpload. maxSize	string	حداکثر حجم آپلود رسانه، مانند "۱ مگابایت"، "۲ گیگابایت" یا "۳ ترابایت".
resources.(key).methods.(key).mediaUpload. protocols	object	پروتکل‌های آپلود پشتیبانی‌شده
resources.(key).methods.(key).mediaUpload.protocols. simple	object	از آپلود به عنوان یک درخواست HTTP واحد پشتیبانی می‌کند.
resources.(key).methods.(key).mediaUpload.protocols.simple. multipart	boolean	اگر این نقطه پایانی از آپلود رسانه‌های چندبخشی پشتیبانی کند، true .
resources.(key).methods.(key).mediaUpload.protocols.simple. path	string	مسیر URI که برای آپلود استفاده می‌شود. باید همراه با ویژگی rootURL در سطح API استفاده شود.
resources.(key).methods.(key).mediaUpload.protocols. resumable	object	از پروتکل Resumable Media Upload پشتیبانی می‌کند.
resources.(key).methods.(key).mediaUpload.protocols.resumable. multipart	boolean	اگر این نقطه پایانی از آپلود رسانه‌های چندبخشی پشتیبانی کند، true .
resources.(key).methods.(key).mediaUpload.protocols.resumable. path	string	The URI path to be used for upload. Should be used in conjunction with the rootURL property at the API-level.
resources.(key).methods.(key). supportsSubscription	boolean	آیا این روش از اشتراک‌ها پشتیبانی می‌کند؟
resources.(key). deprecated	boolean	اینکه آیا این منبع منسوخ شده است یا خیر.
resources.(key). resources	object	منابع فرعی روی این منبع.
resources.(key).resources. (key)	nested object	توضیحات مربوط به هرگونه زیرمنبع در این منبع.