שיטות
מסמך Discovery מתמקד בשיטת 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 |
יש לציין את הגרסה של Discovery API שמשמשת ליצירת המסמך. | |
id |
string |
מזהה מסמך Discovery עבור ה-API. לדוגמה: urlshortener:v1 . |
|
name |
string |
שם ה-API. לדוגמה, urlshortener . |
|
canonicalName |
string |
השם הקנוני של ה-API. לדוגמה, Url Shortener . |
|
version |
string |
גרסת ה-API. לדוגמה: v1 . |
|
revision |
string |
גרסת ה-API הקודמת. | |
title |
string |
כותרת ה-API. לדוגמה, "Google Url Shorter API". | |
description |
string |
התיאור של ה-API הזה. | |
icons |
object |
קישורים לסמלים בגודל 16x16 ו-32x32 שמייצגים את ה-API. | |
icons.x16 |
string |
כתובת ה-URL של הסמל בגודל 16x16. | |
icons.x32 |
string |
כתובת האתר של הסמל בגודל 32x32. | |
documentationLink |
string |
קישור לתיעוד בממשק ה-API. | |
labels[] |
list |
תוויות לסטטוס של ה-API הזה. הערכים החוקיים הם limited_availability או deprecated . |
|
protocol |
string |
הפרוטוקול שמתואר במסמך. לדוגמה, REST. | |
rootUrl |
string |
כתובת ה-URL הבסיסית שממנה כל שירותי ה-API פועלים. | |
endpoints[] |
list |
רשימת אובייקטים של נקודות קצה (endpoint) מבוססי-מיקום עבור ה-API הזה. כל אובייקט מכיל את כתובת ה-URL של נקודת הקצה, את המיקום, את התיאור ואת הסטטוס של ההוצאה משימוש. | |
endpoints[].endpointUrl |
string |
כתובת ה-URL של מארח היעד של נקודת הקצה. | |
endpoints[].location |
string |
המיקום של נקודת הקצה. | |
endpoints[].description |
string |
מחרוזת שמתארת את המארח שצוין על ידי כתובת האתר. | |
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). | |
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 Schema. | |
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 . |
|
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 . |
|
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 |
הערך הוא True אם נקודת הקצה הזו תומכת בהעלאת מדיה מרובת חלקים. | |
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 |
הפניה לסכימה אחרת. הערך של המאפיין הזה הוא ה "מזהה" של סכימה אחרת. | |
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 . |
|
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 |
תיאור של משאבי המשנה במשאב הזה. |