เอกสารการค้นพบ

เอกสารการค้นพบพร้อมใช้งานสําหรับ API เวอร์ชันที่เฉพาะเจาะจงบางรายการ เอกสารการค้นพบของ API' แต่ละรายการจะแสดงแพลตฟอร์มของ API, วิธีเข้าถึง API และวิธีจัดโครงสร้างคําขอ API และการตอบกลับ ข้อมูลที่ระบุโดยเอกสารการค้นพบประกอบด้วยพร็อพเพอร์ตี้ระดับ API เช่น คําอธิบาย API, สคีมาของทรัพยากร, ขอบเขตการตรวจสอบสิทธิ์ และวิธีการ

เมธอด

เอกสารการค้นพบจะเน้นที่เมธอดบรรยากาศผ่อนคลายในการเรียกใช้ API เมธอด discovery.apis.list จะแสดงรายการ API ทั้งหมดที่รองรับโดยบริการ Google APIs Discovery ซึ่งรองรับ URL สําหรับเรียกเอกสารการค้นพบที่ใช้ REST

list
รับรายการ 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",
  "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,
      "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
        ]
      }
    }
  },
  "methods": {
    (key): {
      "id": string,
      "path": string,
      "httpMethod": string,
      "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
            ]
          }
        }
      },
      "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,
          "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
                ]
              }
            }
          },
          "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): (RestResource)
      }
    }
  }
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
kind string ประเภทการตอบกลับนี้สตริงคงที่ discovery#restDescription
discoveryVersion string ระบุเวอร์ชันของ Discovery API ที่ใช้สร้างเอกสารนี้
id string รหัสของเอกสาร Discovery สําหรับ API เช่น urlshortener:v1
name string ชื่อของ API เช่น urlshortener
canonicalName string ชื่อ Canonical ของ API เช่น Url Shortener
version string เวอร์ชันของ API เช่น v1
revision string การแก้ไข API
title string ชื่อของ API เช่น "Google Url Shortener API"
description string คําอธิบายของ API นี้
icons object ลิงก์ไปยังไอคอนขนาด 16x16 และ 32x32 ที่แสดงแทน API
icons.x16 string URL ของไอคอนขนาด 16x16
icons.x32 string URL ของไอคอนขนาด 32x32
labels[] list ป้ายกํากับสําหรับสถานะของ API นี้ ค่าที่ใช้ได้ ได้แก่ limited_availability หรือ deprecated
protocol string โปรโตคอลที่เอกสารอธิบาย ตัวอย่างเช่น REST
rootUrl string URL รูทที่บริการ API ทั้งหมดทํางานอยู่
parameters object พารามิเตอร์ทั่วไปที่ใช้กับ API ทั้งหมด
parameters.(key) nested object คําอธิบายพารามิเตอร์เดียว
parameters.(key).id string ตัวระบุที่ไม่ซ้ํากันสําหรับสคีมานี้
parameters.(key).type string ประเภทค่าสําหรับสคีมานี้ คุณดูรายการค่าได้ที่ส่วน"type" ในสคีมา 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 ค่าที่พารามิเตอร์นี้อาจใช้ (หากเป็น enum)
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 ที่อธิบายพร็อพเพอร์ตี้นี้
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 ประเภทค่าสําหรับสคีมานี้ คุณสามารถดูรายการค่าได้ในส่วน"type" ในสคีมา JSON
schemas.(key).$ref string การอ้างอิงไปยังสคีมาอื่น ค่าของพร็อพเพอร์ตี้นี้คือรหัสของสคีมาอื่น
schemas.(key).description string คําอธิบายของออบเจ็กต์นี้
schemas.(key).default string ค่าเริ่มต้นของพร็อพเพอร์ตี้นี้ (หากมี)
schemas.(key).required boolean กําหนดว่าต้องมีพารามิเตอร์หรือไม่
schemas.(key).format string นิพจน์ทั่วไปหรือคีย์เพิ่มเติมที่จะช่วยจํากัดค่าโปรดดูรายละเอียดเพิ่มเติมที่สรุปประเภทและรูปแบบ
schemas.(key).pattern string นิพจน์ทั่วไปที่พารามิเตอร์นี้ต้องสอดคล้อง
schemas.(key).minimum string ค่าต่ําสุดของพารามิเตอร์นี้
schemas.(key).maximum string ค่าสูงสุดของพารามิเตอร์นี้
schemas.(key).enum[] list ค่าที่พารามิเตอร์นี้อาจใช้ (หากเป็น enum)
schemas.(key).enumDescriptions[] list คําอธิบายของ Enum แต่ละตําแหน่งจะแมปกับค่าที่สอดคล้องกันในอาร์เรย์ enum
schemas.(key).repeated boolean พารามิเตอร์นี้อาจปรากฏหลายครั้งหรือไม่
schemas.(key).location string พารามิเตอร์นี้ใช้ในการค้นหาหรือเส้นทางสําหรับคําขอ REST
schemas.(key).properties object หากนี่เป็นสคีมาของออบเจ็กต์ ให้ระบุสคีมาสําหรับพร็อพเพอร์ตี้แต่ละรายการของออบเจ็กต์นี้
schemas.(key).properties.(key) nested object พร็อพเพอร์ตี้เดียวของออบเจ็กต์นี้ ค่านี้คือออบเจ็กต์สคีมา JSON ที่อธิบายพร็อพเพอร์ตี้นี้
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).parameters object รายละเอียดของพารามิเตอร์ทั้งหมดในเมธอดนี้
methods.(key).parameters.(key) nested object รายละเอียดสําหรับพารามิเตอร์เดียวในวิธีนี้
methods.(key).parameters.(key).id string ตัวระบุที่ไม่ซ้ํากันสําหรับสคีมานี้
methods.(key).parameters.(key).type string ประเภทค่าสําหรับสคีมานี้ คุณสามารถดูรายการค่าได้ที่ส่วน "type" ในสคีมา 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).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 ค่าที่พารามิเตอร์นี้อาจใช้ (หากเป็น enum)
methods.(key).parameters.(key).enumDescriptions[] 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 ที่อธิบายพร็อพเพอร์ตี้นี้
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 ขนาดสูงสุดของการอัปโหลดสื่อ เช่น "1MB", "2GB" หรือ "3TB"
methods.(key).supportsSubscription boolean วิธีนี้รองรับการสมัครใช้บริการหรือไม่
baseUrl string [เลิกใช้งานแล้ว] URL ฐานสําหรับคําขอ 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 สคีมาสําหรับคําขอ
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 รองรับโปรโตคอลการอัปโหลดสื่อที่ดําเนินการต่อได้
methods.(key).mediaUpload.protocols.resumable.multipart boolean true หากปลายทางนี้รองรับการอัปโหลดสื่อหลายส่วน
methods.(key).mediaUpload.protocols.resumable.path string เส้นทาง URI ที่จะใช้ในการอัปโหลด ควรใช้ร่วมกับพร็อพเพอร์ตี้ rootURL ที่ระดับ API
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) โดยไม่มีฟีเจอร์ระดับ 2 ({+var}) ส่วนเสริมสําหรับพร็อพเพอร์ตี้ path
resources.(key).methods.(key).httpMethod string เมธอด HTTP ที่เมธอดนี้ใช้
resources.(key).methods.(key).description string คําอธิบายของวิธีการนี้
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 ประเภทค่าสําหรับสคีมานี้ คุณสามารถดูรายการค่าได้ที่ส่วน "type" ในสคีมา 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).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 ค่าที่พารามิเตอร์นี้อาจใช้ (หากเป็น enum)
resources.(key).methods.(key).parameters.(key).enumDescriptions[] 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 ที่อธิบายพร็อพเพอร์ตี้นี้
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 สคีมาสําหรับคําขอ
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 ขนาดสูงสุดของการอัปโหลดสื่อ เช่น "1MB", "2GB" หรือ "3TB"
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 รองรับโปรโตคอลการอัปโหลดสื่อที่ดําเนินการต่อได้
resources.(key).methods.(key).mediaUpload.protocols.resumable.multipart boolean true หากปลายทางนี้รองรับการอัปโหลดสื่อหลายส่วน
resources.(key).methods.(key).mediaUpload.protocols.resumable.path string เส้นทาง URI ที่จะใช้ในการอัปโหลด ควรใช้ร่วมกับพร็อพเพอร์ตี้ rootURL ที่ระดับ API
resources.(key).methods.(key).supportsSubscription boolean วิธีนี้รองรับการสมัครใช้บริการหรือไม่
resources.(key).resources object ทรัพยากรย่อยในทรัพยากรนี้
resources.(key).resources.(key) nested object คําอธิบายของทรัพยากรย่อยในทรัพยากรนี้