Methods
מסמך הגילוי מתמקד ב-RESTful method של הפעלת API. השיטה discovery.apis.list מחזירה את רשימת כל ממשקי ה-API שנתמכים על ידי שירות Google APIs Discovery, כולל כתובות ה-URL לאחזור מסמכי ה-Discovery שמבוססים על 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. לדוגמה, "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 |
סוג הערך של הסכימה הזו. רשימת הערכים זמינה בקטע 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 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 |
סוג הערך של הסכימה הזו. רשימת הערכים זמינה בקטע 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 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 |
סוג הערך של הסכימה הזו. רשימת הערכים זמינה בקטע 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 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 |
הגודל המקסימלי של העלאת מדיה, כמו 1MB, 2GB או 3TB. |
methods.(key).supportsSubscription |
boolean |
האם השיטה הזו תומכת במינויים. |
baseUrl |
string |
[DEPRECATED] כתובת ה-URL הבסיסית לבקשות REST. |
basePath |
string |
[DEPRECATED] נתיב הבסיס לבקשות REST. |
servicePath |
string |
נתיב הבסיס לכל בקשות ה-REST. |
batchPath |
string |
הנתיב לבקשות באצווה של REST. |
methods.(key).path |
string |
נתיב ה-URI של ה-method הזה של REST. צריך להשתמש במדיניות הזו בשילוב עם המאפיין servicePath ברמת ה-API.
|
methods.(key).httpMethod |
string |
שיטת ה-HTTP שבה נעשה שימוש בשיטה הזו. |
methods.(key).request |
object |
הסכימה של הבקשה. |
methods.(key).request.$ref |
string |
מזהה הסכימה של סכימת הבקשה. |
methods.(key).request.parameterName |
string |
[DEPRECATED] חלק מממשקי ה-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 |
הערך הוא True אם נקודת הקצה הזו תומכת בהעלאת מדיה מרובת חלקים. |
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 |
נתיב ה-URI שבו יש להשתמש להעלאה. צריך להשתמש במדיניות הזו בשילוב עם המאפיין rootURL ברמת ה-API.
|
resources |
object |
המשאבים ב-API הזה. |
resources.(key) |
nested object |
תיאור של משאב בודד. מכיל שיטות ומשאבי משנה שקשורים למשאב הזה. |
resources.(key).methods |
object |
Methods במשאב הזה. |
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 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 |
הסכימה של הבקשה. |
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 |
תומך בפרוטוקול Resumable Media Upload. |
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 |
תיאור של משאבי משנה במשאב הזה. |