Phương thức
Tài liệu Khám phá tập trung vào phương thức RESTful để gọi một API. Phương thức discovery.apis.list trả về danh sách tất cả các API mà Dịch vụ Khám phá API của Google hỗ trợ, bao gồm cả URL để truy xuất tài liệu khám phá dựa trên REST.
- list
- Truy xuất danh sách các API được hỗ trợ tại điểm cuối này.
Biểu diễn tài nguyên
{
"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)
}
}
}
}| Tên thuộc tính | Giá trị | Mô tả |
|---|---|---|
kind |
string |
Loại phản hồi này. Chuỗi cố định discovery#restDescription.
|
discoveryVersion |
string |
Cho biết phiên bản của Discovery API được dùng để tạo tài liệu này. |
id |
string |
Mã nhận dạng của Tài liệu khám phá cho API. Ví dụ: urlshortener:v1.
|
name |
string |
Tên của API. Ví dụ: urlshortener. |
canonicalName |
string |
Tên chuẩn hoá của API. Ví dụ: Url
Shortener.
|
version |
string |
Phiên bản của API. Ví dụ: v1. |
revision |
string |
Bản sửa đổi của API. |
title |
string |
Tiêu đề của API. Ví dụ: "Google Url Shortener API" (API rút ngắn URL của Google). |
description |
string |
Nội dung mô tả về API này. |
icons |
object |
Đường liên kết đến các biểu tượng 16x16 và 32x32 đại diện cho API. |
icons.x16 |
string |
URL của biểu tượng 16x16. |
icons.x32 |
string |
URL của biểu tượng 32x32. |
documentationLink |
string |
Đường liên kết đến tài liệu mà con người có thể đọc được cho API. |
labels[] |
list |
Nhãn cho trạng thái của API này. Các giá trị hợp lệ bao gồm limited_availability hoặc deprecated.
|
protocol |
string |
Giao thức được mô tả trong tài liệu. Ví dụ: REST. |
rootUrl |
string |
URL gốc mà tất cả các dịch vụ API đều nằm trong đó. |
endpoints[] |
list |
Danh sách các đối tượng điểm cuối dựa trên vị trí cho API này. Mỗi đối tượng chứa URL điểm cuối, vị trí, nội dung mô tả và trạng thái ngừng hoạt động. |
endpoints[].endpointUrl |
string |
URL của máy chủ lưu trữ đích của điểm cuối. |
endpoints[].location |
string |
Vị trí của điểm cuối. |
endpoints[].description |
string |
Một chuỗi mô tả máy chủ do URL chỉ định. |
endpoints[].deprecated |
boolean |
Điểm cuối này có không còn được dùng nữa hay không. |
parameters |
object |
Các thông số chung áp dụng cho tất cả các API. |
parameters.(key) |
nested object |
Nội dung mô tả về một tham số duy nhất. |
parameters.(key).id |
string |
Giá trị nhận dạng duy nhất cho giản đồ này. |
parameters.(key).type |
string |
Loại giá trị cho giản đồ này. Bạn có thể xem danh sách các giá trị tại mục"type" trong Giản đồ JSON. |
parameters.(key).$ref |
string |
Tham chiếu đến một giản đồ khác. Giá trị của thuộc tính này là mã nhận dạng của một lược đồ khác. |
parameters.(key).description |
string |
Nội dung mô tả về đối tượng này. |
parameters.(key).default |
string |
Giá trị mặc định của thuộc tính này (nếu có). |
parameters.(key).required |
boolean |
Tham số có bắt buộc hay không. |
parameters.(key).format |
string |
Một biểu thức chính quy hoặc khoá bổ sung giúp hạn chế giá trị. Để biết thêm thông tin chi tiết, hãy xem bảng tóm tắt loại và định dạng. |
parameters.(key).pattern |
string |
Biểu thức chính quy mà tham số này phải tuân thủ. |
parameters.(key).minimum |
string |
Giá trị tối thiểu của tham số này. |
parameters.(key).maximum |
string |
Giá trị tối đa của tham số này. |
parameters.(key).enum[] |
list |
Các giá trị mà tham số này có thể nhận (nếu là một enum). |
parameters.(key).enumDescriptions[] |
list |
Nội dung mô tả cho các enum. Mỗi vị trí tương ứng với giá trị tương ứng trong mảng enum. |
parameters.(key).repeated |
boolean |
Tham số này có thể xuất hiện nhiều lần hay không. |
parameters.(key).location |
string |
Tham số này nằm trong truy vấn hay đường dẫn cho các yêu cầu REST. |
parameters.(key).properties |
object |
Nếu đây là một giản đồ cho một đối tượng, hãy liệt kê giản đồ cho từng thuộc tính của đối tượng này. |
parameters.(key).properties.(key) |
nested object |
Một thuộc tính duy nhất của đối tượng này. Giá trị này là một đối tượng JSON Schema mô tả thuộc tính này. |
parameters.(key).additionalProperties |
nested object |
Nếu đây là một giản đồ cho một đối tượng, thì thuộc tính này là giản đồ cho mọi thuộc tính bổ sung có khoá động trên đối tượng này. |
parameters.(key).items |
nested object |
Nếu đây là một giản đồ cho một mảng, thì thuộc tính này là giản đồ cho từng phần tử trong mảng. |
parameters.(key).annotations |
object |
Thông tin bổ sung về tài sản này. |
parameters.(key).annotations.required[] |
list |
Danh sách các phương thức yêu cầu thuộc tính này trong các yêu cầu. |
auth |
object |
Thông tin xác thực. |
auth.oauth2 |
object |
Thông tin xác thực OAuth 2.0. |
auth.oauth2.scopes |
object |
Các phạm vi OAuth 2.0 hiện có. |
auth.oauth2.scopes.(key) |
object |
Giá trị phạm vi. |
auth.oauth2.scopes.(key).description |
string |
Nội dung mô tả về phạm vi. |
features[] |
list |
Danh sách các tính năng được hỗ trợ cho API này. |
schemas |
object |
Các giản đồ cho API này. |
schemas.(key) |
nested object |
Mô tả giản đồ riêng lẻ. |
schemas.(key).id |
string |
Giá trị nhận dạng duy nhất cho giản đồ này. Ví dụ: URL |
schemas.(key).type |
string |
Loại giá trị cho giản đồ này. Bạn có thể xem danh sách các giá trị tại phần "type" (loại) trong Giản đồ JSON. |
schemas.(key).$ref |
string |
Tham chiếu đến một giản đồ khác. Giá trị của thuộc tính này là mã nhận dạng của một lược đồ khác. |
schemas.(key).description |
string |
Nội dung mô tả về đối tượng này. |
schemas.(key).default |
string |
Giá trị mặc định của thuộc tính này (nếu có). |
schemas.(key).required |
boolean |
Tham số có bắt buộc hay không. |
schemas.(key).deprecated |
boolean |
Lược đồ này có không được dùng nữa hay không. |
schemas.(key).format |
string |
Một biểu thức chính quy hoặc khoá bổ sung giúp hạn chế giá trị. Để biết thêm thông tin chi tiết, hãy xem bảng tóm tắt loại và định dạng. |
schemas.(key).pattern |
string |
Biểu thức chính quy mà tham số này phải tuân thủ. |
schemas.(key).minimum |
string |
Giá trị tối thiểu của tham số này. |
schemas.(key).maximum |
string |
Giá trị tối đa của tham số này. |
schemas.(key).enum[] |
list |
Các giá trị mà tham số này có thể nhận (nếu là một enum). |
schemas.(key).enumDescriptions[] |
list |
Nội dung mô tả cho các enum. Mỗi vị trí liên kết với giá trị tương ứng trong mảng enum.
|
schemas.(key).enumDeprecated[] |
list |
Trạng thái ngừng sử dụng của các kiểu dữ liệu liệt kê. Mỗi vị trí liên kết với giá trị tương ứng trong mảng enum.
|
schemas.(key).repeated |
boolean |
Tham số này có thể xuất hiện nhiều lần hay không. |
schemas.(key).location |
string |
Tham số này nằm trong truy vấn hay đường dẫn cho các yêu cầu REST. |
schemas.(key).properties |
object |
Nếu đây là một giản đồ cho một đối tượng, hãy liệt kê giản đồ cho từng thuộc tính của đối tượng này. |
schemas.(key).properties.(key) |
nested object |
Một thuộc tính duy nhất của đối tượng này. Giá trị này là một đối tượng JSON Schema mô tả thuộc tính này. |
schemas.(key).additionalProperties |
nested object |
Nếu đây là một giản đồ cho một đối tượng, thì thuộc tính này là giản đồ cho mọi thuộc tính bổ sung có khoá động trên đối tượng này. |
schemas.(key).items |
nested object |
Nếu đây là một giản đồ cho một mảng, thì thuộc tính này là giản đồ cho từng phần tử trong mảng. |
schemas.(key).annotations |
object |
Thông tin bổ sung về tài sản này. |
schemas.(key).annotations.required[] |
list |
Danh sách các phương thức yêu cầu thuộc tính này trong các yêu cầu. |
methods |
object |
Các phương thức cấp độ API cho API này. |
methods.(key) |
nested object |
Nội dung mô tả về từng phương thức. |
methods.(key).id |
string |
Mã nhận dạng duy nhất cho phương thức này. Bạn có thể dùng thuộc tính này để so khớp các phương thức giữa các phiên bản Khám phá. |
methods.(key).description |
string |
Nội dung mô tả về phương thức này. |
methods.(key).deprecated |
boolean |
Phương thức này có không được dùng nữa hay không. |
methods.(key).parameters |
object |
Thông tin chi tiết về tất cả các tham số trong phương thức này. |
methods.(key).parameters.(key) |
nested object |
Thông tin chi tiết về một tham số trong phương thức này. |
methods.(key).parameters.(key).id |
string |
Giá trị nhận dạng duy nhất cho giản đồ này. |
methods.(key).parameters.(key).type |
string |
Loại giá trị cho giản đồ này. Bạn có thể xem danh sách các giá trị tại phần "type" (loại) trong Giản đồ JSON. |
methods.(key).parameters.(key).$ref |
string |
Tham chiếu đến một giản đồ khác. Giá trị của thuộc tính này là mã nhận dạng của một lược đồ khác. |
methods.(key).parameters.(key).description |
string |
Nội dung mô tả về đối tượng này. |
methods.(key).parameters.(key).default |
string |
Giá trị mặc định của thuộc tính này (nếu có). |
methods.(key).parameters.(key).required |
boolean |
Tham số có bắt buộc hay không. |
methods.(key).parameters.(key).deprecated |
boolean |
Tham số này có bị ngừng sử dụng hay không. |
methods.(key).parameters.(key).format |
string |
Một biểu thức chính quy hoặc khoá bổ sung giúp hạn chế giá trị. Để biết thêm thông tin chi tiết, hãy xem bảng tóm tắt loại và định dạng. |
methods.(key).parameters.(key).pattern |
string |
Biểu thức chính quy mà tham số này phải tuân thủ. |
methods.(key).parameters.(key).minimum |
string |
Giá trị tối thiểu của tham số này. |
methods.(key).parameters.(key).maximum |
string |
Giá trị tối đa của tham số này. |
methods.(key).parameters.(key).enum[] |
list |
Các giá trị mà tham số này có thể nhận (nếu là một enum). |
methods.(key).parameters.(key).enumDescriptions[] |
list |
Nội dung mô tả cho các enum. Mỗi vị trí liên kết với giá trị tương ứng trong mảng enum.
|
methods.(key).parameters.(key).enumDeprecated[] |
list |
Trạng thái ngừng sử dụng của các kiểu dữ liệu liệt kê. Mỗi vị trí liên kết với giá trị tương ứng trong mảng enum.
|
methods.(key).parameters.(key).repeated |
boolean |
Tham số này có thể xuất hiện nhiều lần hay không. |
methods.(key).parameters.(key).location |
string |
Tham số này nằm trong truy vấn hay đường dẫn cho các yêu cầu REST. |
methods.(key).parameters.(key).properties |
object |
Nếu đây là một giản đồ cho một đối tượng, hãy liệt kê giản đồ cho từng thuộc tính của đối tượng này. |
methods.(key).parameters.(key).properties.(key) |
nested object |
Một thuộc tính duy nhất của đối tượng này. Giá trị này là một đối tượng JSON Schema mô tả thuộc tính này. |
methods.(key).parameters.(key).additionalProperties |
nested object |
Nếu đây là một giản đồ cho một đối tượng, thì thuộc tính này là giản đồ cho mọi thuộc tính bổ sung có khoá động trên đối tượng này. |
methods.(key).parameters.(key).items |
nested object |
Nếu đây là một giản đồ cho một mảng, thì thuộc tính này là giản đồ cho từng phần tử trong mảng. |
methods.(key).parameters.(key).annotations |
object |
Thông tin bổ sung về tài sản này. |
methods.(key).parameters.(key).annotations.required[] |
list |
Danh sách các phương thức mà thuộc tính này là bắt buộc đối với các yêu cầu. |
methods.(key).parameterOrder[] |
list |
Danh sách có thứ tự các tham số bắt buộc. Đây là gợi ý cho các ứng dụng về cách cấu trúc chữ ký phương thức. Mảng được sắp xếp sao cho tham số quan trọng nhất xuất hiện đầu tiên. |
methods.(key).scopes[] |
list |
Các phạm vi OAuth 2.0 áp dụng cho phương thức này. |
methods.(key).supportsMediaDownload |
boolean |
Phương thức này có hỗ trợ tải nội dung nghe nhìn xuống hay không. |
methods.(key).supportsMediaUpload |
boolean |
Phương thức này có hỗ trợ tải tệp nghe nhìn lên hay không. |
methods.(key).mediaUpload |
object |
Các thông số tải nội dung nghe nhìn lên. |
methods.(key).mediaUpload.accept[] |
list |
Dải loại MIME nội dung đa phương tiện cho nội dung đa phương tiện được chấp nhận tải lên phương thức này. |
methods.(key).mediaUpload.maxSize |
string |
Kích thước tối đa của một tệp đa phương tiện tải lên, chẳng hạn như "1MB", "2GB" hoặc "3TB". |
methods.(key).supportsSubscription |
boolean |
Phương thức này có hỗ trợ gói thuê bao hay không. |
baseUrl |
string |
[KHÔNG DÙNG NỮA] URL cơ sở cho các yêu cầu REST. |
basePath |
string |
[KHÔNG DÙNG NỮA] Đường dẫn cơ sở cho các yêu cầu REST. |
servicePath |
string |
Đường dẫn cơ sở cho tất cả các yêu cầu REST. |
batchPath |
string |
Đường dẫn cho các yêu cầu hàng loạt REST. |
methods.(key).path |
string |
Đường dẫn URI của phương thức REST này. Bạn nên sử dụng thuộc tính servicePath cùng với thuộc tính ở cấp độ API.
|
methods.(key).httpMethod |
string |
Phương thức HTTP mà phương thức này sử dụng. |
methods.(key).request |
object |
Giản đồ cho yêu cầu. |
methods.(key).request.$ref |
string |
Mã giản đồ cho giản đồ yêu cầu. |
methods.(key).request.parameterName |
string |
[KHÔNG DÙNG NỮA] Một số API có trường này vì lý do tương thích ngược. Bạn có thể yên tâm bỏ qua cảnh báo này. |
methods.(key).response |
object |
Lược đồ cho phản hồi. |
methods.(key).response.$ref |
string |
Mã giản đồ cho giản đồ phản hồi. |
methods.(key).mediaUpload.protocols |
object |
Các giao thức tải lên được hỗ trợ. |
methods.(key).mediaUpload.protocols.simple |
object |
Hỗ trợ tải lên dưới dạng một yêu cầu HTTP duy nhất. |
methods.(key).mediaUpload.protocols.simple.multipart |
boolean |
True nếu điểm cuối này hỗ trợ tải nội dung đa phương tiện nhiều phần lên. |
methods.(key).mediaUpload.protocols.simple.path |
string |
Đường dẫn URI sẽ được dùng để tải lên. Bạn nên dùng thuộc tính này cùng với thuộc tính rootURL ở cấp độ API.
|
methods.(key).mediaUpload.protocols.resumable |
object |
Hỗ trợ giao thức Tải nội dung nghe nhìn lên có thể tiếp tục. |
methods.(key).mediaUpload.protocols.resumable.multipart |
boolean |
true nếu điểm cuối này hỗ trợ tải nội dung nghe nhìn nhiều phần lên. |
methods.(key).mediaUpload.protocols.resumable.path |
string |
Đường dẫn URI sẽ được dùng để tải lên. Bạn nên sử dụng thuộc tính rootURL cùng với thuộc tính ở cấp độ API.
|
resources |
object |
Các tài nguyên trong API này. |
resources.(key) |
nested object |
Nội dung mô tả tài nguyên riêng lẻ. Chứa các phương thức và tài nguyên phụ liên quan đến tài nguyên này. |
resources.(key).methods |
object |
Các phương thức trên tài nguyên này. |
resources.(key).methods.(key) |
nested object |
Nội dung mô tả cho mọi phương thức trên tài nguyên này. |
resources.(key).methods.(key).id |
string |
Mã nhận dạng duy nhất cho phương thức này. Bạn có thể dùng thuộc tính này để so khớp các phương thức giữa các phiên bản Khám phá. |
resources.(key).methods.(key).path |
string |
Đường dẫn URI của phương thức REST này. Bạn nên sử dụng thuộc tính servicePath cùng với thuộc tính ở cấp độ API.
|
resources.(key).methods.(key).flatPath |
string |
Đường dẫn URI của phương thức REST này ở định dạng (RFC 6570) mà không có các tính năng cấp 2 ({+var}). Bổ sung cho thuộc tính path.
|
resources.(key).methods.(key).httpMethod |
string |
Phương thức HTTP mà phương thức này sử dụng. |
resources.(key).methods.(key).description |
string |
Nội dung mô tả về phương thức này. |
resources.(key).methods.(key).deprecated |
boolean |
Phương thức này có không được dùng nữa hay không. |
resources.(key).methods.(key).parameters |
object |
Thông tin chi tiết về tất cả các tham số trong phương thức này. |
resources.(key).methods.(key).parameters.(key) |
nested object |
Thông tin chi tiết về một tham số trong phương thức này. |
resources.(key).methods.(key).parameters.(key).id |
string |
Giá trị nhận dạng duy nhất cho giản đồ này. |
resources.(key).methods.(key).parameters.(key).type |
string |
Loại giá trị cho giản đồ này. Bạn có thể xem danh sách các giá trị tại phần "type" (loại) trong Giản đồ JSON. |
resources.(key).methods.(key).parameters.(key).$ref |
string |
Tham chiếu đến một giản đồ khác. Giá trị của thuộc tính này là "ID" của một lược đồ khác. |
resources.(key).methods.(key).parameters.(key).description |
string |
Nội dung mô tả về đối tượng này. |
resources.(key).methods.(key).parameters.(key).default |
string |
Giá trị mặc định của thuộc tính này (nếu có). |
resources.(key).methods.(key).parameters.(key).required |
boolean |
Tham số có bắt buộc hay không. |
resources.(key).methods.(key).parameters.(key).deprecated |
boolean |
Tham số này có bị ngừng sử dụng hay không. |
resources.(key).methods.(key).parameters.(key).format |
string |
Một biểu thức chính quy hoặc khoá bổ sung giúp hạn chế giá trị. Để biết thêm thông tin chi tiết, hãy xem bảng tóm tắt loại và định dạng. |
resources.(key).methods.(key).parameters.(key).pattern |
string |
Biểu thức chính quy mà tham số này phải tuân thủ. |
resources.(key).methods.(key).parameters.(key).minimum |
string |
Giá trị tối thiểu của tham số này. |
resources.(key).methods.(key).parameters.(key).maximum |
string |
Giá trị tối đa của tham số này. |
resources.(key).methods.(key).parameters.(key).enum[] |
list |
Các giá trị mà tham số này có thể nhận (nếu là một enum). |
resources.(key).methods.(key).parameters.(key).enumDescriptions[] |
list |
Nội dung mô tả cho các enum. Mỗi vị trí liên kết với giá trị tương ứng trong mảng enum.
|
resources.(key).methods.(key).parameters.(key).enumDeprecated[] |
list |
Trạng thái ngừng sử dụng của các kiểu dữ liệu liệt kê. Mỗi vị trí liên kết với giá trị tương ứng trong mảng enum.
|
resources.(key).methods.(key).parameters.(key).repeated |
boolean |
Tham số này có thể xuất hiện nhiều lần hay không. |
resources.(key).methods.(key).parameters.(key).location |
string |
Tham số này nằm trong truy vấn hay đường dẫn cho các yêu cầu REST. |
resources.(key).methods.(key).parameters.(key).properties |
object |
Nếu đây là một giản đồ cho một đối tượng, hãy liệt kê giản đồ cho từng thuộc tính của đối tượng này. |
resources.(key).methods.(key).parameters.(key).properties.(key) |
nested object |
Một thuộc tính duy nhất của đối tượng này. Giá trị này là một đối tượng JSON Schema mô tả thuộc tính này. |
resources.(key).methods.(key).parameters.(key).additionalProperties |
nested object |
Nếu đây là một giản đồ cho một đối tượng, thì thuộc tính này là giản đồ cho mọi thuộc tính bổ sung có khoá động trên đối tượng này. |
resources.(key).methods.(key).parameters.(key).items |
nested object |
Nếu đây là một giản đồ cho một mảng, thì thuộc tính này là giản đồ cho từng phần tử trong mảng. |
resources.(key).methods.(key).parameters.(key).annotations |
object |
Thông tin bổ sung về tài sản này. |
resources.(key).methods.(key).parameters.(key).annotations.required[] |
list |
Danh sách các phương thức yêu cầu thuộc tính này trong các yêu cầu. |
resources.(key).methods.(key).parameterOrder[] |
list |
Danh sách có thứ tự các tham số bắt buộc. Đây là gợi ý cho các ứng dụng về cách cấu trúc chữ ký phương thức. Mảng được sắp xếp sao cho tham số quan trọng nhất xuất hiện đầu tiên. |
resources.(key).methods.(key).request |
object |
Giản đồ cho yêu cầu. |
resources.(key).methods.(key).request.$ref |
string |
Mã giản đồ cho giản đồ yêu cầu. |
resources.(key).methods.(key).response |
object |
Lược đồ cho phản hồi. |
resources.(key).methods.(key).response.$ref |
string |
Mã giản đồ cho giản đồ phản hồi. |
resources.(key).methods.(key).scopes[] |
list |
Các phạm vi OAuth 2.0 áp dụng cho phương thức này. |
resources.(key).methods.(key).supportsMediaDownload |
boolean |
Phương thức này có hỗ trợ tải nội dung nghe nhìn xuống hay không. |
resources.(key).methods.(key).supportsMediaUpload |
boolean |
Phương thức này có hỗ trợ tải tệp nghe nhìn lên hay không. |
resources.(key).methods.(key).mediaUpload |
object |
Các thông số tải nội dung nghe nhìn lên. |
resources.(key).methods.(key).mediaUpload.accept[] |
list |
Dải loại MIME nội dung đa phương tiện cho nội dung đa phương tiện được chấp nhận tải lên phương thức này. |
resources.(key).methods.(key).mediaUpload.maxSize |
string |
Kích thước tối đa của một tệp đa phương tiện tải lên, chẳng hạn như "1MB", "2GB" hoặc "3TB". |
resources.(key).methods.(key).mediaUpload.protocols |
object |
Các giao thức tải lên được hỗ trợ. |
resources.(key).methods.(key).mediaUpload.protocols.simple |
object |
Hỗ trợ tải lên dưới dạng một yêu cầu HTTP duy nhất. |
resources.(key).methods.(key).mediaUpload.protocols.simple.multipart |
boolean |
true nếu điểm cuối này hỗ trợ tải nội dung nghe nhìn nhiều phần lên. |
resources.(key).methods.(key).mediaUpload.protocols.simple.path |
string |
Đường dẫn URI sẽ được dùng để tải lên. Bạn nên sử dụng thuộc tính rootURL cùng với thuộc tính ở cấp độ API.
|
resources.(key).methods.(key).mediaUpload.protocols.resumable |
object |
Hỗ trợ giao thức Tải nội dung nghe nhìn lên có thể tiếp tục. |
resources.(key).methods.(key).mediaUpload.protocols.resumable.multipart |
boolean |
true nếu điểm cuối này hỗ trợ tải nội dung nghe nhìn nhiều phần lên. |
resources.(key).methods.(key).mediaUpload.protocols.resumable.path |
string |
Đường dẫn URI sẽ được dùng để tải lên. Bạn nên sử dụng thuộc tính rootURL cùng với thuộc tính ở cấp độ API.
|
resources.(key).methods.(key).supportsSubscription |
boolean |
Phương thức này có hỗ trợ gói thuê bao hay không. |
resources.(key).deprecated |
boolean |
Tài nguyên này có không được dùng nữa hay không. |
resources.(key).resources |
object |
Tài nguyên phụ trên tài nguyên này. |
resources.(key).resources.(key) |
nested object |
Nội dung mô tả cho mọi tài nguyên phụ trên tài nguyên này. |