1<?xml version="1.0" encoding="ascii"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 3 "DTD/xhtml1-transitional.dtd"> 4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 5<head> 6 <title>googleapiclient.discovery</title> 7 <link rel="stylesheet" href="epydoc.css" type="text/css" /> 8 <script type="text/javascript" src="epydoc.js"></script> 9</head> 10 11<body bgcolor="white" text="black" link="blue" vlink="#204080" 12 alink="#204080"> 13<!-- ==================== NAVIGATION BAR ==================== --> 14<table class="navbar" border="0" width="100%" cellpadding="0" 15 bgcolor="#a0c0ff" cellspacing="0"> 16 <tr valign="middle"> 17 <!-- Home link --> 18 <th> <a 19 href="googleapiclient-module.html">Home</a> </th> 20 21 <!-- Tree link --> 22 <th> <a 23 href="module-tree.html">Trees</a> </th> 24 25 <!-- Index link --> 26 <th> <a 27 href="identifier-index.html">Indices</a> </th> 28 29 <!-- Help link --> 30 <th> <a 31 href="help.html">Help</a> </th> 32 33 <th class="navbar" width="100%"></th> 34 </tr> 35</table> 36<table width="100%" cellpadding="0" cellspacing="0"> 37 <tr valign="top"> 38 <td width="100%"> 39 <span class="breadcrumbs"> 40 <a href="googleapiclient-module.html">Package googleapiclient</a> :: 41 Module discovery 42 </span> 43 </td> 44 <td> 45 <table cellpadding="0" cellspacing="0"> 46 <!-- hide/show private --> 47 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" 48 onclick="toggle_private();">hide private</a>]</span></td></tr> 49 <tr><td align="right"><span class="options" 50 >[<a href="frames.html" target="_top">frames</a 51 >] | <a href="googleapiclient.discovery-module.html" 52 target="_top">no frames</a>]</span></td></tr> 53 </table> 54 </td> 55 </tr> 56</table> 57<!-- ==================== MODULE DESCRIPTION ==================== --> 58<h1 class="epydoc">Module discovery</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery-pysrc.html">source code</a></span></p> 59<pre class="literalblock"> 60Client for discovery based APIs. 61 62A client library for Google's discovery based APIs. 63 64</pre> 65 66<hr /> 67<div class="fields"> <p><strong>Author:</strong> 68 jcgregorio@google.com (Joe Gregorio) 69 </p> 70</div><!-- ==================== CLASSES ==================== --> 71<a name="section-Classes"></a> 72<table class="summary" border="1" cellpadding="3" 73 cellspacing="0" width="100%" bgcolor="white"> 74<tr bgcolor="#70b0f0" class="table-header"> 75 <td colspan="2" class="table-header"> 76 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 77 <tr valign="top"> 78 <td align="left"><span class="table-header">Classes</span></td> 79 <td align="right" valign="top" 80 ><span class="options">[<a href="#section-Classes" 81 class="privatelink" onclick="toggle_private();" 82 >hide private</a>]</span></td> 83 </tr> 84 </table> 85 </td> 86</tr> 87<tr class="private"> 88 <td width="15%" align="right" valign="top" class="summary"> 89 <span class="summary-type"> </span> 90 </td><td class="summary"> 91 <a href="googleapiclient.discovery._BytesGenerator-class.html" class="summary-name" onclick="show_private();">_BytesGenerator</a> 92 </td> 93 </tr> 94<tr class="private"> 95 <td width="15%" align="right" valign="top" class="summary"> 96 <span class="summary-type"> </span> 97 </td><td class="summary"> 98 <a href="googleapiclient.discovery.ResourceMethodParameters-class.html" class="summary-name" onclick="show_private();">ResourceMethodParameters</a><br /> 99 Represents the parameters associated with a method. 100 </td> 101 </tr> 102<tr class="private"> 103 <td width="15%" align="right" valign="top" class="summary"> 104 <span class="summary-type"> </span> 105 </td><td class="summary"> 106 <a href="googleapiclient.discovery.Resource-class.html" class="summary-name" onclick="show_private();">Resource</a><br /> 107 A class for interacting with a resource. 108 </td> 109 </tr> 110</table> 111<!-- ==================== FUNCTIONS ==================== --> 112<a name="section-Functions"></a> 113<table class="summary" border="1" cellpadding="3" 114 cellspacing="0" width="100%" bgcolor="white"> 115<tr bgcolor="#70b0f0" class="table-header"> 116 <td colspan="2" class="table-header"> 117 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 118 <tr valign="top"> 119 <td align="left"><span class="table-header">Functions</span></td> 120 <td align="right" valign="top" 121 ><span class="options">[<a href="#section-Functions" 122 class="privatelink" onclick="toggle_private();" 123 >hide private</a>]</span></td> 124 </tr> 125 </table> 126 </td> 127</tr> 128<tr> 129 <td width="15%" align="right" valign="top" class="summary"> 130 <span class="summary-type"> </span> 131 </td><td class="summary"> 132 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 133 <tr> 134 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#fix_method_name" class="summary-sig-name">fix_method_name</a>(<span class="summary-sig-arg">name</span>)</span><br /> 135 Fix method names to avoid '$' characters and reserved word conflicts.</td> 136 <td align="right" valign="top"> 137 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#fix_method_name">source code</a></span> 138 139 </td> 140 </tr> 141 </table> 142 143 </td> 144 </tr> 145<tr> 146 <td width="15%" align="right" valign="top" class="summary"> 147 <span class="summary-type"> </span> 148 </td><td class="summary"> 149 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 150 <tr> 151 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#key2param" class="summary-sig-name">key2param</a>(<span class="summary-sig-arg">key</span>)</span><br /> 152 Converts key names into parameter names.</td> 153 <td align="right" valign="top"> 154 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#key2param">source code</a></span> 155 156 </td> 157 </tr> 158 </table> 159 160 </td> 161 </tr> 162<tr> 163 <td width="15%" align="right" valign="top" class="summary"> 164 <span class="summary-type"> </span> 165 </td><td class="summary"> 166 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 167 <tr> 168 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#build" class="summary-sig-name">build</a>(<span class="summary-sig-arg">serviceName</span>, 169 <span class="summary-sig-arg">version</span>, 170 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>, 171 <span class="summary-sig-arg">discoveryServiceUrl</span>=<span class="summary-sig-default">DISCOVERY_URI</span>, 172 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>, 173 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>, 174 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>, 175 <span class="summary-sig-arg">credentials</span>=<span class="summary-sig-default">None</span>, 176 <span class="summary-sig-arg">cache_discovery</span>=<span class="summary-sig-default">True</span>, 177 <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">None</span>)</span><br /> 178 Construct a Resource for interacting with an API.</td> 179 <td align="right" valign="top"> 180 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build">source code</a></span> 181 182 </td> 183 </tr> 184 </table> 185 186 </td> 187 </tr> 188<tr class="private"> 189 <td width="15%" align="right" valign="top" class="summary"> 190 <span class="summary-type"> </span> 191 </td><td class="summary"> 192 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 193 <tr> 194 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_retrieve_discovery_doc" class="summary-sig-name" onclick="show_private();">_retrieve_discovery_doc</a>(<span class="summary-sig-arg">url</span>, 195 <span class="summary-sig-arg">http</span>, 196 <span class="summary-sig-arg">cache_discovery</span>, 197 <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">None</span>, 198 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>)</span><br /> 199 Retrieves the discovery_doc from cache or the internet.</td> 200 <td align="right" valign="top"> 201 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_retrieve_discovery_doc">source code</a></span> 202 203 </td> 204 </tr> 205 </table> 206 207 </td> 208 </tr> 209<tr> 210 <td width="15%" align="right" valign="top" class="summary"> 211 <span class="summary-type"> </span> 212 </td><td class="summary"> 213 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 214 <tr> 215 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#build_from_document" class="summary-sig-name">build_from_document</a>(<span class="summary-sig-arg">service</span>, 216 <span class="summary-sig-arg">base</span>=<span class="summary-sig-default">None</span>, 217 <span class="summary-sig-arg">future</span>=<span class="summary-sig-default">None</span>, 218 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>, 219 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>, 220 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>, 221 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>, 222 <span class="summary-sig-arg">credentials</span>=<span class="summary-sig-default">None</span>)</span><br /> 223 Create a Resource for interacting with an API.</td> 224 <td align="right" valign="top"> 225 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source code</a></span> 226 227 </td> 228 </tr> 229 </table> 230 231 </td> 232 </tr> 233<tr class="private"> 234 <td width="15%" align="right" valign="top" class="summary"> 235 <span class="summary-type"> </span> 236 </td><td class="summary"> 237 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 238 <tr> 239 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_cast" class="summary-sig-name" onclick="show_private();">_cast</a>(<span class="summary-sig-arg">value</span>, 240 <span class="summary-sig-arg">schema_type</span>)</span><br /> 241 Convert value to a string based on JSON Schema type.</td> 242 <td align="right" valign="top"> 243 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_cast">source code</a></span> 244 245 </td> 246 </tr> 247 </table> 248 249 </td> 250 </tr> 251<tr class="private"> 252 <td width="15%" align="right" valign="top" class="summary"> 253 <span class="summary-type"> </span> 254 </td><td class="summary"> 255 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 256 <tr> 257 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_media_size_to_long" class="summary-sig-name" onclick="show_private();">_media_size_to_long</a>(<span class="summary-sig-arg">maxSize</span>)</span><br /> 258 Convert a string media size, such as 10GB or 3TB into an integer.</td> 259 <td align="right" valign="top"> 260 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_size_to_long">source code</a></span> 261 262 </td> 263 </tr> 264 </table> 265 266 </td> 267 </tr> 268<tr class="private"> 269 <td width="15%" align="right" valign="top" class="summary"> 270 <span class="summary-type"> </span> 271 </td><td class="summary"> 272 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 273 <tr> 274 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_media_path_url_from_info" class="summary-sig-name" onclick="show_private();">_media_path_url_from_info</a>(<span class="summary-sig-arg">root_desc</span>, 275 <span class="summary-sig-arg">path_url</span>)</span><br /> 276 Creates an absolute media path URL.</td> 277 <td align="right" valign="top"> 278 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_path_url_from_info">source code</a></span> 279 280 </td> 281 </tr> 282 </table> 283 284 </td> 285 </tr> 286<tr class="private"> 287 <td width="15%" align="right" valign="top" class="summary"> 288 <span class="summary-type"> </span> 289 </td><td class="summary"> 290 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 291 <tr> 292 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_fix_up_parameters" class="summary-sig-name" onclick="show_private();">_fix_up_parameters</a>(<span class="summary-sig-arg">method_desc</span>, 293 <span class="summary-sig-arg">root_desc</span>, 294 <span class="summary-sig-arg">http_method</span>, 295 <span class="summary-sig-arg">schema</span>)</span><br /> 296 Updates parameters of an API method with values specific to this library.</td> 297 <td align="right" valign="top"> 298 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_parameters">source code</a></span> 299 300 </td> 301 </tr> 302 </table> 303 304 </td> 305 </tr> 306<tr class="private"> 307 <td width="15%" align="right" valign="top" class="summary"> 308 <span class="summary-type"> </span> 309 </td><td class="summary"> 310 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 311 <tr> 312 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_fix_up_media_upload" class="summary-sig-name" onclick="show_private();">_fix_up_media_upload</a>(<span class="summary-sig-arg">method_desc</span>, 313 <span class="summary-sig-arg">root_desc</span>, 314 <span class="summary-sig-arg">path_url</span>, 315 <span class="summary-sig-arg">parameters</span>)</span><br /> 316 Adds 'media_body' and 'media_mime_type' parameters if supported by method.</td> 317 <td align="right" valign="top"> 318 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_media_upload">source code</a></span> 319 320 </td> 321 </tr> 322 </table> 323 324 </td> 325 </tr> 326<tr class="private"> 327 <td width="15%" align="right" valign="top" class="summary"> 328 <span class="summary-type"> </span> 329 </td><td class="summary"> 330 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 331 <tr> 332 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_fix_up_method_description" class="summary-sig-name" onclick="show_private();">_fix_up_method_description</a>(<span class="summary-sig-arg">method_desc</span>, 333 <span class="summary-sig-arg">root_desc</span>, 334 <span class="summary-sig-arg">schema</span>)</span><br /> 335 Updates a method description in a discovery document.</td> 336 <td align="right" valign="top"> 337 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_method_description">source code</a></span> 338 339 </td> 340 </tr> 341 </table> 342 343 </td> 344 </tr> 345<tr class="private"> 346 <td width="15%" align="right" valign="top" class="summary"> 347 <span class="summary-type"> </span> 348 </td><td class="summary"> 349 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 350 <tr> 351 <td><span class="summary-sig"><a name="_urljoin"></a><span class="summary-sig-name">_urljoin</span>(<span class="summary-sig-arg">base</span>, 352 <span class="summary-sig-arg">url</span>)</span><br /> 353 Custom urljoin replacement supporting : before / in url.</td> 354 <td align="right" valign="top"> 355 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_urljoin">source code</a></span> 356 357 </td> 358 </tr> 359 </table> 360 361 </td> 362 </tr> 363<tr class="private"> 364 <td width="15%" align="right" valign="top" class="summary"> 365 <span class="summary-type"> </span> 366 </td><td class="summary"> 367 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 368 <tr> 369 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#createMethod" class="summary-sig-name" onclick="show_private();">createMethod</a>(<span class="summary-sig-arg">methodName</span>, 370 <span class="summary-sig-arg">methodDesc</span>, 371 <span class="summary-sig-arg">rootDesc</span>, 372 <span class="summary-sig-arg">schema</span>)</span><br /> 373 Creates a method for attaching to a Resource.</td> 374 <td align="right" valign="top"> 375 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createMethod">source code</a></span> 376 377 </td> 378 </tr> 379 </table> 380 381 </td> 382 </tr> 383<tr class="private"> 384 <td width="15%" align="right" valign="top" class="summary"> 385 <span class="summary-type"> </span> 386 </td><td class="summary"> 387 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 388 <tr> 389 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#createNextMethod" class="summary-sig-name" onclick="show_private();">createNextMethod</a>(<span class="summary-sig-arg">methodName</span>, 390 <span class="summary-sig-arg">pageTokenName</span>=<span class="summary-sig-default">'pageToken'</span>, 391 <span class="summary-sig-arg">nextPageTokenName</span>=<span class="summary-sig-default">'nextPageToken'</span>, 392 <span class="summary-sig-arg">isPageTokenParameter</span>=<span class="summary-sig-default">True</span>)</span><br /> 393 Creates any _next methods for attaching to a Resource.</td> 394 <td align="right" valign="top"> 395 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createNextMethod">source code</a></span> 396 397 </td> 398 </tr> 399 </table> 400 401 </td> 402 </tr> 403<tr class="private"> 404 <td width="15%" align="right" valign="top" class="summary"> 405 <span class="summary-type"> </span> 406 </td><td class="summary"> 407 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 408 <tr> 409 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_findPageTokenName" class="summary-sig-name" onclick="show_private();">_findPageTokenName</a>(<span class="summary-sig-arg">fields</span>)</span><br /> 410 Search field names for one like a page token.</td> 411 <td align="right" valign="top"> 412 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_findPageTokenName">source code</a></span> 413 414 </td> 415 </tr> 416 </table> 417 418 </td> 419 </tr> 420<tr class="private"> 421 <td width="15%" align="right" valign="top" class="summary"> 422 <span class="summary-type"> </span> 423 </td><td class="summary"> 424 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 425 <tr> 426 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_methodProperties" class="summary-sig-name" onclick="show_private();">_methodProperties</a>(<span class="summary-sig-arg">methodDesc</span>, 427 <span class="summary-sig-arg">schema</span>, 428 <span class="summary-sig-arg">name</span>)</span><br /> 429 Get properties of a field in a method description.</td> 430 <td align="right" valign="top"> 431 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_methodProperties">source code</a></span> 432 433 </td> 434 </tr> 435 </table> 436 437 </td> 438 </tr> 439</table> 440<!-- ==================== VARIABLES ==================== --> 441<a name="section-Variables"></a> 442<table class="summary" border="1" cellpadding="3" 443 cellspacing="0" width="100%" bgcolor="white"> 444<tr bgcolor="#70b0f0" class="table-header"> 445 <td colspan="2" class="table-header"> 446 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 447 <tr valign="top"> 448 <td align="left"><span class="table-header">Variables</span></td> 449 <td align="right" valign="top" 450 ><span class="options">[<a href="#section-Variables" 451 class="privatelink" onclick="toggle_private();" 452 >hide private</a>]</span></td> 453 </tr> 454 </table> 455 </td> 456</tr> 457<tr class="private"> 458 <td width="15%" align="right" valign="top" class="summary"> 459 <span class="summary-type"> </span> 460 </td><td class="summary"> 461 <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code> 462 </td> 463 </tr> 464<tr class="private"> 465 <td width="15%" align="right" valign="top" class="summary"> 466 <span class="summary-type"> </span> 467 </td><td class="summary"> 468 <a name="URITEMPLATE"></a><span class="summary-name">URITEMPLATE</span> = <code title="re.compile('{[^}]*}')">re.compile('{[^}]*}')</code> 469 </td> 470 </tr> 471<tr class="private"> 472 <td width="15%" align="right" valign="top" class="summary"> 473 <span class="summary-type"> </span> 474 </td><td class="summary"> 475 <a name="VARNAME"></a><span class="summary-name">VARNAME</span> = <code title="re.compile('[a-zA-Z0-9_-]+')">re.compile('[a-zA-Z0-9_-]+')</code> 476 </td> 477 </tr> 478<tr class="private"> 479 <td width="15%" align="right" valign="top" class="summary"> 480 <span class="summary-type"> </span> 481 </td><td class="summary"> 482 <a href="googleapiclient.discovery-module.html#DISCOVERY_URI" class="summary-name" onclick="show_private();">DISCOVERY_URI</a> = <code title="'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re\ 483st'">'https://www.googleapis.com/discovery/v1/apis/<code class="variable-ellipsis">...</code></code> 484 </td> 485 </tr> 486<tr class="private"> 487 <td width="15%" align="right" valign="top" class="summary"> 488 <span class="summary-type"> </span> 489 </td><td class="summary"> 490 <a href="googleapiclient.discovery-module.html#V1_DISCOVERY_URI" class="summary-name" onclick="show_private();">V1_DISCOVERY_URI</a> = <code title="'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re\ 491st'">'https://www.googleapis.com/discovery/v1/ap<code class="variable-ellipsis">...</code></code> 492 </td> 493 </tr> 494<tr class="private"> 495 <td width="15%" align="right" valign="top" class="summary"> 496 <span class="summary-type"> </span> 497 </td><td class="summary"> 498 <a href="googleapiclient.discovery-module.html#V2_DISCOVERY_URI" class="summary-name" onclick="show_private();">V2_DISCOVERY_URI</a> = <code title="'https://{api}.googleapis.com/$discovery/rest?' 'version={apiVersion}'">'https://{api}.googleapis.com/$discovery/re<code class="variable-ellipsis">...</code></code> 499 </td> 500 </tr> 501<tr class="private"> 502 <td width="15%" align="right" valign="top" class="summary"> 503 <span class="summary-type"> </span> 504 </td><td class="summary"> 505 <a name="DEFAULT_METHOD_DOC"></a><span class="summary-name">DEFAULT_METHOD_DOC</span> = <code title="'A description of how to use this function'">'A description of how to use this function'</code> 506 </td> 507 </tr> 508<tr class="private"> 509 <td width="15%" align="right" valign="top" class="summary"> 510 <span class="summary-type"> </span> 511 </td><td class="summary"> 512 <a name="HTTP_PAYLOAD_METHODS"></a><span class="summary-name">HTTP_PAYLOAD_METHODS</span> = <code title="frozenset(['PUT', 'POST', 'PATCH'])">frozenset(['PUT', 'POST', 'PATCH'])</code> 513 </td> 514 </tr> 515<tr class="private"> 516 <td width="15%" align="right" valign="top" class="summary"> 517 <span class="summary-type"> </span> 518 </td><td class="summary"> 519 <a name="_MEDIA_SIZE_BIT_SHIFTS"></a><span class="summary-name">_MEDIA_SIZE_BIT_SHIFTS</span> = <code title="{'KB': 10, 'MB': 20, 'GB': 30, 'TB': 40}">{'KB': 10, 'MB': 20, 'GB': 30, 'TB': 40}</code> 520 </td> 521 </tr> 522<tr class="private"> 523 <td width="15%" align="right" valign="top" class="summary"> 524 <span class="summary-type"> </span> 525 </td><td class="summary"> 526 <a href="googleapiclient.discovery-module.html#BODY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">BODY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'description': 'The request body.', 'type': 'object', 'required': Tru\ 527e,}">{'description': 'The request bo<code class="variable-ellipsis">...</code></code> 528 </td> 529 </tr> 530<tr class="private"> 531 <td width="15%" align="right" valign="top" class="summary"> 532 <span class="summary-type"> </span> 533 </td><td class="summary"> 534 <a href="googleapiclient.discovery-module.html#MEDIA_BODY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'description':('The filename of the media request body, or an instanc\ 535e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,}">{'description':('The file<code class="variable-ellipsis">...</code></code> 536 </td> 537 </tr> 538<tr class="private"> 539 <td width="15%" align="right" valign="top" class="summary"> 540 <span class="summary-type"> </span> 541 </td><td class="summary"> 542 <a href="googleapiclient.discovery-module.html#MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE</a> = <code title="{'description':('The MIME type of the media request body, or an instan\ 543ce ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,\ 544}">{'description':('The<code class="variable-ellipsis">...</code></code> 545 </td> 546 </tr> 547<tr class="private"> 548 <td width="15%" align="right" valign="top" class="summary"> 549 <span class="summary-type"> </span> 550 </td><td class="summary"> 551 <a name="_PAGE_TOKEN_NAMES"></a><span class="summary-name">_PAGE_TOKEN_NAMES</span> = <code title="'pageToken', 'nextPageToken'">'pageToken', 'nextPageToken'</code> 552 </td> 553 </tr> 554<tr class="private"> 555 <td width="15%" align="right" valign="top" class="summary"> 556 <span class="summary-type"> </span> 557 </td><td class="summary"> 558 <a href="googleapiclient.discovery-module.html#STACK_QUERY_PARAMETERS" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETERS</a> = <code title="frozenset(['trace', 'pp', 'userip', 'strict'])">frozenset(['trace', 'pp', 'userip', '<code class="variable-ellipsis">...</code></code> 559 </td> 560 </tr> 561<tr class="private"> 562 <td width="15%" align="right" valign="top" class="summary"> 563 <span class="summary-type"> </span> 564 </td><td class="summary"> 565 <a href="googleapiclient.discovery-module.html#STACK_QUERY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'type': 'string', 'location': 'query'}">{'type': 'string', 'loca<code class="variable-ellipsis">...</code></code> 566 </td> 567 </tr> 568<tr class="private"> 569 <td width="15%" align="right" valign="top" class="summary"> 570 <span class="summary-type"> </span> 571 </td><td class="summary"> 572 <a name="RESERVED_WORDS"></a><span class="summary-name">RESERVED_WORDS</span> = <code title="frozenset(['body'])">frozenset(['body'])</code> 573 </td> 574 </tr> 575</table> 576<!-- ==================== FUNCTION DETAILS ==================== --> 577<a name="section-FunctionDetails"></a> 578<table class="details" border="1" cellpadding="3" 579 cellspacing="0" width="100%" bgcolor="white"> 580<tr bgcolor="#70b0f0" class="table-header"> 581 <td colspan="2" class="table-header"> 582 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 583 <tr valign="top"> 584 <td align="left"><span class="table-header">Function Details</span></td> 585 <td align="right" valign="top" 586 ><span class="options">[<a href="#section-FunctionDetails" 587 class="privatelink" onclick="toggle_private();" 588 >hide private</a>]</span></td> 589 </tr> 590 </table> 591 </td> 592</tr> 593</table> 594<a name="fix_method_name"></a> 595<div> 596<table class="details" border="1" cellpadding="3" 597 cellspacing="0" width="100%" bgcolor="white"> 598<tr><td> 599 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 600 <tr valign="top"><td> 601 <h3 class="epydoc"><span class="sig"><span class="sig-name">fix_method_name</span>(<span class="sig-arg">name</span>)</span> 602 </h3> 603 </td><td align="right" valign="top" 604 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#fix_method_name">source code</a></span> 605 </td> 606 </tr></table> 607 608 <pre class="literalblock"> 609Fix method names to avoid '$' characters and reserved word conflicts. 610 611Args: 612 name: string, method name. 613 614Returns: 615 The name with '_' appended if the name is a reserved word and '$' 616 replaced with '_'. 617 618</pre> 619 <dl class="fields"> 620 </dl> 621</td></tr></table> 622</div> 623<a name="key2param"></a> 624<div> 625<table class="details" border="1" cellpadding="3" 626 cellspacing="0" width="100%" bgcolor="white"> 627<tr><td> 628 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 629 <tr valign="top"><td> 630 <h3 class="epydoc"><span class="sig"><span class="sig-name">key2param</span>(<span class="sig-arg">key</span>)</span> 631 </h3> 632 </td><td align="right" valign="top" 633 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#key2param">source code</a></span> 634 </td> 635 </tr></table> 636 637 <pre class="literalblock"> 638Converts key names into parameter names. 639 640For example, converting "max-results" -> "max_results" 641 642Args: 643 key: string, the method key name. 644 645Returns: 646 A safe method name based on the key name. 647 648</pre> 649 <dl class="fields"> 650 </dl> 651</td></tr></table> 652</div> 653<a name="build"></a> 654<div> 655<table class="details" border="1" cellpadding="3" 656 cellspacing="0" width="100%" bgcolor="white"> 657<tr><td> 658 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 659 <tr valign="top"><td> 660 <h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">serviceName</span>, 661 <span class="sig-arg">version</span>, 662 <span class="sig-arg">http</span>=<span class="sig-default">None</span>, 663 <span class="sig-arg">discoveryServiceUrl</span>=<span class="sig-default">DISCOVERY_URI</span>, 664 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>, 665 <span class="sig-arg">model</span>=<span class="sig-default">None</span>, 666 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>, 667 <span class="sig-arg">credentials</span>=<span class="sig-default">None</span>, 668 <span class="sig-arg">cache_discovery</span>=<span class="sig-default">True</span>, 669 <span class="sig-arg">cache</span>=<span class="sig-default">None</span>)</span> 670 </h3> 671 </td><td align="right" valign="top" 672 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build">source code</a></span> 673 </td> 674 </tr></table> 675 676 <pre class="literalblock"> 677Construct a Resource for interacting with an API. 678 679Construct a Resource object for interacting with an API. The serviceName and 680version are the names from the Discovery service. 681 682Args: 683 serviceName: string, name of the service. 684 version: string, the version of the service. 685 http: httplib2.Http, An instance of httplib2.Http or something that acts 686 like it that HTTP requests will be made through. 687 discoveryServiceUrl: string, a URI Template that points to the location of 688 the discovery service. It should have two parameters {api} and 689 {apiVersion} that when filled in produce an absolute URI to the discovery 690 document for that service. 691 developerKey: string, key obtained from 692 https://code.google.com/apis/console. 693 model: googleapiclient.Model, converts to and from the wire format. 694 requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP 695 request. 696 credentials: oauth2client.Credentials or 697 google.auth.credentials.Credentials, credentials to be used for 698 authentication. 699 cache_discovery: Boolean, whether or not to cache the discovery doc. 700 cache: googleapiclient.discovery_cache.base.CacheBase, an optional 701 cache object for the discovery documents. 702 703Returns: 704 A Resource object with methods for interacting with the service. 705 706</pre> 707 <dl class="fields"> 708 <dt>Decorators:</dt> 709 <dd><ul class="nomargin-top"> 710 <li><code>@positional(2)</code></li> 711 </ul></dd> 712 </dl> 713</td></tr></table> 714</div> 715<a name="_retrieve_discovery_doc"></a> 716<div class="private"> 717<table class="details" border="1" cellpadding="3" 718 cellspacing="0" width="100%" bgcolor="white"> 719<tr><td> 720 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 721 <tr valign="top"><td> 722 <h3 class="epydoc"><span class="sig"><span class="sig-name">_retrieve_discovery_doc</span>(<span class="sig-arg">url</span>, 723 <span class="sig-arg">http</span>, 724 <span class="sig-arg">cache_discovery</span>, 725 <span class="sig-arg">cache</span>=<span class="sig-default">None</span>, 726 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>)</span> 727 </h3> 728 </td><td align="right" valign="top" 729 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_retrieve_discovery_doc">source code</a></span> 730 </td> 731 </tr></table> 732 733 <pre class="literalblock"> 734Retrieves the discovery_doc from cache or the internet. 735 736Args: 737 url: string, the URL of the discovery document. 738 http: httplib2.Http, An instance of httplib2.Http or something that acts 739 like it through which HTTP requests will be made. 740 cache_discovery: Boolean, whether or not to cache the discovery doc. 741 cache: googleapiclient.discovery_cache.base.Cache, an optional cache 742 object for the discovery documents. 743 744Returns: 745 A unicode string representation of the discovery document. 746 747</pre> 748 <dl class="fields"> 749 </dl> 750</td></tr></table> 751</div> 752<a name="build_from_document"></a> 753<div> 754<table class="details" border="1" cellpadding="3" 755 cellspacing="0" width="100%" bgcolor="white"> 756<tr><td> 757 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 758 <tr valign="top"><td> 759 <h3 class="epydoc"><span class="sig"><span class="sig-name">build_from_document</span>(<span class="sig-arg">service</span>, 760 <span class="sig-arg">base</span>=<span class="sig-default">None</span>, 761 <span class="sig-arg">future</span>=<span class="sig-default">None</span>, 762 <span class="sig-arg">http</span>=<span class="sig-default">None</span>, 763 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>, 764 <span class="sig-arg">model</span>=<span class="sig-default">None</span>, 765 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>, 766 <span class="sig-arg">credentials</span>=<span class="sig-default">None</span>)</span> 767 </h3> 768 </td><td align="right" valign="top" 769 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source code</a></span> 770 </td> 771 </tr></table> 772 773 <pre class="literalblock"> 774Create a Resource for interacting with an API. 775 776Same as `build()`, but constructs the Resource object from a discovery 777document that is it given, as opposed to retrieving one over HTTP. 778 779Args: 780 service: string or object, the JSON discovery document describing the API. 781 The value passed in may either be the JSON string or the deserialized 782 JSON. 783 base: string, base URI for all HTTP requests, usually the discovery URI. 784 This parameter is no longer used as rootUrl and servicePath are included 785 within the discovery document. (deprecated) 786 future: string, discovery document with future capabilities (deprecated). 787 http: httplib2.Http, An instance of httplib2.Http or something that acts 788 like it that HTTP requests will be made through. 789 developerKey: string, Key for controlling API usage, generated 790 from the API Console. 791 model: Model class instance that serializes and de-serializes requests and 792 responses. 793 requestBuilder: Takes an http request and packages it up to be executed. 794 credentials: oauth2client.Credentials or 795 google.auth.credentials.Credentials, credentials to be used for 796 authentication. 797 798Returns: 799 A Resource object with methods for interacting with the service. 800 801</pre> 802 <dl class="fields"> 803 <dt>Decorators:</dt> 804 <dd><ul class="nomargin-top"> 805 <li><code>@positional(1)</code></li> 806 </ul></dd> 807 </dl> 808</td></tr></table> 809</div> 810<a name="_cast"></a> 811<div class="private"> 812<table class="details" border="1" cellpadding="3" 813 cellspacing="0" width="100%" bgcolor="white"> 814<tr><td> 815 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 816 <tr valign="top"><td> 817 <h3 class="epydoc"><span class="sig"><span class="sig-name">_cast</span>(<span class="sig-arg">value</span>, 818 <span class="sig-arg">schema_type</span>)</span> 819 </h3> 820 </td><td align="right" valign="top" 821 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_cast">source code</a></span> 822 </td> 823 </tr></table> 824 825 <pre class="literalblock"> 826Convert value to a string based on JSON Schema type. 827 828See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on 829JSON Schema. 830 831Args: 832 value: any, the value to convert 833 schema_type: string, the type that value should be interpreted as 834 835Returns: 836 A string representation of 'value' based on the schema_type. 837 838</pre> 839 <dl class="fields"> 840 </dl> 841</td></tr></table> 842</div> 843<a name="_media_size_to_long"></a> 844<div class="private"> 845<table class="details" border="1" cellpadding="3" 846 cellspacing="0" width="100%" bgcolor="white"> 847<tr><td> 848 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 849 <tr valign="top"><td> 850 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_size_to_long</span>(<span class="sig-arg">maxSize</span>)</span> 851 </h3> 852 </td><td align="right" valign="top" 853 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_size_to_long">source code</a></span> 854 </td> 855 </tr></table> 856 857 <pre class="literalblock"> 858Convert a string media size, such as 10GB or 3TB into an integer. 859 860Args: 861 maxSize: string, size as a string, such as 2MB or 7GB. 862 863Returns: 864 The size as an integer value. 865 866</pre> 867 <dl class="fields"> 868 </dl> 869</td></tr></table> 870</div> 871<a name="_media_path_url_from_info"></a> 872<div class="private"> 873<table class="details" border="1" cellpadding="3" 874 cellspacing="0" width="100%" bgcolor="white"> 875<tr><td> 876 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 877 <tr valign="top"><td> 878 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_path_url_from_info</span>(<span class="sig-arg">root_desc</span>, 879 <span class="sig-arg">path_url</span>)</span> 880 </h3> 881 </td><td align="right" valign="top" 882 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_path_url_from_info">source code</a></span> 883 </td> 884 </tr></table> 885 886 <pre class="literalblock"> 887Creates an absolute media path URL. 888 889Constructed using the API root URI and service path from the discovery 890document and the relative path for the API method. 891 892Args: 893 root_desc: Dictionary; the entire original deserialized discovery document. 894 path_url: String; the relative URL for the API method. Relative to the API 895 root, which is specified in the discovery document. 896 897Returns: 898 String; the absolute URI for media upload for the API method. 899 900</pre> 901 <dl class="fields"> 902 </dl> 903</td></tr></table> 904</div> 905<a name="_fix_up_parameters"></a> 906<div class="private"> 907<table class="details" border="1" cellpadding="3" 908 cellspacing="0" width="100%" bgcolor="white"> 909<tr><td> 910 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 911 <tr valign="top"><td> 912 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_parameters</span>(<span class="sig-arg">method_desc</span>, 913 <span class="sig-arg">root_desc</span>, 914 <span class="sig-arg">http_method</span>, 915 <span class="sig-arg">schema</span>)</span> 916 </h3> 917 </td><td align="right" valign="top" 918 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_parameters">source code</a></span> 919 </td> 920 </tr></table> 921 922 <pre class="literalblock"> 923Updates parameters of an API method with values specific to this library. 924 925Specifically, adds whatever global parameters are specified by the API to the 926parameters for the individual method. Also adds parameters which don't 927appear in the discovery document, but are available to all discovery based 928APIs (these are listed in STACK_QUERY_PARAMETERS). 929 930SIDE EFFECTS: This updates the parameters dictionary object in the method 931description. 932 933Args: 934 method_desc: Dictionary with metadata describing an API method. Value comes 935 from the dictionary of methods stored in the 'methods' key in the 936 deserialized discovery document. 937 root_desc: Dictionary; the entire original deserialized discovery document. 938 http_method: String; the HTTP method used to call the API method described 939 in method_desc. 940 schema: Object, mapping of schema names to schema descriptions. 941 942Returns: 943 The updated Dictionary stored in the 'parameters' key of the method 944 description dictionary. 945 946</pre> 947 <dl class="fields"> 948 </dl> 949</td></tr></table> 950</div> 951<a name="_fix_up_media_upload"></a> 952<div class="private"> 953<table class="details" border="1" cellpadding="3" 954 cellspacing="0" width="100%" bgcolor="white"> 955<tr><td> 956 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 957 <tr valign="top"><td> 958 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_media_upload</span>(<span class="sig-arg">method_desc</span>, 959 <span class="sig-arg">root_desc</span>, 960 <span class="sig-arg">path_url</span>, 961 <span class="sig-arg">parameters</span>)</span> 962 </h3> 963 </td><td align="right" valign="top" 964 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_media_upload">source code</a></span> 965 </td> 966 </tr></table> 967 968 <pre class="literalblock"> 969Adds 'media_body' and 'media_mime_type' parameters if supported by method. 970 971SIDE EFFECTS: If the method supports media upload and has a required body, 972sets body to be optional (required=False) instead. Also, if there is a 973'mediaUpload' in the method description, adds 'media_upload' key to 974parameters. 975 976Args: 977 method_desc: Dictionary with metadata describing an API method. Value comes 978 from the dictionary of methods stored in the 'methods' key in the 979 deserialized discovery document. 980 root_desc: Dictionary; the entire original deserialized discovery document. 981 path_url: String; the relative URL for the API method. Relative to the API 982 root, which is specified in the discovery document. 983 parameters: A dictionary describing method parameters for method described 984 in method_desc. 985 986Returns: 987 Triple (accept, max_size, media_path_url) where: 988 - accept is a list of strings representing what content types are 989 accepted for media upload. Defaults to empty list if not in the 990 discovery document. 991 - max_size is a long representing the max size in bytes allowed for a 992 media upload. Defaults to 0L if not in the discovery document. 993 - media_path_url is a String; the absolute URI for media upload for the 994 API method. Constructed using the API root URI and service path from 995 the discovery document and the relative path for the API method. If 996 media upload is not supported, this is None. 997 998</pre> 999 <dl class="fields"> 1000 </dl> 1001</td></tr></table> 1002</div> 1003<a name="_fix_up_method_description"></a> 1004<div class="private"> 1005<table class="details" border="1" cellpadding="3" 1006 cellspacing="0" width="100%" bgcolor="white"> 1007<tr><td> 1008 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 1009 <tr valign="top"><td> 1010 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_method_description</span>(<span class="sig-arg">method_desc</span>, 1011 <span class="sig-arg">root_desc</span>, 1012 <span class="sig-arg">schema</span>)</span> 1013 </h3> 1014 </td><td align="right" valign="top" 1015 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_method_description">source code</a></span> 1016 </td> 1017 </tr></table> 1018 1019 <pre class="literalblock"> 1020Updates a method description in a discovery document. 1021 1022SIDE EFFECTS: Changes the parameters dictionary in the method description with 1023extra parameters which are used locally. 1024 1025Args: 1026 method_desc: Dictionary with metadata describing an API method. Value comes 1027 from the dictionary of methods stored in the 'methods' key in the 1028 deserialized discovery document. 1029 root_desc: Dictionary; the entire original deserialized discovery document. 1030 schema: Object, mapping of schema names to schema descriptions. 1031 1032Returns: 1033 Tuple (path_url, http_method, method_id, accept, max_size, media_path_url) 1034 where: 1035 - path_url is a String; the relative URL for the API method. Relative to 1036 the API root, which is specified in the discovery document. 1037 - http_method is a String; the HTTP method used to call the API method 1038 described in the method description. 1039 - method_id is a String; the name of the RPC method associated with the 1040 API method, and is in the method description in the 'id' key. 1041 - accept is a list of strings representing what content types are 1042 accepted for media upload. Defaults to empty list if not in the 1043 discovery document. 1044 - max_size is a long representing the max size in bytes allowed for a 1045 media upload. Defaults to 0L if not in the discovery document. 1046 - media_path_url is a String; the absolute URI for media upload for the 1047 API method. Constructed using the API root URI and service path from 1048 the discovery document and the relative path for the API method. If 1049 media upload is not supported, this is None. 1050 1051</pre> 1052 <dl class="fields"> 1053 </dl> 1054</td></tr></table> 1055</div> 1056<a name="createMethod"></a> 1057<div class="private"> 1058<table class="details" border="1" cellpadding="3" 1059 cellspacing="0" width="100%" bgcolor="white"> 1060<tr><td> 1061 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 1062 <tr valign="top"><td> 1063 <h3 class="epydoc"><span class="sig"><span class="sig-name">createMethod</span>(<span class="sig-arg">methodName</span>, 1064 <span class="sig-arg">methodDesc</span>, 1065 <span class="sig-arg">rootDesc</span>, 1066 <span class="sig-arg">schema</span>)</span> 1067 </h3> 1068 </td><td align="right" valign="top" 1069 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createMethod">source code</a></span> 1070 </td> 1071 </tr></table> 1072 1073 <pre class="literalblock"> 1074Creates a method for attaching to a Resource. 1075 1076Args: 1077 methodName: string, name of the method to use. 1078 methodDesc: object, fragment of deserialized discovery document that 1079 describes the method. 1080 rootDesc: object, the entire deserialized discovery document. 1081 schema: object, mapping of schema names to schema descriptions. 1082 1083</pre> 1084 <dl class="fields"> 1085 </dl> 1086</td></tr></table> 1087</div> 1088<a name="createNextMethod"></a> 1089<div class="private"> 1090<table class="details" border="1" cellpadding="3" 1091 cellspacing="0" width="100%" bgcolor="white"> 1092<tr><td> 1093 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 1094 <tr valign="top"><td> 1095 <h3 class="epydoc"><span class="sig"><span class="sig-name">createNextMethod</span>(<span class="sig-arg">methodName</span>, 1096 <span class="sig-arg">pageTokenName</span>=<span class="sig-default">'pageToken'</span>, 1097 <span class="sig-arg">nextPageTokenName</span>=<span class="sig-default">'nextPageToken'</span>, 1098 <span class="sig-arg">isPageTokenParameter</span>=<span class="sig-default">True</span>)</span> 1099 </h3> 1100 </td><td align="right" valign="top" 1101 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createNextMethod">source code</a></span> 1102 </td> 1103 </tr></table> 1104 1105 <pre class="literalblock"> 1106Creates any _next methods for attaching to a Resource. 1107 1108The _next methods allow for easy iteration through list() responses. 1109 1110Args: 1111 methodName: string, name of the method to use. 1112 pageTokenName: string, name of request page token field. 1113 nextPageTokenName: string, name of response page token field. 1114 isPageTokenParameter: Boolean, True if request page token is a query 1115 parameter, False if request page token is a field of the request body. 1116 1117</pre> 1118 <dl class="fields"> 1119 </dl> 1120</td></tr></table> 1121</div> 1122<a name="_findPageTokenName"></a> 1123<div class="private"> 1124<table class="details" border="1" cellpadding="3" 1125 cellspacing="0" width="100%" bgcolor="white"> 1126<tr><td> 1127 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 1128 <tr valign="top"><td> 1129 <h3 class="epydoc"><span class="sig"><span class="sig-name">_findPageTokenName</span>(<span class="sig-arg">fields</span>)</span> 1130 </h3> 1131 </td><td align="right" valign="top" 1132 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_findPageTokenName">source code</a></span> 1133 </td> 1134 </tr></table> 1135 1136 <pre class="literalblock"> 1137Search field names for one like a page token. 1138 1139Args: 1140 fields: container of string, names of fields. 1141 1142Returns: 1143 First name that is either 'pageToken' or 'nextPageToken' if one exists, 1144 otherwise None. 1145 1146</pre> 1147 <dl class="fields"> 1148 </dl> 1149</td></tr></table> 1150</div> 1151<a name="_methodProperties"></a> 1152<div class="private"> 1153<table class="details" border="1" cellpadding="3" 1154 cellspacing="0" width="100%" bgcolor="white"> 1155<tr><td> 1156 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 1157 <tr valign="top"><td> 1158 <h3 class="epydoc"><span class="sig"><span class="sig-name">_methodProperties</span>(<span class="sig-arg">methodDesc</span>, 1159 <span class="sig-arg">schema</span>, 1160 <span class="sig-arg">name</span>)</span> 1161 </h3> 1162 </td><td align="right" valign="top" 1163 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_methodProperties">source code</a></span> 1164 </td> 1165 </tr></table> 1166 1167 <pre class="literalblock"> 1168Get properties of a field in a method description. 1169 1170Args: 1171 methodDesc: object, fragment of deserialized discovery document that 1172 describes the method. 1173 schema: object, mapping of schema names to schema descriptions. 1174 name: string, name of top-level field in method description. 1175 1176Returns: 1177 Object representing fragment of deserialized discovery document 1178 corresponding to 'properties' field of object corresponding to named field 1179 in method description, if it exists, otherwise empty dict. 1180 1181</pre> 1182 <dl class="fields"> 1183 </dl> 1184</td></tr></table> 1185</div> 1186<br /> 1187<!-- ==================== VARIABLES DETAILS ==================== --> 1188<a name="section-VariablesDetails"></a> 1189<table class="details" border="1" cellpadding="3" 1190 cellspacing="0" width="100%" bgcolor="white"> 1191<tr bgcolor="#70b0f0" class="table-header"> 1192 <td colspan="2" class="table-header"> 1193 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 1194 <tr valign="top"> 1195 <td align="left"><span class="table-header">Variables Details</span></td> 1196 <td align="right" valign="top" 1197 ><span class="options">[<a href="#section-VariablesDetails" 1198 class="privatelink" onclick="toggle_private();" 1199 >hide private</a>]</span></td> 1200 </tr> 1201 </table> 1202 </td> 1203</tr> 1204</table> 1205<a name="DISCOVERY_URI"></a> 1206<div class="private"> 1207<table class="details" border="1" cellpadding="3" 1208 cellspacing="0" width="100%" bgcolor="white"> 1209<tr><td> 1210 <h3 class="epydoc">DISCOVERY_URI</h3> 1211 1212 <dl class="fields"> 1213 </dl> 1214 <dl class="fields"> 1215 <dt>Value:</dt> 1216 <dd><table><tr><td><pre class="variable"> 1217'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> 1218st' 1219</pre></td></tr></table> 1220</dd> 1221 </dl> 1222</td></tr></table> 1223</div> 1224<a name="V1_DISCOVERY_URI"></a> 1225<div class="private"> 1226<table class="details" border="1" cellpadding="3" 1227 cellspacing="0" width="100%" bgcolor="white"> 1228<tr><td> 1229 <h3 class="epydoc">V1_DISCOVERY_URI</h3> 1230 1231 <dl class="fields"> 1232 </dl> 1233 <dl class="fields"> 1234 <dt>Value:</dt> 1235 <dd><table><tr><td><pre class="variable"> 1236'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> 1237st' 1238</pre></td></tr></table> 1239</dd> 1240 </dl> 1241</td></tr></table> 1242</div> 1243<a name="V2_DISCOVERY_URI"></a> 1244<div class="private"> 1245<table class="details" border="1" cellpadding="3" 1246 cellspacing="0" width="100%" bgcolor="white"> 1247<tr><td> 1248 <h3 class="epydoc">V2_DISCOVERY_URI</h3> 1249 1250 <dl class="fields"> 1251 </dl> 1252 <dl class="fields"> 1253 <dt>Value:</dt> 1254 <dd><table><tr><td><pre class="variable"> 1255'https://{api}.googleapis.com/$discovery/rest?' 'version={apiVersion}' 1256</pre></td></tr></table> 1257</dd> 1258 </dl> 1259</td></tr></table> 1260</div> 1261<a name="BODY_PARAMETER_DEFAULT_VALUE"></a> 1262<div class="private"> 1263<table class="details" border="1" cellpadding="3" 1264 cellspacing="0" width="100%" bgcolor="white"> 1265<tr><td> 1266 <h3 class="epydoc">BODY_PARAMETER_DEFAULT_VALUE</h3> 1267 1268 <dl class="fields"> 1269 </dl> 1270 <dl class="fields"> 1271 <dt>Value:</dt> 1272 <dd><table><tr><td><pre class="variable"> 1273{'description': 'The request body.', 'type': 'object', 'required': Tru<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> 1274e,} 1275</pre></td></tr></table> 1276</dd> 1277 </dl> 1278</td></tr></table> 1279</div> 1280<a name="MEDIA_BODY_PARAMETER_DEFAULT_VALUE"></a> 1281<div class="private"> 1282<table class="details" border="1" cellpadding="3" 1283 cellspacing="0" width="100%" bgcolor="white"> 1284<tr><td> 1285 <h3 class="epydoc">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</h3> 1286 1287 <dl class="fields"> 1288 </dl> 1289 <dl class="fields"> 1290 <dt>Value:</dt> 1291 <dd><table><tr><td><pre class="variable"> 1292{'description':('The filename of the media request body, or an instanc<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> 1293e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,} 1294</pre></td></tr></table> 1295</dd> 1296 </dl> 1297</td></tr></table> 1298</div> 1299<a name="MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE"></a> 1300<div class="private"> 1301<table class="details" border="1" cellpadding="3" 1302 cellspacing="0" width="100%" bgcolor="white"> 1303<tr><td> 1304 <h3 class="epydoc">MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE</h3> 1305 1306 <dl class="fields"> 1307 </dl> 1308 <dl class="fields"> 1309 <dt>Value:</dt> 1310 <dd><table><tr><td><pre class="variable"> 1311{'description':('The MIME type of the media request body, or an instan<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> 1312ce ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> 1313} 1314</pre></td></tr></table> 1315</dd> 1316 </dl> 1317</td></tr></table> 1318</div> 1319<a name="STACK_QUERY_PARAMETERS"></a> 1320<div class="private"> 1321<table class="details" border="1" cellpadding="3" 1322 cellspacing="0" width="100%" bgcolor="white"> 1323<tr><td> 1324 <h3 class="epydoc">STACK_QUERY_PARAMETERS</h3> 1325 1326 <dl class="fields"> 1327 </dl> 1328 <dl class="fields"> 1329 <dt>Value:</dt> 1330 <dd><table><tr><td><pre class="variable"> 1331frozenset(['trace', 'pp', 'userip', 'strict']) 1332</pre></td></tr></table> 1333</dd> 1334 </dl> 1335</td></tr></table> 1336</div> 1337<a name="STACK_QUERY_PARAMETER_DEFAULT_VALUE"></a> 1338<div class="private"> 1339<table class="details" border="1" cellpadding="3" 1340 cellspacing="0" width="100%" bgcolor="white"> 1341<tr><td> 1342 <h3 class="epydoc">STACK_QUERY_PARAMETER_DEFAULT_VALUE</h3> 1343 1344 <dl class="fields"> 1345 </dl> 1346 <dl class="fields"> 1347 <dt>Value:</dt> 1348 <dd><table><tr><td><pre class="variable"> 1349{'type': 'string', 'location': 'query'} 1350</pre></td></tr></table> 1351</dd> 1352 </dl> 1353</td></tr></table> 1354</div> 1355<br /> 1356<!-- ==================== NAVIGATION BAR ==================== --> 1357<table class="navbar" border="0" width="100%" cellpadding="0" 1358 bgcolor="#a0c0ff" cellspacing="0"> 1359 <tr valign="middle"> 1360 <!-- Home link --> 1361 <th> <a 1362 href="googleapiclient-module.html">Home</a> </th> 1363 1364 <!-- Tree link --> 1365 <th> <a 1366 href="module-tree.html">Trees</a> </th> 1367 1368 <!-- Index link --> 1369 <th> <a 1370 href="identifier-index.html">Indices</a> </th> 1371 1372 <!-- Help link --> 1373 <th> <a 1374 href="help.html">Help</a> </th> 1375 1376 <th class="navbar" width="100%"></th> 1377 </tr> 1378</table> 1379<table border="0" cellpadding="0" cellspacing="0" width="100%%"> 1380 <tr> 1381 <td align="left" class="footer"> 1382 Generated by Epydoc 3.0.1 on Fri Jun 14 15:57:27 2019 1383 </td> 1384 <td align="right" class="footer"> 1385 <a target="mainFrame" href="http://epydoc.sourceforge.net" 1386 >http://epydoc.sourceforge.net</a> 1387 </td> 1388 </tr> 1389</table> 1390 1391<script type="text/javascript"> 1392 <!-- 1393 // Private objects are initially displayed (because if 1394 // javascript is turned off then we want them to be 1395 // visible); but by default, we want to hide them. So hide 1396 // them unless we have a cookie that says to show them. 1397 checkCookie(); 1398 // --> 1399</script> 1400</body> 1401</html> 1402
