เมธอด
เอกสารการค้นหามุ่งเน้นที่วิธีการเรียกใช้ API แบบ RESTful เมธอด discovery.apis.list จะแสดงรายการ API ทั้งหมดที่บริการค้นหา Google APIs รองรับ รวมถึง 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 |
ระบุเวอร์ชันของ Discovery API ที่ใช้สร้างเอกสารนี้ |
id |
string |
รหัสของเอกสารการค้นหาสำหรับ API เช่น
urlshortener:v1
|
name |
string |
ชื่อของ API เช่น urlshortener |
canonicalName |
string |
ชื่อมาตรฐานของ API เช่น Url
Shortener
|
version |
string |
เวอร์ชันของ API เช่น v1 |
revision |
string |
การแก้ไข API |
title |
string |
ชื่อของ API เช่น "API ของ Google Url Shortener" |
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 |
ประเภทค่าสำหรับสคีมานี้ ดูรายการค่าได้ที่ส่วน "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).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 |
ประเภทค่าสำหรับสคีมานี้ ดูรายการค่าได้ที่ ส่วน "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).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 |
ประเภทค่าสำหรับสคีมานี้ ดูรายการค่าได้ที่ ส่วน "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).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 |
คำอธิบายสำหรับทรัพยากรย่อยในทรัพยากรนี้ |