วิธีการ
เอกสารการค้นพบจะเน้นที่เมธอด RESTful ในการเรียกใช้ API เมธอด discovery.apis.list จะแสดงรายการ API ทั้งหมดที่รองรับโดย Google APIs Discovery Service รวมถึง 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", "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 ของ Discovery ที่ใช้เพื่อสร้างเอกสารนี้ | |
id |
string |
รหัสของเอกสารการค้นพบสําหรับ API เช่น urlshortener:v1 |
|
name |
string |
ชื่อของ API เช่น urlshortener |
|
canonicalName |
string |
Canonical Name ของ 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 | |
documentationLink |
string |
ลิงก์ไปยังเอกสารประกอบที่มนุษย์อ่านได้สําหรับ API | |
labels[] |
list |
ป้ายกํากับสําหรับสถานะของ API นี้ ค่าที่ถูกต้องรวมถึง limited_availability หรือ deprecated |
|
protocol |
string |
โปรโตคอลที่อธิบายในเอกสาร เช่น REST | |
rootUrl |
string |
URL ระดับรากที่บริการ 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 |
ค่าที่พารามิเตอร์นี้อาจใช้ (หากเป็น 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 |
ประเภทค่าสําหรับสคีมานี้ คุณสามารถดูรายการค่าได้ที่ ส่วน"ประเภท" ในสคีมา 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 |
ค่าที่พารามิเตอร์นี้อาจใช้ (หากเป็น enum) | |
schemas.(key).enumDescriptions[] |
list |
คําอธิบายสําหรับ Enum แต่ละตําแหน่งจะแมปกับค่าที่สอดคล้องกันในอาร์เรย์ enum |
|
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 ที่อธิบายพร็อพเพอร์ตี้นี้ | |
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 |
ค่าที่พารามิเตอร์นี้อาจใช้ (หากเป็น enum) | |
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 ที่อธิบายพร็อพเพอร์ตี้นี้ | |
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).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 |
การอ้างอิงไปยังสคีมาอื่น ค่าของพร็อพเพอร์ตี้นี้คือ "รหัส" ของสคีมาอื่น | |
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 |
ค่าที่พารามิเตอร์นี้อาจใช้ (หากเป็น enum) | |
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 ที่อธิบายพร็อพเพอร์ตี้นี้ | |
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).deprecated |
boolean |
ทรัพยากรนี้เลิกใช้งานแล้วหรือไม่ | |
resources.(key).resources |
object |
ทรัพยากรย่อยของทรัพยากรนี้ | |
resources.(key).resources.(key) |
nested object |
คําอธิบายสําหรับทรัพยากรย่อยในทรัพยากรนี้ |