1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="discovery_v1.html">API Discovery Service</a> . <a href="discovery_v1.apis.html">apis</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#getRest">getRest(api, version)</a></code></p> 82<p class="firstline">Retrieve the description of a particular version of an api.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(name=None, preferred=None)</a></code></p> 85<p class="firstline">Retrieve the list of APIs supported at this endpoint.</p> 86<h3>Method Details</h3> 87<div class="method"> 88 <code class="details" id="close">close()</code> 89 <pre>Close httplib2 connections.</pre> 90</div> 91 92<div class="method"> 93 <code class="details" id="getRest">getRest(api, version)</code> 94 <pre>Retrieve the description of a particular version of an api. 95 96Args: 97 api: string, The name of the API. (required) 98 version: string, The version of the API. (required) 99 100Returns: 101 An object of the form: 102 103 { 104 "auth": { # Authentication information. 105 "oauth2": { # OAuth 2.0 authentication information. 106 "scopes": { # Available OAuth 2.0 scopes. 107 "a_key": { # The scope value. 108 "description": "A String", # Description of scope. 109 }, 110 }, 111 }, 112 }, 113 "basePath": "A String", # [DEPRECATED] The base path for REST requests. 114 "baseUrl": "A String", # [DEPRECATED] The base URL for REST requests. 115 "batchPath": "A String", # The path for REST batch requests. 116 "canonicalName": "A String", # Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names. 117 "description": "A String", # The description of this API. 118 "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc. 119 "documentationLink": "A String", # A link to human readable documentation for the API. 120 "etag": "A String", # The ETag for this response. 121 "exponentialBackoffDefault": True or False, # Enable exponential backoff for suitable methods in the generated clients. 122 "features": [ # A list of supported features for this API. 123 "A String", 124 ], 125 "icons": { # Links to 16x16 and 32x32 icons representing the API. 126 "x16": "A String", # The URL of the 16x16 icon. 127 "x32": "A String", # The URL of the 32x32 icon. 128 }, 129 "id": "A String", # The ID of this API. 130 "kind": "discovery#restDescription", # The kind for this response. 131 "labels": [ # Labels for the status of this API, such as labs or deprecated. 132 "A String", 133 ], 134 "methods": { # API-level methods for this API. 135 "a_key": { # An individual method description. 136 "description": "A String", # Description of this method. 137 "etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header. 138 "flatPath": "A String", # The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property. 139 "httpMethod": "A String", # HTTP method used by this method. 140 "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery. 141 "mediaUpload": { # Media upload parameters. 142 "accept": [ # MIME Media Ranges for acceptable media uploads to this method. 143 "A String", 144 ], 145 "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB". 146 "protocols": { # Supported upload protocols. 147 "resumable": { # Supports the Resumable Media Upload protocol. 148 "multipart": true, # True if this endpoint supports uploading multipart media. 149 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level. 150 }, 151 "simple": { # Supports uploading as a single HTTP request. 152 "multipart": true, # True if this endpoint supports upload multipart media. 153 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level. 154 }, 155 }, 156 }, 157 "parameterOrder": [ # Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first. 158 "A String", 159 ], 160 "parameters": { # Details for all parameters in this method. 161 "a_key": { # Details for a single parameter in this method. 162 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema. 163 "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object. 164 "annotations": { # Additional information about this property. 165 "required": [ # A list of methods for which this property is required on requests. 166 "A String", 167 ], 168 }, 169 "default": "A String", # The default value of this property (if one exists). 170 "description": "A String", # A description of this object. 171 "enum": [ # Values this parameter may take (if it is an enum). 172 "A String", 173 ], 174 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. 175 "A String", 176 ], 177 "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 178 "id": "A String", # Unique identifier for this schema. 179 "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array. 180 "location": "A String", # Whether this parameter goes in the query or the path for REST requests. 181 "maximum": "A String", # The maximum value of this parameter. 182 "minimum": "A String", # The minimum value of this parameter. 183 "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html 184 "properties": { # If this is a schema for an object, list the schema for each property of this object. 185 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property. 186 }, 187 "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service. 188 "repeated": True or False, # Whether this parameter may appear multiple times. 189 "required": True or False, # Whether the parameter is required. 190 "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 191 "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names. 192 "discriminant": "A String", # The name of the type discriminant property. 193 "map": [ # The map of discriminant value to schema to use for parsing.. 194 { 195 "$ref": "A String", 196 "type_value": "A String", 197 }, 198 ], 199 }, 200 }, 201 }, 202 "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level. 203 "request": { # The schema for the request. 204 "$ref": "A String", # Schema ID for the request schema. 205 "parameterName": "A String", # parameter name. 206 }, 207 "response": { # The schema for the response. 208 "$ref": "A String", # Schema ID for the response schema. 209 }, 210 "scopes": [ # OAuth 2.0 scopes applicable to this method. 211 "A String", 212 ], 213 "supportsMediaDownload": True or False, # Whether this method supports media downloads. 214 "supportsMediaUpload": True or False, # Whether this method supports media uploads. 215 "supportsSubscription": True or False, # Whether this method supports subscriptions. 216 "useMediaDownloadService": True or False, # Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download. 217 }, 218 }, 219 "name": "A String", # The name of this API. 220 "ownerDomain": "A String", # The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name. 221 "ownerName": "A String", # The name of the owner of this API. See ownerDomain. 222 "packagePath": "A String", # The package of the owner of this API. See ownerDomain. 223 "parameters": { # Common parameters that apply across all apis. 224 "a_key": { # Description of a single parameter. 225 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema. 226 "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object. 227 "annotations": { # Additional information about this property. 228 "required": [ # A list of methods for which this property is required on requests. 229 "A String", 230 ], 231 }, 232 "default": "A String", # The default value of this property (if one exists). 233 "description": "A String", # A description of this object. 234 "enum": [ # Values this parameter may take (if it is an enum). 235 "A String", 236 ], 237 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. 238 "A String", 239 ], 240 "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 241 "id": "A String", # Unique identifier for this schema. 242 "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array. 243 "location": "A String", # Whether this parameter goes in the query or the path for REST requests. 244 "maximum": "A String", # The maximum value of this parameter. 245 "minimum": "A String", # The minimum value of this parameter. 246 "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html 247 "properties": { # If this is a schema for an object, list the schema for each property of this object. 248 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property. 249 }, 250 "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service. 251 "repeated": True or False, # Whether this parameter may appear multiple times. 252 "required": True or False, # Whether the parameter is required. 253 "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 254 "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names. 255 "discriminant": "A String", # The name of the type discriminant property. 256 "map": [ # The map of discriminant value to schema to use for parsing.. 257 { 258 "$ref": "A String", 259 "type_value": "A String", 260 }, 261 ], 262 }, 263 }, 264 }, 265 "protocol": "rest", # The protocol described by this document. 266 "resources": { # The resources in this API. 267 "a_key": { # An individual resource description. Contains methods and sub-resources related to this resource. 268 "methods": { # Methods on this resource. 269 "a_key": { # Description for any methods on this resource. 270 "description": "A String", # Description of this method. 271 "etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header. 272 "flatPath": "A String", # The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property. 273 "httpMethod": "A String", # HTTP method used by this method. 274 "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery. 275 "mediaUpload": { # Media upload parameters. 276 "accept": [ # MIME Media Ranges for acceptable media uploads to this method. 277 "A String", 278 ], 279 "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB". 280 "protocols": { # Supported upload protocols. 281 "resumable": { # Supports the Resumable Media Upload protocol. 282 "multipart": true, # True if this endpoint supports uploading multipart media. 283 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level. 284 }, 285 "simple": { # Supports uploading as a single HTTP request. 286 "multipart": true, # True if this endpoint supports upload multipart media. 287 "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level. 288 }, 289 }, 290 }, 291 "parameterOrder": [ # Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first. 292 "A String", 293 ], 294 "parameters": { # Details for all parameters in this method. 295 "a_key": { # Details for a single parameter in this method. 296 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema. 297 "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object. 298 "annotations": { # Additional information about this property. 299 "required": [ # A list of methods for which this property is required on requests. 300 "A String", 301 ], 302 }, 303 "default": "A String", # The default value of this property (if one exists). 304 "description": "A String", # A description of this object. 305 "enum": [ # Values this parameter may take (if it is an enum). 306 "A String", 307 ], 308 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. 309 "A String", 310 ], 311 "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 312 "id": "A String", # Unique identifier for this schema. 313 "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array. 314 "location": "A String", # Whether this parameter goes in the query or the path for REST requests. 315 "maximum": "A String", # The maximum value of this parameter. 316 "minimum": "A String", # The minimum value of this parameter. 317 "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html 318 "properties": { # If this is a schema for an object, list the schema for each property of this object. 319 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property. 320 }, 321 "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service. 322 "repeated": True or False, # Whether this parameter may appear multiple times. 323 "required": True or False, # Whether the parameter is required. 324 "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 325 "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names. 326 "discriminant": "A String", # The name of the type discriminant property. 327 "map": [ # The map of discriminant value to schema to use for parsing.. 328 { 329 "$ref": "A String", 330 "type_value": "A String", 331 }, 332 ], 333 }, 334 }, 335 }, 336 "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level. 337 "request": { # The schema for the request. 338 "$ref": "A String", # Schema ID for the request schema. 339 "parameterName": "A String", # parameter name. 340 }, 341 "response": { # The schema for the response. 342 "$ref": "A String", # Schema ID for the response schema. 343 }, 344 "scopes": [ # OAuth 2.0 scopes applicable to this method. 345 "A String", 346 ], 347 "supportsMediaDownload": True or False, # Whether this method supports media downloads. 348 "supportsMediaUpload": True or False, # Whether this method supports media uploads. 349 "supportsSubscription": True or False, # Whether this method supports subscriptions. 350 "useMediaDownloadService": True or False, # Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download. 351 }, 352 }, 353 "resources": { # Sub-resources on this resource. 354 "a_key": # Object with schema name: RestResource # Description for any sub-resources on this resource. 355 }, 356 }, 357 }, 358 "revision": "A String", # The version of this API. 359 "rootUrl": "A String", # The root URL under which all API services live. 360 "schemas": { # The schemas for this API. 361 "a_key": { # An individual schema description. 362 "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema. 363 "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object. 364 "annotations": { # Additional information about this property. 365 "required": [ # A list of methods for which this property is required on requests. 366 "A String", 367 ], 368 }, 369 "default": "A String", # The default value of this property (if one exists). 370 "description": "A String", # A description of this object. 371 "enum": [ # Values this parameter may take (if it is an enum). 372 "A String", 373 ], 374 "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. 375 "A String", 376 ], 377 "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23 378 "id": "A String", # Unique identifier for this schema. 379 "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array. 380 "location": "A String", # Whether this parameter goes in the query or the path for REST requests. 381 "maximum": "A String", # The maximum value of this parameter. 382 "minimum": "A String", # The minimum value of this parameter. 383 "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html 384 "properties": { # If this is a schema for an object, list the schema for each property of this object. 385 "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property. 386 }, 387 "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service. 388 "repeated": True or False, # Whether this parameter may appear multiple times. 389 "required": True or False, # Whether the parameter is required. 390 "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 391 "variant": { # In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names. 392 "discriminant": "A String", # The name of the type discriminant property. 393 "map": [ # The map of discriminant value to schema to use for parsing.. 394 { 395 "$ref": "A String", 396 "type_value": "A String", 397 }, 398 ], 399 }, 400 }, 401 }, 402 "servicePath": "A String", # The base path for all REST requests. 403 "title": "A String", # The title of this API. 404 "version": "A String", # The version of this API. 405 "version_module": True or False, 406}</pre> 407</div> 408 409<div class="method"> 410 <code class="details" id="list">list(name=None, preferred=None)</code> 411 <pre>Retrieve the list of APIs supported at this endpoint. 412 413Args: 414 name: string, Only include APIs with the given name. 415 preferred: boolean, Return only the preferred version of an API. 416 417Returns: 418 An object of the form: 419 420 { 421 "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc. 422 "items": [ # The individual directory entries. One entry per api/version pair. 423 { 424 "description": "A String", # The description of this API. 425 "discoveryLink": "A String", # A link to the discovery document. 426 "discoveryRestUrl": "A String", # The URL for the discovery REST document. 427 "documentationLink": "A String", # A link to human readable documentation for the API. 428 "icons": { # Links to 16x16 and 32x32 icons representing the API. 429 "x16": "A String", # The URL of the 16x16 icon. 430 "x32": "A String", # The URL of the 32x32 icon. 431 }, 432 "id": "A String", # The id of this API. 433 "kind": "discovery#directoryItem", # The kind for this response. 434 "labels": [ # Labels for the status of this API, such as labs or deprecated. 435 "A String", 436 ], 437 "name": "A String", # The name of the API. 438 "preferred": True or False, # True if this version is the preferred version to use. 439 "title": "A String", # The title of this API. 440 "version": "A String", # The version of the API. 441 }, 442 ], 443 "kind": "discovery#directoryList", # The kind for this response. 444}</pre> 445</div> 446 447</body></html>