imported patch docs
This commit is contained in:
Joe Gregorio
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.discovery</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient-release/apiclient/discovery.py">/home/jcgregorio/projects/apiclient-release/apiclient/discovery.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/clean/apiclient/discovery.py">/home/jcgregorio/projects/clean/apiclient/discovery.py</a></font></td></tr></table>
|
||||
<p><tt>Client for discovery based APIs<br>
|
||||
<br>
|
||||
A client library for Google's discovery based APIs.</tt></p>
|
||||
@@ -40,51 +40,35 @@ A client library for Google's discovery based 
|
||||
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><dl><dt><a name="-build"><strong>build</strong></a>(serviceName, version, http<font color="#909090">=None</font>, discoveryServiceUrl<font color="#909090">='https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersion}/rest'</font>, developerKey<font color="#909090">=None</font>, model<font color="#909090">=None</font>, requestBuilder<font color="#909090">=<class 'apiclient.http.HttpRequest'></font>)</dt><dd><tt>Construct a Resource for interacting with an API.<br>
|
||||
<br>
|
||||
Construct a Resource object for interacting with<br>
|
||||
an API. The serviceName and version are the<br>
|
||||
names from the Discovery service.<br>
|
||||
Construct a Resource object for interacting with an API. The serviceName and<br>
|
||||
version are the names from the Discovery service.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
serviceName: string, name of the service<br>
|
||||
version: string, the version of the service<br>
|
||||
serviceName: string, name of the service.<br>
|
||||
version: string, the version of the service.<br>
|
||||
http: httplib2.Http, An instance of httplib2.Http or something that acts<br>
|
||||
like it that HTTP requests will be made through.<br>
|
||||
discoveryServiceUrl: string, a URI Template that points to<br>
|
||||
the location of the discovery service. It should have two<br>
|
||||
parameters {api} and {apiVersion} that when filled in<br>
|
||||
produce an absolute URI to the discovery document for<br>
|
||||
that service.<br>
|
||||
developerKey: string, key obtained<br>
|
||||
from https://code.google.com/apis/console<br>
|
||||
model: apiclient.Model, converts to and from the wire format<br>
|
||||
requestBuilder: apiclient.http.HttpRequest, encapsulator for<br>
|
||||
an HTTP request<br>
|
||||
discoveryServiceUrl: string, a URI Template that points to the location of<br>
|
||||
the discovery service. It should have two parameters {api} and<br>
|
||||
{apiVersion} that when filled in produce an absolute URI to the discovery<br>
|
||||
document for that service.<br>
|
||||
developerKey: string, key obtained from<br>
|
||||
https://code.google.com/apis/console.<br>
|
||||
model: apiclient.Model, converts to and from the wire format.<br>
|
||||
requestBuilder: apiclient.http.HttpRequest, encapsulator for an HTTP<br>
|
||||
request.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A Resource object with methods for interacting with<br>
|
||||
the service.</tt></dd></dl>
|
||||
<dl><dt><a name="-build_from_document"><strong>build_from_document</strong></a>(service, base, future<font color="#909090">=None</font>, http<font color="#909090">=None</font>, developerKey<font color="#909090">=None</font>, model<font color="#909090">=None</font>, requestBuilder<font color="#909090">=<class 'apiclient.http.HttpRequest'></font>)</dt><dd><tt>Create a Resource for interacting with an API.<br>
|
||||
A Resource object with methods for interacting with the service.</tt></dd></dl>
|
||||
<dl><dt><a name="-key2param"><strong>key2param</strong></a>(key)</dt><dd><tt>Converts key names into parameter names.<br>
|
||||
<br>
|
||||
Same as `<a href="#-build">build</a>()`, but constructs the Resource object<br>
|
||||
from a discovery document that is it given, as opposed to<br>
|
||||
retrieving one over HTTP.<br>
|
||||
For example, converting "max-results" -> "max_results"<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
service: string, discovery document<br>
|
||||
base: string, base URI for all HTTP requests, usually the discovery URI<br>
|
||||
future: string, discovery document with future capabilities<br>
|
||||
auth_discovery: dict, information about the authentication the API supports<br>
|
||||
http: httplib2.Http, An instance of httplib2.Http or something that acts<br>
|
||||
like it that HTTP requests will be made through.<br>
|
||||
developerKey: string, Key for controlling API usage, generated<br>
|
||||
from the API Console.<br>
|
||||
model: Model class instance that serializes and<br>
|
||||
de-serializes requests and responses.<br>
|
||||
requestBuilder: Takes an http request and packages it up to be executed.<br>
|
||||
key: string, the method key name.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A Resource object with methods for interacting with<br>
|
||||
the service.</tt></dd></dl>
|
||||
A safe method name based on the key name.</tt></dd></dl>
|
||||
</td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#55aa55">
|
||||
@@ -92,7 +76,7 @@ Returns:<br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><strong>__all__</strong> = ['build', 'build_from_document']<br>
|
||||
<td width="100%"><strong>__all__</strong> = ['build', 'build_from_documentfix_method_name', 'key2param']<br>
|
||||
<strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#7799ee">
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.errors</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient-release/apiclient/errors.py">/home/jcgregorio/projects/apiclient-release/apiclient/errors.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/clean/apiclient/errors.py">/home/jcgregorio/projects/clean/apiclient/errors.py</a></font></td></tr></table>
|
||||
<p><tt>Errors for the library.<br>
|
||||
<br>
|
||||
All exceptions defined by the library<br>
|
||||
|
||||
21
docs/apiclient.ext.html
Normal file
21
docs/apiclient.ext.html
Normal file
@@ -0,0 +1,21 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: package apiclient.ext</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||
<tr bgcolor="#7799ee">
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.ext</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/clean/apiclient/ext/__init__.py">/home/jcgregorio/projects/clean/apiclient/ext/__init__.py</a></font></td></tr></table>
|
||||
<p></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#aa55cc">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>
|
||||
</body></html>
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>apiclient</strong></big></big> (version 1.0b9)</font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient-release/apiclient/__init__.py">/home/jcgregorio/projects/apiclient-release/apiclient/__init__.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/clean/apiclient/__init__.py">/home/jcgregorio/projects/clean/apiclient/__init__.py</a></font></td></tr></table>
|
||||
<p></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
@@ -17,15 +17,12 @@
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="apiclient.anyjson.html">anyjson</a><br>
|
||||
<a href="apiclient.contrib.html"><strong>contrib</strong> (package)</a><br>
|
||||
<a href="apiclient.discovery.html">discovery</a><br>
|
||||
</td><td width="25%" valign=top><a href="apiclient.errors.html">errors</a><br>
|
||||
<a href="apiclient.ext.html"><strong>ext</strong> (package)</a><br>
|
||||
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="apiclient.discovery.html">discovery</a><br>
|
||||
<a href="apiclient.errors.html">errors</a><br>
|
||||
</td><td width="25%" valign=top><a href="apiclient.ext.html"><strong>ext</strong> (package)</a><br>
|
||||
<a href="apiclient.http.html">http</a><br>
|
||||
</td><td width="25%" valign=top><a href="apiclient.mimeparse.html">mimeparse</a><br>
|
||||
<a href="apiclient.model.html">model</a><br>
|
||||
<a href="apiclient.oauth.html">oauth</a><br>
|
||||
</td><td width="25%" valign=top><a href="apiclient.schema.html">schema</a><br>
|
||||
</td></tr></table></td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.http</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient-release/apiclient/http.py">/home/jcgregorio/projects/apiclient-release/apiclient/http.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/clean/apiclient/http.py">/home/jcgregorio/projects/clean/apiclient/http.py</a></font></td></tr></table>
|
||||
<p><tt>Classes to encapsulate a single HTTP request.<br>
|
||||
<br>
|
||||
The classes implement a command pattern, with every<br>
|
||||
@@ -54,6 +54,7 @@ actuall HTTP request.</tt></p>
|
||||
<dl>
|
||||
<dt><font face="helvetica, arial"><a href="apiclient.http.html#MediaFileUpload">MediaFileUpload</a>
|
||||
</font></dt><dt><font face="helvetica, arial"><a href="apiclient.http.html#MediaInMemoryUpload">MediaInMemoryUpload</a>
|
||||
</font></dt><dt><font face="helvetica, arial"><a href="apiclient.http.html#MediaIoBaseUpload">MediaIoBaseUpload</a>
|
||||
</font></dt></dl>
|
||||
</dd>
|
||||
<dt><font face="helvetica, arial"><a href="apiclient.http.html#MediaUploadProgress">MediaUploadProgress</a>
|
||||
@@ -254,7 +255,11 @@ Example:<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
(status, body): (ResumableMediaStatus, <a href="__builtin__.html#object">object</a>)<br>
|
||||
The body will be None until the resumable media is fully uploaded.</tt></dd></dl>
|
||||
The body will be None until the resumable media is fully uploaded.<br>
|
||||
<br>
|
||||
Raises:<br>
|
||||
apiclient.errors.HttpError if the response was not a 2xx.<br>
|
||||
httplib2.Error if a transport error has occured.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="HttpRequest-to_json"><strong>to_json</strong></a>(self)</dt><dd><tt>Returns a JSON representation of the <a href="#HttpRequest">HttpRequest</a>.</tt></dd></dl>
|
||||
|
||||
@@ -316,8 +321,8 @@ Construct a <a href="#MediaFileUpload">MediaFileUpload</a> and&nb
|
||||
method. For example, if we had a service that allowed uploading images:<br>
|
||||
<br>
|
||||
<br>
|
||||
media = <a href="#MediaFileUpload">MediaFileUpload</a>('smiley.png', mimetype='image/png', chunksize=1000,<br>
|
||||
resumable=True)<br>
|
||||
media = <a href="#MediaFileUpload">MediaFileUpload</a>('smiley.png', mimetype='image/png',<br>
|
||||
chunksize=1024*1024, resumable=True)<br>
|
||||
service.objects().insert(<br>
|
||||
bucket=buckets['items'][0]['id'],<br>
|
||||
name='smiley.png',<br>
|
||||
@@ -330,7 +335,7 @@ method. For example, if we had a service 
|
||||
</dl>
|
||||
<hr>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="MediaFileUpload-__init__"><strong>__init__</strong></a>(self, filename, mimetype<font color="#909090">=None</font>, chunksize<font color="#909090">=262144</font>, resumable<font color="#909090">=False</font>)</dt><dd><tt>Constructor.<br>
|
||||
<dl><dt><a name="MediaFileUpload-__init__"><strong>__init__</strong></a>(self, filename, mimetype<font color="#909090">=None</font>, chunksize<font color="#909090">=524288</font>, resumable<font color="#909090">=False</font>)</dt><dd><tt>Constructor.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
filename: string, Name of the file.<br>
|
||||
@@ -341,7 +346,10 @@ Args:<br>
|
||||
resumable: bool, True if this is a resumable upload. False means upload<br>
|
||||
in a single request.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaFileUpload-chunksize"><strong>chunksize</strong></a>(self)</dt></dl>
|
||||
<dl><dt><a name="MediaFileUpload-chunksize"><strong>chunksize</strong></a>(self)</dt><dd><tt>Chunk size for resumable uploads.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Chunk size in bytes.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaFileUpload-getbytes"><strong>getbytes</strong></a>(self, begin, length)</dt><dd><tt>Get bytes from the media.<br>
|
||||
<br>
|
||||
@@ -353,11 +361,20 @@ Returns:<br>
|
||||
A string of bytes read. May be shorted than length if EOF was reached<br>
|
||||
first.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaFileUpload-mimetype"><strong>mimetype</strong></a>(self)</dt></dl>
|
||||
<dl><dt><a name="MediaFileUpload-mimetype"><strong>mimetype</strong></a>(self)</dt><dd><tt>Mime type of the body.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Mime type.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaFileUpload-resumable"><strong>resumable</strong></a>(self)</dt></dl>
|
||||
<dl><dt><a name="MediaFileUpload-resumable"><strong>resumable</strong></a>(self)</dt><dd><tt>Whether this upload is resumable.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
True if resumable upload or False.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaFileUpload-size"><strong>size</strong></a>(self)</dt></dl>
|
||||
<dl><dt><a name="MediaFileUpload-size"><strong>size</strong></a>(self)</dt><dd><tt>Size of upload.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Size of the body, or None of the size is unknown.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaFileUpload-to_json"><strong>to_json</strong></a>(self)</dt><dd><tt>Creating a JSON representation of an instance of Credentials.<br>
|
||||
<br>
|
||||
@@ -408,7 +425,7 @@ method. For example, if we had a service 
|
||||
</dl>
|
||||
<hr>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="MediaInMemoryUpload-__init__"><strong>__init__</strong></a>(self, body, mimetype<font color="#909090">='application/octet-stream'</font>, chunksize<font color="#909090">=262144</font>, resumable<font color="#909090">=False</font>)</dt><dd><tt>Create a new MediaBytesUpload.<br>
|
||||
<dl><dt><a name="MediaInMemoryUpload-__init__"><strong>__init__</strong></a>(self, body, mimetype<font color="#909090">='application/octet-stream'</font>, chunksize<font color="#909090">=524288</font>, resumable<font color="#909090">=False</font>)</dt><dd><tt>Create a new MediaBytesUpload.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: string, Bytes of body content.<br>
|
||||
@@ -447,7 +464,7 @@ Returns:<br>
|
||||
<dl><dt><a name="MediaInMemoryUpload-size"><strong>size</strong></a>(self)</dt><dd><tt>Size of upload.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Size of the body.</tt></dd></dl>
|
||||
Size of the body, or None of the size is unknown.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaInMemoryUpload-to_json"><strong>to_json</strong></a>(self)</dt><dd><tt>Create a JSON representation of a <a href="#MediaInMemoryUpload">MediaInMemoryUpload</a>.<br>
|
||||
<br>
|
||||
@@ -471,6 +488,97 @@ Returns:<br>
|
||||
An instance of the subclass of <a href="#MediaUpload">MediaUpload</a> that was serialized with<br>
|
||||
<a href="#MediaInMemoryUpload-to_json">to_json</a>().</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table> <p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="MediaIoBaseUpload">class <strong>MediaIoBaseUpload</strong></a>(<a href="apiclient.http.html#MediaUpload">MediaUpload</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A <a href="#MediaUpload">MediaUpload</a> for a io.Base objects.<br>
|
||||
<br>
|
||||
Note that the Python file <a href="__builtin__.html#object">object</a> is compatible with io.Base and can be used<br>
|
||||
with this class also.<br>
|
||||
<br>
|
||||
<br>
|
||||
fh = io.BytesIO('...Some data to upload...')<br>
|
||||
media = <a href="#MediaIoBaseUpload">MediaIoBaseUpload</a>(fh, mimetype='image/png',<br>
|
||||
chunksize=1024*1024, resumable=True)<br>
|
||||
service.objects().insert(<br>
|
||||
bucket='a_bucket_id',<br>
|
||||
name='smiley.png',<br>
|
||||
media_body=media).execute()<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||
<dd><a href="apiclient.http.html#MediaIoBaseUpload">MediaIoBaseUpload</a></dd>
|
||||
<dd><a href="apiclient.http.html#MediaUpload">MediaUpload</a></dd>
|
||||
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="MediaIoBaseUpload-__init__"><strong>__init__</strong></a>(self, fh, mimetype, chunksize<font color="#909090">=524288</font>, resumable<font color="#909090">=False</font>)</dt><dd><tt>Constructor.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
fh: io.Base or file <a href="__builtin__.html#object">object</a>, The source of the bytes to upload.<br>
|
||||
mimetype: string, Mime-type of the file. If None then a mime-type will be<br>
|
||||
guessed from the file extension.<br>
|
||||
chunksize: int, File will be uploaded in chunks of this many bytes. Only<br>
|
||||
used if resumable=True.<br>
|
||||
resumable: bool, True if this is a resumable upload. False means upload<br>
|
||||
in a single request.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaIoBaseUpload-chunksize"><strong>chunksize</strong></a>(self)</dt><dd><tt>Chunk size for resumable uploads.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Chunk size in bytes.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaIoBaseUpload-getbytes"><strong>getbytes</strong></a>(self, begin, length)</dt><dd><tt>Get bytes from the media.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
begin: int, offset from beginning of file.<br>
|
||||
length: int, number of bytes to read, starting at begin.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A string of bytes read. May be shorted than length if EOF was reached<br>
|
||||
first.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaIoBaseUpload-mimetype"><strong>mimetype</strong></a>(self)</dt><dd><tt>Mime type of the body.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Mime type.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaIoBaseUpload-resumable"><strong>resumable</strong></a>(self)</dt><dd><tt>Whether this upload is resumable.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
True if resumable upload or False.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaIoBaseUpload-size"><strong>size</strong></a>(self)</dt><dd><tt>Size of upload.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Size of the body, or None of the size is unknown.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaIoBaseUpload-to_json"><strong>to_json</strong></a>(self)</dt><dd><tt>This upload type is not serializable.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Class methods inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:<br>
|
||||
<dl><dt><a name="MediaIoBaseUpload-new_from_json"><strong>new_from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Utility class method to instantiate a <a href="#MediaUpload">MediaUpload</a> subclass from a JSON<br>
|
||||
representation produced by <a href="#MediaIoBaseUpload-to_json">to_json</a>().<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
s: string, JSON from <a href="#MediaIoBaseUpload-to_json">to_json</a>().<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An instance of the subclass of <a href="#MediaUpload">MediaUpload</a> that was serialized with<br>
|
||||
<a href="#MediaIoBaseUpload-to_json">to_json</a>().</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
@@ -488,18 +596,45 @@ Data descriptors inherited from <a href="apiclient.http.html#MediaUpload">MediaU
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>Describes a media <a href="__builtin__.html#object">object</a> to upload.<br>
|
||||
<br>
|
||||
Base class that defines the interface of <a href="#MediaUpload">MediaUpload</a> subclasses.<br> </tt></td></tr>
|
||||
Base class that defines the interface of <a href="#MediaUpload">MediaUpload</a> subclasses.<br>
|
||||
<br>
|
||||
Note that subclasses of <a href="#MediaUpload">MediaUpload</a> may allow you to control the chunksize<br>
|
||||
when upload a media <a href="__builtin__.html#object">object</a>. It is important to keep the size of the chunk as<br>
|
||||
large as possible to keep the upload efficient. Other factors may influence<br>
|
||||
the size of the chunk you use, particularly if you are working in an<br>
|
||||
environment where individual HTTP requests may have a hardcoded time limit,<br>
|
||||
such as under certain classes of requests under Google App Engine.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="MediaUpload-chunksize"><strong>chunksize</strong></a>(self)</dt></dl>
|
||||
<dl><dt><a name="MediaUpload-chunksize"><strong>chunksize</strong></a>(self)</dt><dd><tt>Chunk size for resumable uploads.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Chunk size in bytes.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUpload-getbytes"><strong>getbytes</strong></a>(self, begin, end)</dt></dl>
|
||||
<dl><dt><a name="MediaUpload-getbytes"><strong>getbytes</strong></a>(self, begin, end)</dt><dd><tt>Get bytes from the media.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
begin: int, offset from beginning of file.<br>
|
||||
length: int, number of bytes to read, starting at begin.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A string of bytes read. May be shorter than length if EOF was reached<br>
|
||||
first.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUpload-mimetype"><strong>mimetype</strong></a>(self)</dt></dl>
|
||||
<dl><dt><a name="MediaUpload-mimetype"><strong>mimetype</strong></a>(self)</dt><dd><tt>Mime type of the body.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Mime type.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUpload-resumable"><strong>resumable</strong></a>(self)</dt></dl>
|
||||
<dl><dt><a name="MediaUpload-resumable"><strong>resumable</strong></a>(self)</dt><dd><tt>Whether this upload is resumable.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
True if resumable upload or False.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUpload-size"><strong>size</strong></a>(self)</dt></dl>
|
||||
<dl><dt><a name="MediaUpload-size"><strong>size</strong></a>(self)</dt><dd><tt>Size of upload.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
Size of the body, or None of the size is unknown.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUpload-to_json"><strong>to_json</strong></a>(self)</dt><dd><tt>Create a JSON representation of an instance of <a href="#MediaUpload">MediaUpload</a>.<br>
|
||||
<br>
|
||||
@@ -541,9 +676,14 @@ Data descriptors defined here:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
resumable_progress: int, bytes sent so far.<br>
|
||||
total_size: int, total bytes in complete upload.</tt></dd></dl>
|
||||
total_size: int, total bytes in complete upload, or None if the total<br>
|
||||
upload size isn't known ahead of time.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUploadProgress-progress"><strong>progress</strong></a>(self)</dt><dd><tt>Percent of upload completed, as a float.</tt></dd></dl>
|
||||
<dl><dt><a name="MediaUploadProgress-progress"><strong>progress</strong></a>(self)</dt><dd><tt>Percent of upload completed, as a float.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
the percentage complete as a float, returning 0.0 if the total size of<br>
|
||||
the upload is unknown.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
@@ -658,7 +798,8 @@ will result in a different signature.</tt></dd></dl>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
|
||||
<td width="100%"><strong>DEFAULT_CHUNK_SIZE</strong> = 524288<br>
|
||||
<strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#7799ee">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.mimeparse</strong></big></big> (version 0.1.3)</font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient-release/apiclient/mimeparse.py">/home/jcgregorio/projects/apiclient-release/apiclient/mimeparse.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/clean/apiclient/mimeparse.py">/home/jcgregorio/projects/clean/apiclient/mimeparse.py</a></font></td></tr></table>
|
||||
<p><tt>MIME-Type Parser<br>
|
||||
<br>
|
||||
This module provides basic functions for handling mime-types. It can handle<br>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.model</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient-release/apiclient/model.py">/home/jcgregorio/projects/apiclient-release/apiclient/model.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/clean/apiclient/model.py">/home/jcgregorio/projects/clean/apiclient/model.py</a></font></td></tr></table>
|
||||
<p><tt><a href="#Model">Model</a> objects for requests and responses.<br>
|
||||
<br>
|
||||
Each API may support one or more serializations, such<br>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.schema</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient-release/apiclient/schema.py">/home/jcgregorio/projects/apiclient-release/apiclient/schema.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/clean/apiclient/schema.py">/home/jcgregorio/projects/clean/apiclient/schema.py</a></font></td></tr></table>
|
||||
<p><tt>Schema processing for discovery based APIs<br>
|
||||
<br>
|
||||
<a href="#Schemas">Schemas</a> holds an APIs discovery schemas. It can return those schema as<br>
|
||||
|
||||
@@ -17,6 +17,10 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one account by ID.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
id: integer, The account id (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -39,6 +43,10 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the authenticated user's list of accounts.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -82,6 +90,10 @@ Args:<br>
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
id: integer, The account id (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -121,6 +133,10 @@ Args:<br>
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
id: integer, The account id (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -18,7 +18,11 @@
|
||||
<br>
|
||||
Args:<br>
|
||||
adgroupId: string, The adgroup this creative belongs to. (required)<br>
|
||||
trace: string, A parameter<br>
|
||||
pp: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
buyerCreativeId: string, The buyer-specific id for this creative. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: integer, The id for the account that will serve this creative. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -98,6 +102,10 @@ Args:<br>
|
||||
"accountId": 42, # Account id.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -136,6 +144,58 @@ Returns:<br>
|
||||
"accountId": 42, # Account id.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of the authenticated user's active creatives.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.<br>
|
||||
maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"items": [ # A list of creatives.<br>
|
||||
{<br>
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.<br>
|
||||
"adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.<br>
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.<br>
|
||||
"width": 42, # Ad width.<br>
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"kind": "adexchangebuyer#creative", # Resource type.<br>
|
||||
"height": 42, # Ad height.<br>
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.<br>
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.<br>
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.<br>
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"accountId": 42, # Account id.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adexchangebuyer#creativesList", # Resource type.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
|
||||
@@ -17,6 +17,10 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one direct deal by ID.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
id: string, The direct deal id (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -37,6 +41,10 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the authenticated user's list of direct deals.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,8 +17,12 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad clients in the specified account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
maxResults: integer, The maximum number of ad clients to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account for which to list ad clients. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -17,9 +17,13 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all custom channels which the specified ad unit belongs to.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
adClientId: string, Ad client which contains the ad unit. (required)<br>
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
adUnitId: string, Ad unit for which to list custom channels. (required)<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
|
||||
@@ -19,7 +19,11 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the specified ad unit in the specified ad client for the specified account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
adClientId: string, Ad client for which to get the ad unit. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
adUnitId: string, Ad unit to retrieve. (required)<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
@@ -42,10 +46,14 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad units in the specified ad client for the specified account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.<br>
|
||||
adClientId: string, Ad client for which to list ad units. (required)<br>
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -17,11 +17,15 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad units in the specified custom channel.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.<br>
|
||||
customChannelId: string, Custom channel for which to list ad units. (required)<br>
|
||||
adClientId: string, Ad client which contains the custom channel. (required)<br>
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -19,8 +19,12 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get the specified custom channel from the specified ad client for the specified account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
customChannelId: string, Custom channel to retrieve. (required)<br>
|
||||
adClientId: string, Ad client which contains the custom channel. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -42,9 +46,13 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all custom channels in the specified ad client for the specified account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
adClientId: string, Ad client for which to list custom channels. (required)<br>
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -23,7 +23,11 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get information about the selected AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
tree: boolean, Whether the tree of sub accounts should be returned.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account to get information about. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -41,8 +45,12 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all accounts available to this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
maxResults: integer, The maximum number of accounts to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,17 +17,21 @@
|
||||
<dl><dt><a name="Resource-generate"><strong>generate</strong></a> = method(self, **kwargs)</dt><dd><tt>Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)<br>
|
||||
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)<br>
|
||||
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)<br>
|
||||
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.<br>
|
||||
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.<br>
|
||||
metric: string, Numeric columns to include in the report. (repeated)<br>
|
||||
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.<br>
|
||||
startIndex: integer, Index of the first row of report data to return.<br>
|
||||
accountId: string, Account upon which to report. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)<br>
|
||||
trace: string, A parameter<br>
|
||||
maxResults: integer, The maximum number of rows of report data to return.<br>
|
||||
filter: string, Filters to be run on the report. (repeated)<br>
|
||||
startIndex: integer, Index of the first row of report data to return.<br>
|
||||
userip: string, A parameter<br>
|
||||
dimension: string, Dimensions to base the report on. (repeated)<br>
|
||||
accountId: string, Account upon which to report. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,9 +17,13 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all URL channels in the specified ad client for the specified account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
adClientId: string, Ad client for which to list URL channels. (required)<br>
|
||||
maxResults: integer, The maximum number of URL channels to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -17,8 +17,12 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad clients in this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
maxResults: integer, The maximum number of ad clients to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,9 +17,13 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all custom channels which the specified ad unit belongs to.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
adClientId: string, Ad client which contains the ad unit. (required)<br>
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
adUnitId: string, Ad unit for which to list custom channels. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -19,7 +19,11 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the specified ad unit in the specified ad client.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
adClientId: string, Ad client for which to get the ad unit. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
adUnitId: string, Ad unit to retrieve. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -41,10 +45,14 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad units in the specified ad client for this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.<br>
|
||||
adClientId: string, Ad client for which to list ad units. (required)<br>
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,11 +17,15 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad units in the specified custom channel.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.<br>
|
||||
customChannelId: string, Custom channel for which to list ad units. (required)<br>
|
||||
adClientId: string, Ad client which contains the custom channel. (required)<br>
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -19,8 +19,12 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get the specified custom channel from the specified ad client.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
customChannelId: string, Custom channel to retrieve. (required)<br>
|
||||
adClientId: string, Ad client which contains the custom channel. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -41,9 +45,13 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all custom channels in the specified ad client for this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
adClientId: string, Ad client for which to list custom channels. (required)<br>
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,17 +17,21 @@
|
||||
<dl><dt><a name="Resource-generate"><strong>generate</strong></a> = method(self, **kwargs)</dt><dd><tt>Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)<br>
|
||||
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)<br>
|
||||
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)<br>
|
||||
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.<br>
|
||||
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.<br>
|
||||
metric: string, Numeric columns to include in the report. (repeated)<br>
|
||||
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.<br>
|
||||
startIndex: integer, Index of the first row of report data to return.<br>
|
||||
accountId: string, Accounts upon which to report. (repeated)<br>
|
||||
pp: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)<br>
|
||||
trace: string, A parameter<br>
|
||||
maxResults: integer, The maximum number of rows of report data to return.<br>
|
||||
filter: string, Filters to be run on the report. (repeated)<br>
|
||||
startIndex: integer, Index of the first row of report data to return.<br>
|
||||
userip: string, A parameter<br>
|
||||
dimension: string, Dimensions to base the report on. (repeated)<br>
|
||||
accountId: string, Accounts upon which to report. (repeated)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,9 +17,13 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all URL channels in the specified ad client for this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.<br>
|
||||
adClientId: string, Ad client for which to list URL channels. (required)<br>
|
||||
maxResults: integer, The maximum number of URL channels to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -18,12 +18,16 @@
|
||||
<br>
|
||||
Args:<br>
|
||||
sort: string, A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.<br>
|
||||
pp: string, A parameter<br>
|
||||
end_date: string, End date for fetching Analytics data. All requests should specify an end date formatted as YYYY-MM-DD. (required)<br>
|
||||
dimensions: string, A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.<br>
|
||||
userip: string, A parameter<br>
|
||||
filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data.<br>
|
||||
ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics profile ID. (required)<br>
|
||||
metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, The maximum number of entries to include in this feed.<br>
|
||||
filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data.<br>
|
||||
trace: string, A parameter<br>
|
||||
segment: string, An Analytics advanced segment to be applied to data.<br>
|
||||
start_date: string, Start date for fetching Analytics data. All requests should specify a start date formatted as YYYY-MM-DD. (required)<br>
|
||||
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br>
|
||||
|
||||
@@ -17,7 +17,11 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists all accounts to which the user has access.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, The maximum number of accounts to include in this response.<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -17,8 +17,12 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists goals to which the user has access.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, The maximum number of goals to include in this response.<br>
|
||||
webPropertyId: string, Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
profileId: string, Profile ID to retrieve goals for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. (required)<br>
|
||||
start_index: integer, An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br>
|
||||
accountId: string, Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. (required)<br>
|
||||
|
||||
@@ -17,8 +17,12 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists profiles to which the user has access.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, The maximum number of profiles to include in this response.<br>
|
||||
webPropertyId: string, Web property ID for the profiles to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br>
|
||||
accountId: string, Account ID for the profiles to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)<br>
|
||||
<br>
|
||||
|
||||
@@ -17,7 +17,11 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists advanced segments to which the user has access.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, The maximum number of advanced segments to include in this response.<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -17,7 +17,11 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists web properties to which the user has access.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, The maximum number of web properties to include in this response.<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br>
|
||||
accountId: string, Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. (required)<br>
|
||||
<br>
|
||||
|
||||
28
docs/dyn/androidpublisher.v1.html
Normal file
28
docs/dyn/androidpublisher.v1.html
Normal file
@@ -0,0 +1,28 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-purchases"><strong><a href="androidpublisher.v1.purchases.html">purchases</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
58
docs/dyn/androidpublisher.v1.purchases.html
Normal file
58
docs/dyn/androidpublisher.v1.purchases.html
Normal file
@@ -0,0 +1,58 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-cancel"><strong>cancel</strong></a> = method(self, **kwargs)</dt><dd><tt>Cancels a user's subscription purchase. The subscription remains valid until its expiration time.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
token: string, The token provided to the user's device when the subscription was purchased. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Checks whether a user's subscription purchase is valid and returns its expiry time.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
token: string, The token provided to the user's device when the subscription was purchased. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{ # A Purchase resource indicates the status of a user's subscription purchase.<br>
|
||||
"initiationTimestampMsec": "A String", # Time at which the subscription was granted, in milliseconds since Epoch.<br>
|
||||
"kind": "androidpublisher#subscriptionPurchase", # This kind represents a subscriptionPurchase object in the androidpublisher service.<br>
|
||||
"autoRenewing": True or False, # Whether the subscription will automatically be renewed when it reaches its current expiry time.<br>
|
||||
"validUntilTimestampMsec": "A String", # Time at which the subscription will expire, in milliseconds since Epoch.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -21,16 +21,20 @@ Args:<br>
|
||||
Allowed values<br>
|
||||
application_owner - Caller is an application owner.<br>
|
||||
customer - Caller is a customer.<br>
|
||||
actorApplicationId: string, Application ID of the application which interacted on behalf of the user while performing the event.<br>
|
||||
actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.<br>
|
||||
actorEmail: string, Email address of the user who performed the action.<br>
|
||||
maxResults: integer, Number of activity records to be shown in each page.<br>
|
||||
continuationToken: string, Next page URL.<br>
|
||||
eventName: string, Name of the event being queried.<br>
|
||||
endTime: string, Return events which occured at or before this time.<br>
|
||||
startTime: string, Return events which occured at or after this time.<br>
|
||||
parameters: string, Event parameters in the form [parameter1 name]:[parameter1 value],[parameter2 name]:[parameter2 value],...<br>
|
||||
actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.<br>
|
||||
applicationId: string, Application ID of the application on which the event was performed. (required)<br>
|
||||
eventName: string, Name of the event being queried.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
actorApplicationId: string, Application ID of the application which interacted on behalf of the user while performing the event.<br>
|
||||
strict: string, A parameter<br>
|
||||
continuationToken: string, Next page URL.<br>
|
||||
maxResults: integer, Number of activity records to be shown in each page.<br>
|
||||
parameters: string, Event parameters in the form [parameter1 name]:[parameter1 value],[parameter2 name]:[parameter2 value],...<br>
|
||||
actorEmail: string, Email address of the user who performed the action.<br>
|
||||
userip: string, A parameter<br>
|
||||
endTime: string, Return events which occured at or before this time.<br>
|
||||
customerId: string, Represents the customer who is the owner of target object on which action was performed. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -18,13 +18,21 @@
|
||||
<br>
|
||||
Args:<br>
|
||||
deleteContents: boolean, If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
projectId: string, Project ID of the dataset being deleted (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of dataset being deleted (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the dataset specified by datasetID.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the requested dataset (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the requested dataset (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -92,7 +100,11 @@ Args:<br>
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the new dataset (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -128,9 +140,13 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists all the datasets in the specified project to which the caller has read access; however, a project owner can list (but not necessarily get) all datasets in his project.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, Page token, returned by a previous call, to request the next page of results<br>
|
||||
maxResults: integer, The maximum number of results to return<br>
|
||||
strict: string, A parameter<br>
|
||||
projectId: string, Project ID of the datasets to be listed (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -196,7 +212,11 @@ Args:<br>
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the dataset being updated (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the dataset being updated (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -264,7 +284,11 @@ Args:<br>
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the dataset being updated (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the dataset being updated (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -17,8 +17,12 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the specified job by ID.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the requested job (required)<br>
|
||||
jobId: string, Job ID of the requested job (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -83,26 +87,30 @@ Returns:<br>
|
||||
},<br>
|
||||
"link": { # [Pick one] Configures a link job.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br>
|
||||
"destinationTable": { # [Required] The destination table of the link job.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"sourceUri": "A String", # [Required] URI of source table to link.<br>
|
||||
"sourceUri": [ # [Required] URI of source table to link.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"query": { # [Pick one] Configures a query job.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.<br>
|
||||
},<br>
|
||||
"copy": { # [Pick one] Copies a table.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
@@ -120,11 +128,13 @@ Returns:<br>
|
||||
},<br>
|
||||
"extract": { # [Pick one] Configures an extract job.<br>
|
||||
"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.<br>
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','<br>
|
||||
"sourceTable": { # [Required] A reference to the table being exported.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.<br>
|
||||
},<br>
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.<br>
|
||||
},<br>
|
||||
@@ -137,10 +147,14 @@ Returns:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
timeoutMs: integer, How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the query job (required)<br>
|
||||
maxResults: integer, Maximum number of results to read<br>
|
||||
jobId: string, Job ID of the query job (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
startIndex: string, Zero-based index of the starting row<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -243,26 +257,30 @@ Args:<br>
|
||||
},<br>
|
||||
"link": { # [Pick one] Configures a link job.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br>
|
||||
"destinationTable": { # [Required] The destination table of the link job.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"sourceUri": "A String", # [Required] URI of source table to link.<br>
|
||||
"sourceUri": [ # [Required] URI of source table to link.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"query": { # [Pick one] Configures a query job.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.<br>
|
||||
},<br>
|
||||
"copy": { # [Pick one] Copies a table.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
@@ -280,11 +298,13 @@ Args:<br>
|
||||
},<br>
|
||||
"extract": { # [Pick one] Configures an extract job.<br>
|
||||
"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.<br>
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','<br>
|
||||
"sourceTable": { # [Required] A reference to the table being exported.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.<br>
|
||||
},<br>
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.<br>
|
||||
},<br>
|
||||
@@ -294,7 +314,11 @@ Args:<br>
|
||||
}<br>
|
||||
<br>
|
||||
media_body: string, The filename of the media request body.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the project that will be billed for the job (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -359,26 +383,30 @@ Returns:<br>
|
||||
},<br>
|
||||
"link": { # [Pick one] Configures a link job.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br>
|
||||
"destinationTable": { # [Required] The destination table of the link job.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"sourceUri": "A String", # [Required] URI of source table to link.<br>
|
||||
"sourceUri": [ # [Required] URI of source table to link.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"query": { # [Pick one] Configures a query job.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.<br>
|
||||
},<br>
|
||||
"copy": { # [Pick one] Copies a table.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
@@ -396,11 +424,13 @@ Returns:<br>
|
||||
},<br>
|
||||
"extract": { # [Pick one] Configures an extract job.<br>
|
||||
"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.<br>
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','<br>
|
||||
"sourceTable": { # [Required] A reference to the table being exported.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.<br>
|
||||
},<br>
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.<br>
|
||||
},<br>
|
||||
@@ -412,6 +442,7 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists all the Jobs in the specified project that were started by the user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
projection: string, Restrict information returned to a set of selected fields<br>
|
||||
Allowed values<br>
|
||||
full - Includes all job data<br>
|
||||
@@ -425,6 +456,9 @@ Args:<br>
|
||||
projectId: string, Project ID of the jobs to list (required)<br>
|
||||
allUsers: boolean, Whether to display jobs owned by all users in the project. Default false<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -495,26 +529,30 @@ Returns:<br>
|
||||
},<br>
|
||||
"link": { # [Pick one] Configures a link job.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br>
|
||||
"destinationTable": { # [Required] The destination table of the link job.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"sourceUri": "A String", # [Required] URI of source table to link.<br>
|
||||
"sourceUri": [ # [Required] URI of source table to link.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"query": { # [Pick one] Configures a query job.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.<br>
|
||||
},<br>
|
||||
"copy": { # [Pick one] Copies a table.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
@@ -532,11 +570,13 @@ Returns:<br>
|
||||
},<br>
|
||||
"extract": { # [Pick one] Configures an extract job.<br>
|
||||
"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.<br>
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','<br>
|
||||
"sourceTable": { # [Required] A reference to the table being exported.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.<br>
|
||||
},<br>
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.<br>
|
||||
},<br>
|
||||
@@ -579,7 +619,11 @@ Args:<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the project billed for the query (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,8 +17,12 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists the projects to which you have at least read access.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, Page token, returned by a previous call, to request the next page of results<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,10 +17,14 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves table data from a specified set of rows.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the table to read (required)<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
strict: string, A parameter<br>
|
||||
startIndex: string, Zero-based index of the starting row to read<br>
|
||||
tableId: string, Table ID of the table to read (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the table to read (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -17,15 +17,23 @@
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the table to delete (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
tableId: string, Table ID of the table to delete (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the table to delete (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the requested table (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
tableId: string, Table ID of the requested table (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the requested table (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -33,6 +41,7 @@ Returns:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
@@ -44,7 +53,7 @@ Returns:<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
@@ -69,6 +78,7 @@ Args:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
@@ -80,7 +90,7 @@ Args:<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
@@ -97,7 +107,11 @@ Args:<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the new table (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the new table (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -105,6 +119,7 @@ Returns:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
@@ -116,7 +131,7 @@ Returns:<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
@@ -136,9 +151,13 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists all tables in the specified dataset.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, Page token, returned by a previous call, to request the next page of results<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
strict: string, A parameter<br>
|
||||
projectId: string, Project ID of the tables to list (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the tables to list (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -181,6 +200,7 @@ Args:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
@@ -192,7 +212,7 @@ Args:<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
@@ -209,8 +229,12 @@ Args:<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the table to update (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
tableId: string, Table ID of the table to update (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the table to update (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -218,6 +242,7 @@ Returns:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
@@ -229,7 +254,7 @@ Returns:<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
@@ -254,6 +279,7 @@ Args:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
@@ -265,7 +291,7 @@ Args:<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
@@ -282,8 +308,12 @@ Args:<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the table to update (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
tableId: string, Table ID of the table to update (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the table to update (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -291,6 +321,7 @@ Returns:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
@@ -302,7 +333,7 @@ Returns:<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
|
||||
@@ -17,6 +17,10 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one blog by id.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
blogId: string, The ID of the blog to get. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -17,6 +17,10 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one comment by id.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
commentId: string, The ID of the comment to get. (required)<br>
|
||||
postId: string, ID of the post to fetch posts from. (required)<br>
|
||||
blogId: string, ID of the blog to containing the comment. (required)<br>
|
||||
@@ -53,10 +57,14 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the comments for a blog, possibly filtered.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
startDate: string, Earliest date of comment to fetch.<br>
|
||||
startDate: string, Earliest date of comment to fetch, a date-time with <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> formatting.<br>
|
||||
pp: string, A parameter<br>
|
||||
fetchBodies: boolean, Whether the body content of the comments is included.<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, Continuation token if request is paged.<br>
|
||||
maxResults: integer, Maximum number of comments to include in the result.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
postId: string, ID of the post to fetch posts from. (required)<br>
|
||||
blogId: string, ID of the blog to fetch comments from. (required)<br>
|
||||
<br>
|
||||
|
||||
@@ -17,7 +17,11 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one blog page by id.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
pageId: string, The ID of the page to get. (required)<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
blogId: string, ID of the blog containing the page. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -48,6 +52,10 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves pages for a blog, possibly filtered.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
fetchBodies: boolean, Whether to retrieve the Page bodies.<br>
|
||||
blogId: string, ID of the blog to fetch pages from. (required)<br>
|
||||
<br>
|
||||
|
||||
@@ -17,6 +17,10 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get a post by id.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
postId: string, The ID of the post (required)<br>
|
||||
blogId: string, ID of the blog to fetch the post from. (required)<br>
|
||||
<br>
|
||||
@@ -55,9 +59,13 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of posts, possibly filtered.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
startDate: string, Earliest post date to fetch.<br>
|
||||
startDate: string, Earliest post date to fetch, a date-time with <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> formatting.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, Continuation token if the request is paged.<br>
|
||||
maxResults: integer, Maximum number of posts to fetch.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
fetchBodies: boolean, Whether the body content of posts is included.<br>
|
||||
blogId: string, ID of the blog to fetch posts from. (required)<br>
|
||||
<br>
|
||||
|
||||
@@ -17,7 +17,11 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of blogs, possibly filtered.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
userId: string, ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -19,7 +19,11 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one user by id.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
userId: string, The ID of the user to get. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,10 +17,13 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves metadata for a specific bookshelf for the specified user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
userId: string, ID of user for whom to retrieve bookshelves. (required)<br>
|
||||
shelf: string, ID of bookshelf to retrieve. (required)<br>
|
||||
userId: string, ID of user for whom to retrieve bookshelves. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -41,9 +44,12 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of public bookshelves for the specified user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
userId: string, ID of user for whom to retrieve bookshelves. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,12 +17,15 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves volumes in a specific bookshelf for the specified user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
shelf: string, ID of bookshelf to retrieve volumes. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
shelf: string, ID of bookshelf to retrieve volumes. (required)<br>
|
||||
showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
strict: string, A parameter<br>
|
||||
startIndex: integer, Index of the first element to return (starts at 0)<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
userip: string, A parameter<br>
|
||||
userId: string, ID of user for whom to retrieve bookshelf volumes. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -52,6 +55,7 @@ Returns:<br>
|
||||
"message": "A String", # Error/warning message.<br>
|
||||
},<br>
|
||||
"country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)<br>
|
||||
"viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.<br>
|
||||
"textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.<br>
|
||||
"pdf": { # Information about pdf content. (In LITE projection.)<br>
|
||||
"isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)<br>
|
||||
@@ -86,18 +90,8 @@ Returns:<br>
|
||||
},<br>
|
||||
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)<br>
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)<br>
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."<br>
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br>
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)<br>
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.<br>
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.<br>
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.<br>
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeId": "A String", # Volume id associated with this reading position.<br>
|
||||
"pdfPosition": "A String", # Position in a PDF file.<br>
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.<br>
|
||||
},<br>
|
||||
"review": { # This user's review of this volume, if one exists.<br>
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.<br>
|
||||
"kind": "books#review", # Resource type for a review.<br>
|
||||
@@ -116,27 +110,24 @@ Returns:<br>
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.<br>
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.<br>
|
||||
},<br>
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)<br>
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.<br>
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.<br>
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.<br>
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeId": "A String", # Volume id associated with this reading position.<br>
|
||||
"pdfPosition": "A String", # Position in a PDF file.<br>
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.<br>
|
||||
},<br>
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)<br>
|
||||
},<br>
|
||||
"volumeInfo": { # General volume information.<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)<br>
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)<br>
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)<br>
|
||||
@@ -145,21 +136,33 @@ Returns:<br>
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)<br>
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)<br>
|
||||
},<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"showReviewsLink": "A String", # URL to show reviews for this volume<br>
|
||||
"writeReviewLink": "A String", # URL to write a review for this volume<br>
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)<br>
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)<br>
|
||||
|
||||
@@ -22,8 +22,6 @@
|
||||
|
||||
<dl><dt><a name="Resource-mylibrary"><strong><a href="books.v1.mylibrary.html">mylibrary</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-volumeAnnotations"><strong><a href="books.v1.volumeAnnotations.html">volumeAnnotations</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-volumes"><strong><a href="books.v1.volumes.html">volumes</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
|
||||
@@ -17,12 +17,18 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the annotation data.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
annotationDataId: string, The ID of the annotation data to retrieve. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.<br>
|
||||
layerId: string, The ID for the layer to get the annotations. (required)<br>
|
||||
volumeId: string, The volume to retrieve annotations for. (required)<br>
|
||||
annotationDataId: string, The ID of the annotation data to retrieve. (required)<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
strict: string, A parameter<br>
|
||||
contentVersion: string, The content version for the volume you are trying to retrieve. (required)<br>
|
||||
h: integer, The requested pixel height for any images. If height is provided width must also be provided.<br>
|
||||
userip: string, A parameter<br>
|
||||
w: integer, The requested pixel width for any images. If width is provided height must also be provided.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -34,7 +40,41 @@ Returns:<br>
|
||||
"volumeId": "A String", # The volume id for this data. *<br>
|
||||
"encoded_data": "A String", # Base64 encoded data for this annotation data.<br>
|
||||
"layerId": "A String", # The Layer id for this data. *<br>
|
||||
"data": "A String", # JSON enoded data for this annotation data.<br>
|
||||
"data": { # JSON encoded data for this annotation data.<br>
|
||||
"geo": {<br>
|
||||
"countryCode": "A String", # The country code of the location.<br>
|
||||
"zoom": 42, # The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels<br>
|
||||
"longitude": 3.14, # The longitude of the location.<br>
|
||||
"mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN<br>
|
||||
"latitude": 3.14, # The latitude of the location.<br>
|
||||
"boundary": [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.<br>
|
||||
[<br>
|
||||
{<br>
|
||||
"latitude": 42,<br>
|
||||
"longitude": 42,<br>
|
||||
},<br>
|
||||
],<br>
|
||||
],<br>
|
||||
"resolution": "A String", # The resolution of the location. Ex: POI_LEVEL<br>
|
||||
"viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle.<br>
|
||||
"lo": {<br>
|
||||
"latitude": 3.14,<br>
|
||||
"longitude": 3.14,<br>
|
||||
},<br>
|
||||
"hi": {<br>
|
||||
"latitude": 3.14,<br>
|
||||
"longitude": 3.14,<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"cachePolicy": "A String", # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER<br>
|
||||
},<br>
|
||||
"common": {<br>
|
||||
"lang": "A String", # The language of the information url and description.<br>
|
||||
"previewImageUrl": "A String", # The URL for the preview image information.<br>
|
||||
"snippet": "A String", # The description for this location.<br>
|
||||
"snippetUrl": "A String", # The URL for information for this location. Ex: wikipedia link.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique id for this annotation data.<br>
|
||||
"selfLink": "A String", # URL for this resource. *<br>
|
||||
}</tt></dd></dl>
|
||||
@@ -42,22 +82,28 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the annotation data for a volume and layer.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pageToken: string, The value of the nextToken from the previous page.<br>
|
||||
updatedMax: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated prior to this timestamp (exclusive).<br>
|
||||
locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.<br>
|
||||
layerId: string, The ID for the layer to get the annotation data. (required)<br>
|
||||
volumeId: string, The volume to retrieve annotation data for. (required)<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, The value of the nextToken from the previous page.<br>
|
||||
updatedMin: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated since this timestamp (inclusive).<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
contentVersion: string, The content version for the requested volume. (required)<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
updatedMin: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated since this timestamp (inclusive).<br>
|
||||
layerId: string, The ID for the layer to get the annotation data. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
updatedMax: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated prior to this timestamp (exclusive).<br>
|
||||
volumeId: string, The volume to retrieve annotation data for. (required)<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
annotationDataId: string, The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. (repeated)<br>
|
||||
h: integer, The requested pixel height for any images. If height is provided width must also be provided.<br>
|
||||
w: integer, The requested pixel width for any images. If width is provided height must also be provided.<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"totalItems": 42, # The total number of volume annotations found.<br>
|
||||
"nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.<br>
|
||||
"items": [ # A list of Annotation Data.<br>
|
||||
{<br>
|
||||
"annotationType": "A String", # The type of annotation this data is for.<br>
|
||||
@@ -66,14 +112,59 @@ Returns:<br>
|
||||
"volumeId": "A String", # The volume id for this data. *<br>
|
||||
"encoded_data": "A String", # Base64 encoded data for this annotation data.<br>
|
||||
"layerId": "A String", # The Layer id for this data. *<br>
|
||||
"data": "A String", # JSON enoded data for this annotation data.<br>
|
||||
"data": { # JSON encoded data for this annotation data.<br>
|
||||
"geo": {<br>
|
||||
"countryCode": "A String", # The country code of the location.<br>
|
||||
"zoom": 42, # The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels<br>
|
||||
"longitude": 3.14, # The longitude of the location.<br>
|
||||
"mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN<br>
|
||||
"latitude": 3.14, # The latitude of the location.<br>
|
||||
"boundary": [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.<br>
|
||||
[<br>
|
||||
{<br>
|
||||
"latitude": 42,<br>
|
||||
"longitude": 42,<br>
|
||||
},<br>
|
||||
],<br>
|
||||
],<br>
|
||||
"resolution": "A String", # The resolution of the location. Ex: POI_LEVEL<br>
|
||||
"viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle.<br>
|
||||
"lo": {<br>
|
||||
"latitude": 3.14,<br>
|
||||
"longitude": 3.14,<br>
|
||||
},<br>
|
||||
"hi": {<br>
|
||||
"latitude": 3.14,<br>
|
||||
"longitude": 3.14,<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"cachePolicy": "A String", # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER<br>
|
||||
},<br>
|
||||
"common": {<br>
|
||||
"lang": "A String", # The language of the information url and description.<br>
|
||||
"previewImageUrl": "A String", # The URL for the preview image information.<br>
|
||||
"snippet": "A String", # The description for this location.<br>
|
||||
"snippetUrl": "A String", # The URL for information for this location. Ex: wikipedia link.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique id for this annotation data.<br>
|
||||
"selfLink": "A String", # URL for this resource. *<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "books#annotationsdata", # Resource type<br>
|
||||
"totalItems": 42, # The total number of volume annotations found.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
|
||||
@@ -19,8 +19,13 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the layer summary for a volume.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
volumeId: string, The volume to retrieve layers for. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
contentVersion: string, The content version for the requested volume.<br>
|
||||
userip: string, A parameter<br>
|
||||
summaryId: string, The ID for the layer to get the summary for. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -32,24 +37,29 @@ Returns:<br>
|
||||
"dataCount": 42, # The number of data items for this layer.<br>
|
||||
"annotationsLink": "A String", # The link to get the annotations for this layer.<br>
|
||||
"updated": "A String", # Timestamp for the last time an item in this layer was updated. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br>
|
||||
"annotationsDataLink": "A String", # Link to get data for this annotation.<br>
|
||||
"annotationTypes": [ # The list of annotation types contained for this layer. *<br>
|
||||
"volumeId": "A String", # The volume id this resource is for.<br>
|
||||
"id": "A String", # Unique id of this layer summary.<br>
|
||||
"annotationTypes": [ # The list of annotation types contained for this layer.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"contentVersion": "A String", # The content version this resource is for.<br>
|
||||
"layerId": "A String", # The layer id for this summary.<br>
|
||||
"id": "A String", # Unique id of this layer summary.<br>
|
||||
"annotationsDataLink": "A String", # Link to get data for this annotation.<br>
|
||||
"selfLink": "A String", # URL to this resource.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List the layer summaries for a volume.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, The value of the nextToken from the previous page.<br>
|
||||
volumeId: string, The volume to retrieve layers for. (required)<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
pageToken: string, The value of the nextToken from the previous page.<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
contentVersion: string, The content version for the requested volume.<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -63,18 +73,22 @@ Returns:<br>
|
||||
"dataCount": 42, # The number of data items for this layer.<br>
|
||||
"annotationsLink": "A String", # The link to get the annotations for this layer.<br>
|
||||
"updated": "A String", # Timestamp for the last time an item in this layer was updated. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br>
|
||||
"annotationsDataLink": "A String", # Link to get data for this annotation.<br>
|
||||
"annotationTypes": [ # The list of annotation types contained for this layer. *<br>
|
||||
"volumeId": "A String", # The volume id this resource is for.<br>
|
||||
"id": "A String", # Unique id of this layer summary.<br>
|
||||
"annotationTypes": [ # The list of annotation types contained for this layer.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"contentVersion": "A String", # The content version this resource is for.<br>
|
||||
"layerId": "A String", # The layer id for this summary.<br>
|
||||
"id": "A String", # Unique id of this layer summary.<br>
|
||||
"annotationsDataLink": "A String", # Link to get data for this annotation.<br>
|
||||
"selfLink": "A String", # URL to this resource.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "books#layersummaries", # Resource type.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-volumeAnnotations"><strong><a href="books.v1.layers.volumeAnnotations.html">volumeAnnotations</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
|
||||
162
docs/dyn/books.v1.layers.volumeAnnotations.html
Normal file
162
docs/dyn/books.v1.layers.volumeAnnotations.html
Normal file
@@ -0,0 +1,162 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the volume annotation.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.<br>
|
||||
annotationId: string, The ID of the volume annotation to retrieve. (required)<br>
|
||||
volumeId: string, The volume to retrieve annotations for. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
layerId: string, The ID for the layer to get the annotations. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"annotationType": "A String", # The type of annotation this is.<br>
|
||||
"kind": "books#volumeannotation", # Resource Type<br>
|
||||
"updated": "A String", # Timestamp for the last time this anntoation was updated. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br>
|
||||
"deleted": True or False, # Indicates that this annotation is deleted.<br>
|
||||
"contentRanges": { # The content ranges to identify the selected text.<br>
|
||||
"contentVersion": "A String", # Content version applicable to ranges below.<br>
|
||||
"gbTextRange": { # Range in GB text format for this annotation for version above.<br>
|
||||
"startPosition": "A String", # The starting position for the range.<br>
|
||||
"endPosition": "A String", # The ending position for the range.<br>
|
||||
"startOffset": "A String", # The offset from the starting position.<br>
|
||||
"endOffset": "A String", # The offset from the ending position.<br>
|
||||
},<br>
|
||||
"cfiRange": { # Range in CFI format for this annotation for version above.<br>
|
||||
"startPosition": "A String", # The starting position for the range.<br>
|
||||
"endPosition": "A String", # The ending position for the range.<br>
|
||||
"startOffset": "A String", # The offset from the starting position.<br>
|
||||
"endOffset": "A String", # The offset from the ending position.<br>
|
||||
},<br>
|
||||
"gbImageRange": { # Range in GB image format for this annotation for version above.<br>
|
||||
"startPosition": "A String", # The starting position for the range.<br>
|
||||
"endPosition": "A String", # The ending position for the range.<br>
|
||||
"startOffset": "A String", # The offset from the starting position.<br>
|
||||
"endOffset": "A String", # The offset from the ending position.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"selectedText": "A String", # Excerpt from the volume.<br>
|
||||
"volumeId": "A String", # The Volume this annotation is for.<br>
|
||||
"annotationDataId": "A String", # The annotation data id for this volume annotation.<br>
|
||||
"annotationDataLink": "A String", # Link to get data for this annotation.<br>
|
||||
"pageIds": [ # Pages the annotation spans.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"layerId": "A String", # The Layer this annotation is for.<br>
|
||||
"data": "A String", # Data for this annotation.<br>
|
||||
"id": "A String", # Unique id of this volume annotation.<br>
|
||||
"selfLink": "A String", # URL to this resource.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the volume annotations for a volume and layer.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
endPosition: string, The end position to end retrieving data from.<br>
|
||||
locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.<br>
|
||||
startOffset: string, The start offset to start retrieving data from.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, The value of the nextToken from the previous page.<br>
|
||||
updatedMin: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated since this timestamp (inclusive).<br>
|
||||
endOffset: string, The end offset to end retrieving data from.<br>
|
||||
showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.<br>
|
||||
contentVersion: string, The content version for the requested volume. (required)<br>
|
||||
layerId: string, The ID for the layer to get the annotations. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
updatedMax: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated prior to this timestamp (exclusive).<br>
|
||||
volumeId: string, The volume to retrieve annotations for. (required)<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
startPosition: string, The start position to start retrieving data from.<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.<br>
|
||||
"items": [ # A list of volume annotations.<br>
|
||||
{<br>
|
||||
"annotationType": "A String", # The type of annotation this is.<br>
|
||||
"kind": "books#volumeannotation", # Resource Type<br>
|
||||
"updated": "A String", # Timestamp for the last time this anntoation was updated. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br>
|
||||
"deleted": True or False, # Indicates that this annotation is deleted.<br>
|
||||
"contentRanges": { # The content ranges to identify the selected text.<br>
|
||||
"contentVersion": "A String", # Content version applicable to ranges below.<br>
|
||||
"gbTextRange": { # Range in GB text format for this annotation for version above.<br>
|
||||
"startPosition": "A String", # The starting position for the range.<br>
|
||||
"endPosition": "A String", # The ending position for the range.<br>
|
||||
"startOffset": "A String", # The offset from the starting position.<br>
|
||||
"endOffset": "A String", # The offset from the ending position.<br>
|
||||
},<br>
|
||||
"cfiRange": { # Range in CFI format for this annotation for version above.<br>
|
||||
"startPosition": "A String", # The starting position for the range.<br>
|
||||
"endPosition": "A String", # The ending position for the range.<br>
|
||||
"startOffset": "A String", # The offset from the starting position.<br>
|
||||
"endOffset": "A String", # The offset from the ending position.<br>
|
||||
},<br>
|
||||
"gbImageRange": { # Range in GB image format for this annotation for version above.<br>
|
||||
"startPosition": "A String", # The starting position for the range.<br>
|
||||
"endPosition": "A String", # The ending position for the range.<br>
|
||||
"startOffset": "A String", # The offset from the starting position.<br>
|
||||
"endOffset": "A String", # The offset from the ending position.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"selectedText": "A String", # Excerpt from the volume.<br>
|
||||
"volumeId": "A String", # The Volume this annotation is for.<br>
|
||||
"annotationDataId": "A String", # The annotation data id for this volume annotation.<br>
|
||||
"annotationDataLink": "A String", # Link to get data for this annotation.<br>
|
||||
"pageIds": [ # Pages the annotation spans.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"layerId": "A String", # The Layer this annotation is for.<br>
|
||||
"data": "A String", # Data for this annotation.<br>
|
||||
"id": "A String", # Unique id of this volume annotation.<br>
|
||||
"selfLink": "A String", # URL to this resource.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "books#volumeannotations", # Resource type<br>
|
||||
"totalItems": 42, # The total number of volume annotations found.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -17,11 +17,14 @@
|
||||
<dl><dt><a name="Resource-releaseDownloadAccess"><strong>releaseDownloadAccess</strong></a> = method(self, **kwargs)</dt><dd><tt>Release downloaded content access restriction.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
cpksver: string, The device/version ID from which to release the restriction. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
volumeIds: string, The volume(s) to release restrictions for. (required) (repeated)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -50,11 +53,14 @@ Returns:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
nonce: string, The client nonce value. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request. (required)<br>
|
||||
locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
cpksver: string, The device/version ID from which to request the restrictions. (required)<br>
|
||||
volumeId: string, The volume to request concurrent/download restrictions for. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -94,12 +100,15 @@ Returns:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
nonce: string, The client nonce value. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request. (required)<br>
|
||||
locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.<br>
|
||||
cpksver: string, The device/version ID from which to release the restriction. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
volumeIds: string, The volume(s) to request download restrictions for. (repeated)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -128,6 +137,7 @@ Returns:<br>
|
||||
"message": "A String", # Error/warning message.<br>
|
||||
},<br>
|
||||
"country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)<br>
|
||||
"viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.<br>
|
||||
"textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.<br>
|
||||
"pdf": { # Information about pdf content. (In LITE projection.)<br>
|
||||
"isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)<br>
|
||||
@@ -162,18 +172,8 @@ Returns:<br>
|
||||
},<br>
|
||||
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)<br>
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)<br>
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."<br>
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br>
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)<br>
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.<br>
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.<br>
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.<br>
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeId": "A String", # Volume id associated with this reading position.<br>
|
||||
"pdfPosition": "A String", # Position in a PDF file.<br>
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.<br>
|
||||
},<br>
|
||||
"review": { # This user's review of this volume, if one exists.<br>
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.<br>
|
||||
"kind": "books#review", # Resource type for a review.<br>
|
||||
@@ -192,27 +192,24 @@ Returns:<br>
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.<br>
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.<br>
|
||||
},<br>
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)<br>
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.<br>
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.<br>
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.<br>
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeId": "A String", # Volume id associated with this reading position.<br>
|
||||
"pdfPosition": "A String", # Position in a PDF file.<br>
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.<br>
|
||||
},<br>
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)<br>
|
||||
},<br>
|
||||
"volumeInfo": { # General volume information.<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)<br>
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)<br>
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)<br>
|
||||
@@ -221,21 +218,33 @@ Returns:<br>
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)<br>
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)<br>
|
||||
},<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"showReviewsLink": "A String", # URL to show reviews for this volume<br>
|
||||
"writeReviewLink": "A String", # URL to write a review for this volume<br>
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)<br>
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)<br>
|
||||
|
||||
@@ -17,16 +17,22 @@
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes an annotation.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
annotationId: string, The ID for the annotation to delete. (required)</tt></dd></dl>
|
||||
annotationId: string, The ID for the annotation to delete. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets an annotation by its ID.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
annotationId: string, The ID for the annotation to retrieve. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -159,8 +165,11 @@ Args:<br>
|
||||
"selfLink": "A String", # URL to this resource.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -230,6 +239,8 @@ Returns:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pageToken: string, The value of the nextToken from the previous page.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
updatedMax: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated prior to this timestamp (exclusive).<br>
|
||||
layerId: string, The layer ID to limit annotation by.<br>
|
||||
volumeId: string, The volume to restrict annotations to.<br>
|
||||
@@ -238,8 +249,9 @@ Args:<br>
|
||||
pageIds: string, The page ID(s) for the volume that is being queried. (repeated)<br>
|
||||
contentVersion: string, The content version for the requested volume.<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
updatedMin: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated since this timestamp (inclusive).<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -389,9 +401,12 @@ Args:<br>
|
||||
"selfLink": "A String", # URL to this resource.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
annotationId: string, The ID for the annotation to update. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,24 +17,33 @@
|
||||
<dl><dt><a name="Resource-addVolume"><strong>addVolume</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds a volume to a bookshelf.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
shelf: string, ID of bookshelf to which to add a volume. (required)<br>
|
||||
volumeId: string, ID of volume to add. (required)<br>
|
||||
shelf: string, ID of bookshelf to which to add a volume. (required)</tt></dd></dl>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-clearVolumes"><strong>clearVolumes</strong></a> = method(self, **kwargs)</dt><dd><tt>Clears all volumes from a bookshelf.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
shelf: string, ID of bookshelf from which to remove a volume. (required)<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.</tt></dd></dl>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves metadata for a specific bookshelf belonging to the authenticated user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
shelf: string, ID of bookshelf to retrieve. (required)<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -55,8 +64,11 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of bookshelves belonging to the authenticated user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -83,18 +95,24 @@ Returns:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
volumePosition: integer, Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.) (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
shelf: string, ID of bookshelf with the volume. (required)<br>
|
||||
volumeId: string, ID of volume to move. (required)<br>
|
||||
shelf: string, ID of bookshelf with the volume. (required)</tt></dd></dl>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-removeVolume"><strong>removeVolume</strong></a> = method(self, **kwargs)</dt><dd><tt>Removes a volume from a bookshelf.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
shelf: string, ID of bookshelf from which to remove a volume. (required)<br>
|
||||
volumeId: string, ID of volume to remove. (required)<br>
|
||||
shelf: string, ID of bookshelf from which to remove a volume. (required)</tt></dd></dl>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-volumes"><strong><a href="books.v1.mylibrary.bookshelves.volumes.html">volumes</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
|
||||
@@ -17,6 +17,8 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets volume information for volumes on a bookshelf.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
q: string, Full-text search query string in this bookshelf.<br>
|
||||
pp: string, A parameter<br>
|
||||
projection: string, Restrict information returned to a set of selected fields.<br>
|
||||
Allowed values<br>
|
||||
full - Includes all volume data.<br>
|
||||
@@ -24,10 +26,12 @@ Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
q: string, Full-text search query string in this bookshelf.<br>
|
||||
startIndex: integer, Index of the first element to return (starts at 0)<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
shelf: string, The bookshelf ID or name retrieve volumes for. (required)<br>
|
||||
trace: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -56,6 +60,7 @@ Returns:<br>
|
||||
"message": "A String", # Error/warning message.<br>
|
||||
},<br>
|
||||
"country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)<br>
|
||||
"viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.<br>
|
||||
"textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.<br>
|
||||
"pdf": { # Information about pdf content. (In LITE projection.)<br>
|
||||
"isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)<br>
|
||||
@@ -90,18 +95,8 @@ Returns:<br>
|
||||
},<br>
|
||||
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)<br>
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)<br>
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."<br>
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br>
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)<br>
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.<br>
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.<br>
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.<br>
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeId": "A String", # Volume id associated with this reading position.<br>
|
||||
"pdfPosition": "A String", # Position in a PDF file.<br>
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.<br>
|
||||
},<br>
|
||||
"review": { # This user's review of this volume, if one exists.<br>
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.<br>
|
||||
"kind": "books#review", # Resource type for a review.<br>
|
||||
@@ -120,27 +115,24 @@ Returns:<br>
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.<br>
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.<br>
|
||||
},<br>
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)<br>
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.<br>
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.<br>
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.<br>
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeId": "A String", # Volume id associated with this reading position.<br>
|
||||
"pdfPosition": "A String", # Position in a PDF file.<br>
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.<br>
|
||||
},<br>
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)<br>
|
||||
},<br>
|
||||
"volumeInfo": { # General volume information.<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)<br>
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)<br>
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)<br>
|
||||
@@ -149,21 +141,33 @@ Returns:<br>
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)<br>
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)<br>
|
||||
},<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"showReviewsLink": "A String", # URL to show reviews for this volume<br>
|
||||
"writeReviewLink": "A String", # URL to write a review for this volume<br>
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)<br>
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)<br>
|
||||
|
||||
@@ -17,10 +17,13 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves my reading position information for a volume.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
volumeId: string, ID of volume for which to retrieve a reading position. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
contentVersion: string, Volume content version for which this reading position is requested.<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -38,12 +41,15 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-setPosition"><strong>setPosition</strong></a> = method(self, **kwargs)</dt><dd><tt>Sets my reading position information for a volume.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
volumeId: string, ID of volume for which to update the reading position. (required)<br>
|
||||
contentVersion: string, Volume content version for which this reading position applies.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
position: string, Position string for the new volume reading position. (required)<br>
|
||||
timestamp: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC format timestamp associated with this reading position. (required)<br>
|
||||
volumeId: string, ID of volume for which to update the reading position. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
contentVersion: string, Volume content version for which this reading position applies.<br>
|
||||
userip: string, A parameter<br>
|
||||
position: string, Position string for the new volume reading position. (required)<br>
|
||||
action: string, Action that caused this reading position to be set.<br>
|
||||
Allowed values<br>
|
||||
bookmark - User chose bookmark within volume.<br>
|
||||
|
||||
195
docs/dyn/books.v1.volumes.associated.html
Normal file
195
docs/dyn/books.v1.volumes.associated.html
Normal file
@@ -0,0 +1,195 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Return a list of associated books.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
filter: string, Filter search results.<br>
|
||||
Allowed values<br>
|
||||
ebooks - All Google eBooks.<br>
|
||||
free-ebooks - Google eBook with full volume text viewability.<br>
|
||||
full - Public can view entire volume text.<br>
|
||||
paid-ebooks - Google eBook with a price.<br>
|
||||
partial - Public able to see parts of text.<br>
|
||||
pp: string, A parameter<br>
|
||||
projection: string, Restrict information returned to a set of selected fields.<br>
|
||||
Allowed values<br>
|
||||
full - Includes all volume data.<br>
|
||||
lite - Includes a subset of fields in volumeInfo and accessInfo.<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
volumeId: string, ID of the source volume. (required)<br>
|
||||
maxResults: integer, Maximum number of results to return.<br>
|
||||
strict: string, A parameter<br>
|
||||
startIndex: integer, Index of the first result to return (starts at 0)<br>
|
||||
userip: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
association: string, Association type.<br>
|
||||
Allowed values<br>
|
||||
complementary - Books that are complementary for additional reading.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"totalItems": 42, # Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.<br>
|
||||
"items": [ # A list of volumes.<br>
|
||||
{<br>
|
||||
"kind": "books#volume", # Resource type for a volume. (In LITE projection.)<br>
|
||||
"accessInfo": { # Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).<br>
|
||||
"webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.<br>
|
||||
"publicDomain": True or False, # Whether or not this book is public domain in the country listed above.<br>
|
||||
"embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.<br>
|
||||
"downloadAccess": { # Information about a volume's download license access restrictions.<br>
|
||||
"nonce": "A String", # Client nonce for verification. Download access and client-validation only.<br>
|
||||
"kind": "books#downloadAccessRestriction", # Resource type.<br>
|
||||
"justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.<br>
|
||||
"maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.<br>
|
||||
"downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).<br>
|
||||
"signature": "A String", # Response signature.<br>
|
||||
"volumeId": "A String", # Identifies the volume for which this entry applies.<br>
|
||||
"deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).<br>
|
||||
"source": "A String", # Client app identifier for verification. Download access and client-validation only.<br>
|
||||
"restricted": True or False, # Whether this volume has any download access restrictions.<br>
|
||||
"reasonCode": "A String", # Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS<br>
|
||||
"message": "A String", # Error/warning message.<br>
|
||||
},<br>
|
||||
"country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)<br>
|
||||
"viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.<br>
|
||||
"textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.<br>
|
||||
"pdf": { # Information about pdf content. (In LITE projection.)<br>
|
||||
"isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)<br>
|
||||
"downloadLink": "A String", # URL to download pdf. (In LITE projection.)<br>
|
||||
"acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)<br>
|
||||
},<br>
|
||||
"viewability": "A String", # The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES.<br>
|
||||
"epub": { # Information about epub content. (In LITE projection.)<br>
|
||||
"isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)<br>
|
||||
"downloadLink": "A String", # URL to download epub. (In LITE projection.)<br>
|
||||
"acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)<br>
|
||||
},<br>
|
||||
"accessViewStatus": "A String", # Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)<br>
|
||||
},<br>
|
||||
"searchInfo": { # Search result information related to this volume.<br>
|
||||
"textSnippet": "A String", # A text snippet containing the search query.<br>
|
||||
},<br>
|
||||
"saleInfo": { # Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries).<br>
|
||||
"country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)<br>
|
||||
"retailPrice": { # The actual selling price of the book. This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)<br>
|
||||
"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)<br>
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)<br>
|
||||
},<br>
|
||||
"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).<br>
|
||||
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FREE, NOT_FOR_SALE, or FOR_PREORDER.<br>
|
||||
"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)<br>
|
||||
"onSaleDate": "A String", # The date on which this book is available for sale.<br>
|
||||
"listPrice": { # Suggested retail price. (In LITE projection.)<br>
|
||||
"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)<br>
|
||||
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)<br>
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)<br>
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."<br>
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br>
|
||||
"review": { # This user's review of this volume, if one exists.<br>
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.<br>
|
||||
"kind": "books#review", # Resource type for a review.<br>
|
||||
"author": { # Author of this review.<br>
|
||||
"displayName": "A String", # Name of this person.<br>
|
||||
},<br>
|
||||
"title": "A String", # Title for this review.<br>
|
||||
"volumeId": "A String", # Volume that this review is for.<br>
|
||||
"content": "A String", # Review text.<br>
|
||||
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.<br>
|
||||
"extraDescription": "A String", # Extra text about the source of the review.<br>
|
||||
"url": "A String", # URL of the source of the review.<br>
|
||||
"description": "A String", # Name of the source.<br>
|
||||
},<br>
|
||||
"date": "A String", # Date of this review.<br>
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.<br>
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.<br>
|
||||
},<br>
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)<br>
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.<br>
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.<br>
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.<br>
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeId": "A String", # Volume id associated with this reading position.<br>
|
||||
"pdfPosition": "A String", # Position in a PDF file.<br>
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.<br>
|
||||
},<br>
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)<br>
|
||||
},<br>
|
||||
"volumeInfo": { # General volume information.<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)<br>
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)<br>
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)<br>
|
||||
"large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)<br>
|
||||
"extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)<br>
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)<br>
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)<br>
|
||||
},<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)<br>
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "books#volumes", # Resource type.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -14,16 +14,22 @@
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-associated"><strong><a href="books.v1.volumes.associated.html">associated</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets volume information for a single volume.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
projection: string, Restrict information returned to a set of selected fields.<br>
|
||||
Allowed values<br>
|
||||
full - Includes all volume data.<br>
|
||||
lite - Includes a subset of fields in volumeInfo and accessInfo.<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
volumeId: string, ID of volume to retrieve. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
partner: string, Brand results for partner ID.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -50,6 +56,7 @@ Returns:<br>
|
||||
"message": "A String", # Error/warning message.<br>
|
||||
},<br>
|
||||
"country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)<br>
|
||||
"viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.<br>
|
||||
"textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.<br>
|
||||
"pdf": { # Information about pdf content. (In LITE projection.)<br>
|
||||
"isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)<br>
|
||||
@@ -84,18 +91,8 @@ Returns:<br>
|
||||
},<br>
|
||||
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)<br>
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)<br>
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."<br>
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br>
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)<br>
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.<br>
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.<br>
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.<br>
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeId": "A String", # Volume id associated with this reading position.<br>
|
||||
"pdfPosition": "A String", # Position in a PDF file.<br>
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.<br>
|
||||
},<br>
|
||||
"review": { # This user's review of this volume, if one exists.<br>
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.<br>
|
||||
"kind": "books#review", # Resource type for a review.<br>
|
||||
@@ -114,27 +111,24 @@ Returns:<br>
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.<br>
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.<br>
|
||||
},<br>
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)<br>
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.<br>
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.<br>
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.<br>
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeId": "A String", # Volume id associated with this reading position.<br>
|
||||
"pdfPosition": "A String", # Position in a PDF file.<br>
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.<br>
|
||||
},<br>
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)<br>
|
||||
},<br>
|
||||
"volumeInfo": { # General volume information.<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)<br>
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)<br>
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)<br>
|
||||
@@ -143,21 +137,33 @@ Returns:<br>
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)<br>
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)<br>
|
||||
},<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"showReviewsLink": "A String", # URL to show reviews for this volume<br>
|
||||
"writeReviewLink": "A String", # URL to write a review for this volume<br>
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)<br>
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)<br>
|
||||
@@ -170,6 +176,32 @@ Args:<br>
|
||||
Allowed values<br>
|
||||
newest - Most recently published.<br>
|
||||
relevance - Relevance to search terms.<br>
|
||||
projection: string, Restrict information returned to a set of selected fields.<br>
|
||||
Allowed values<br>
|
||||
full - Includes all volume data.<br>
|
||||
lite - Includes a subset of fields in volumeInfo and accessInfo.<br>
|
||||
showPreorders: boolean, Set to true to show books available for preorder. Defaults to false.<br>
|
||||
download: string, Restrict to volumes by download availability.<br>
|
||||
Allowed values<br>
|
||||
epub - All volumes with epub.<br>
|
||||
startIndex: integer, Index of the first result to return (starts at 0)<br>
|
||||
partner: string, Restrict and brand results for partner ID.<br>
|
||||
q: string, Full-text search query string. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
strict: string, A parameter<br>
|
||||
maxResults: integer, Maximum number of results to return.<br>
|
||||
libraryRestrict: string, Restrict search to this user's library.<br>
|
||||
Allowed values<br>
|
||||
my-library - Restrict to the user's library, any shelf.<br>
|
||||
no-restrict - Do not restrict based on user's library.<br>
|
||||
langRestrict: string, Restrict results to books with this language code.<br>
|
||||
printType: string, Restrict to books or magazines.<br>
|
||||
Allowed values<br>
|
||||
all - All volume content types.<br>
|
||||
books - Just books.<br>
|
||||
magazines - Just magazines.<br>
|
||||
filter: string, Filter search results.<br>
|
||||
Allowed values<br>
|
||||
ebooks - All Google eBooks.<br>
|
||||
@@ -177,30 +209,7 @@ Args:<br>
|
||||
full - Public can view entire volume text.<br>
|
||||
paid-ebooks - Google eBook with a price.<br>
|
||||
partial - Public able to see parts of text.<br>
|
||||
projection: string, Restrict information returned to a set of selected fields.<br>
|
||||
Allowed values<br>
|
||||
full - Includes all volume data.<br>
|
||||
lite - Includes a subset of fields in volumeInfo and accessInfo.<br>
|
||||
libraryRestrict: string, Restrict search to this user's library.<br>
|
||||
Allowed values<br>
|
||||
my-library - Restrict to the user's library, any shelf.<br>
|
||||
no-restrict - Do not restrict based on user's library.<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
langRestrict: string, Restrict results to books with this language code.<br>
|
||||
country: string, ISO-3166-1 code to override the IP-based location.<br>
|
||||
printType: string, Restrict to books or magazines.<br>
|
||||
Allowed values<br>
|
||||
all - All volume content types.<br>
|
||||
books - Just books.<br>
|
||||
magazines - Just magazines.<br>
|
||||
startIndex: integer, Index of the first result to return (starts at 0)<br>
|
||||
maxResults: integer, Maximum number of results to return.<br>
|
||||
q: string, Full-text search query string. (required)<br>
|
||||
partner: string, Restrict and brand results for partner ID.<br>
|
||||
download: string, Restrict to volumes by download availability.<br>
|
||||
Allowed values<br>
|
||||
epub - All volumes with epub.<br>
|
||||
showPreorders: boolean, Set to true to show books available for preorder. Defaults to false.<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -229,6 +238,7 @@ Returns:<br>
|
||||
"message": "A String", # Error/warning message.<br>
|
||||
},<br>
|
||||
"country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)<br>
|
||||
"viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.<br>
|
||||
"textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.<br>
|
||||
"pdf": { # Information about pdf content. (In LITE projection.)<br>
|
||||
"isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)<br>
|
||||
@@ -263,18 +273,8 @@ Returns:<br>
|
||||
},<br>
|
||||
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)<br>
|
||||
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)<br>
|
||||
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."<br>
|
||||
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br>
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)<br>
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.<br>
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.<br>
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.<br>
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeId": "A String", # Volume id associated with this reading position.<br>
|
||||
"pdfPosition": "A String", # Position in a PDF file.<br>
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.<br>
|
||||
},<br>
|
||||
"review": { # This user's review of this volume, if one exists.<br>
|
||||
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.<br>
|
||||
"kind": "books#review", # Resource type for a review.<br>
|
||||
@@ -293,27 +293,24 @@ Returns:<br>
|
||||
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.<br>
|
||||
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.<br>
|
||||
},<br>
|
||||
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)<br>
|
||||
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)<br>
|
||||
"kind": "books#readingPosition", # Resource type for a reading position.<br>
|
||||
"gbImagePosition": "A String", # Position in a volume for image-based content.<br>
|
||||
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.<br>
|
||||
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeId": "A String", # Volume id associated with this reading position.<br>
|
||||
"pdfPosition": "A String", # Position in a PDF file.<br>
|
||||
"gbTextPosition": "A String", # Position in a volume for text-based content.<br>
|
||||
},<br>
|
||||
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)<br>
|
||||
},<br>
|
||||
"volumeInfo": { # General volume information.<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"subtitle": "A String", # Volume subtitle. (In LITE projection.)<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"pageCount": 42, # Total number of pages.<br>
|
||||
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)<br>
|
||||
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)<br>
|
||||
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)<br>
|
||||
@@ -322,21 +319,33 @@ Returns:<br>
|
||||
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)<br>
|
||||
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)<br>
|
||||
},<br>
|
||||
"publishedDate": "A String", # Date of publication. (In LITE projection.)<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.<br>
|
||||
"dimensions": { # Physical dimensions of this volume.<br>
|
||||
"width": "A String", # Width of this volume (in cm).<br>
|
||||
"thickness": "A String", # Thickness of this volume (in cm).<br>
|
||||
"height": "A String", # Height or length of this volume (in cm).<br>
|
||||
},<br>
|
||||
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)<br>
|
||||
"industryIdentifiers": [ # Industry standard identifiers for this volume.<br>
|
||||
{<br>
|
||||
"identifier": "A String", # Industry specific volume identifier.<br>
|
||||
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"title": "A String", # Volume title. (In LITE projection.)<br>
|
||||
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"publisher": "A String", # Publisher of this volume. (In LITE projection.)<br>
|
||||
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.<br>
|
||||
"previewLink": "A String", # URL to preview this volume on the Google Books site.<br>
|
||||
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.<br>
|
||||
"showReviewsLink": "A String", # URL to show reviews for this volume<br>
|
||||
"writeReviewLink": "A String", # URL to write a review for this volume<br>
|
||||
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)<br>
|
||||
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)<br>
|
||||
"ratingsCount": 42, # The number of review ratings for this volume.<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique identifier for a volume. (In LITE projection.)<br>
|
||||
"selfLink": "A String", # URL to this resource. (In LITE projection.)<br>
|
||||
|
||||
@@ -17,14 +17,22 @@
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes an access control rule.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
ruleId: string, ACL rule identifier. (required)<br>
|
||||
calendarId: string, Calendar identifier. (required)</tt></dd></dl>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns an access control rule.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
ruleId: string, ACL rule identifier. (required)<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -75,7 +83,11 @@ Args:<br>
|
||||
"id": "A String", # Identifier of the ACL rule.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -103,7 +115,11 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the rules in the access control list for the calendar.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -161,8 +177,12 @@ Args:<br>
|
||||
"id": "A String", # Identifier of the ACL rule.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
ruleId: string, ACL rule identifier. (required)<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -213,8 +233,12 @@ Args:<br>
|
||||
"id": "A String", # Identifier of the ACL rule.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
ruleId: string, ACL rule identifier. (required)<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,12 +17,20 @@
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes an entry on the user's calendar list.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
calendarId: string, Calendar identifier. (required)</tt></dd></dl>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns an entry on the user's calendar list.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -89,6 +97,10 @@ Args:<br>
|
||||
"id": "A String", # Identifier of the calendar.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -124,6 +136,8 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns entries on the user's calendar list.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
minAccessRole: string, The minimum access role for the user in the returned entires. Optional. The default is no restriction.<br>
|
||||
Allowed values<br>
|
||||
freeBusyReader - The user can read free/busy information.<br>
|
||||
@@ -133,6 +147,8 @@ Args:<br>
|
||||
maxResults: integer, Maximum number of entries returned on one result page. Optional.<br>
|
||||
pageToken: string, Token specifying which result page to return. Optional.<br>
|
||||
showHidden: boolean, Whether to show hidden entries. Optional. The default is False.<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -216,7 +232,11 @@ Args:<br>
|
||||
"id": "A String", # Identifier of the calendar.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -283,7 +303,11 @@ Args:<br>
|
||||
"id": "A String", # Identifier of the calendar.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,17 +17,29 @@
|
||||
<dl><dt><a name="Resource-clear"><strong>clear</strong></a> = method(self, **kwargs)</dt><dd><tt>Clears a primary calendar. This operation deletes all data associated with the primary calendar of an account and cannot be undone.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
calendarId: string, Calendar identifier. (required)</tt></dd></dl>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes a secondary calendar.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
calendarId: string, Calendar identifier. (required)</tt></dd></dl>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns metadata for a calendar.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -58,6 +70,10 @@ Args:<br>
|
||||
"id": "A String", # Identifier of the calendar.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -88,7 +104,11 @@ Args:<br>
|
||||
"id": "A String", # Identifier of the calendar.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -119,7 +139,11 @@ Args:<br>
|
||||
"id": "A String", # Identifier of the calendar.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,6 +17,10 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the color definitions for calendars and events.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -18,14 +18,22 @@
|
||||
<br>
|
||||
Args:<br>
|
||||
eventId: string, Event identifier. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
sendNotifications: boolean, Whether to send notifications about the deletion of the event. Optional. The default is False.<br>
|
||||
calendarId: string, Calendar identifier. (required)</tt></dd></dl>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns an event.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
eventId: string, Event identifier. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.<br>
|
||||
maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.<br>
|
||||
<br>
|
||||
@@ -34,10 +42,12 @@ Returns:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
@@ -148,10 +158,12 @@ Args:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
@@ -254,17 +266,23 @@ Args:<br>
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
@@ -375,10 +393,12 @@ Args:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
@@ -481,18 +501,24 @@ Args:<br>
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
sendNotifications: boolean, Whether to send notifications about the creation of the new event. Optional. The default is False.<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
@@ -600,9 +626,13 @@ Returns:<br>
|
||||
Args:<br>
|
||||
eventId: string, Recurring event identifier. (required)<br>
|
||||
pageToken: string, Token specifying which result page to return. Optional.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
maxResults: integer, Maximum number of events returned on one result page. Optional.<br>
|
||||
showDeleted: boolean, Whether to include deleted events (with 'eventStatus' equals 'cancelled') in the result. Optional. The default is False.<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.<br>
|
||||
originalStart: string, The original start time of the instance in the result. Optional.<br>
|
||||
maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.<br>
|
||||
@@ -626,10 +656,12 @@ Returns:<br>
|
||||
"items": [ # List of events on the calendar.<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
@@ -762,18 +794,22 @@ Args:<br>
|
||||
startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter "singleEvents" is True)<br>
|
||||
updated - Order by last modification time (ascending).<br>
|
||||
showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.<br>
|
||||
iCalUID: string, Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.<br>
|
||||
timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, Token specifying which result page to return. Optional.<br>
|
||||
updatedMin: string, Lower bound for an event's last modification time (as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp) to filter by. Optional. The default is not to filter by last modification time.<br>
|
||||
singleEvents: boolean, Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.<br>
|
||||
timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.<br>
|
||||
maxResults: integer, Maximum number of events returned on one result page. Optional.<br>
|
||||
q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.<br>
|
||||
showDeleted: boolean, Whether to include deleted events (with 'eventStatus' equals 'cancelled') in the result. Optional. The default is False.<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.<br>
|
||||
pageToken: string, Token specifying which result page to return. Optional.<br>
|
||||
timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.<br>
|
||||
strict: string, A parameter<br>
|
||||
maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.<br>
|
||||
iCalUID: string, Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.<br>
|
||||
maxResults: integer, Maximum number of events returned on one result page. Optional.<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.<br>
|
||||
q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.<br>
|
||||
userip: string, A parameter<br>
|
||||
timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -794,10 +830,12 @@ Returns:<br>
|
||||
"items": [ # List of events on the calendar.<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
@@ -926,19 +964,25 @@ Returns:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
eventId: string, Event identifier. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
sendNotifications: boolean, Whether to send notifications about the change of the event's organizer. Optional. The default is False.<br>
|
||||
destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)<br>
|
||||
calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
@@ -1050,10 +1094,12 @@ Args:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
@@ -1156,18 +1202,24 @@ Args:<br>
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
@@ -1273,19 +1325,25 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-quickAdd"><strong>quickAdd</strong></a> = method(self, **kwargs)</dt><dd><tt>Creates an event based on a simple text string.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
sendNotifications: boolean, Whether to send notifications about the creation of the event. Optional. The default is False.<br>
|
||||
text: string, The text describing the event to be created. (required)<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
@@ -1397,10 +1455,12 @@ Args:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
@@ -1503,18 +1563,24 @@ Args:<br>
|
||||
"privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.<br>
|
||||
calendarId: string, Calendar identifier. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"creator": { # The creator of the event. Read-only.<br>
|
||||
"self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The creator's name, if available.<br>
|
||||
"email": "A String", # The creator's email address, if available.<br>
|
||||
},<br>
|
||||
"organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.<br>
|
||||
"self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.<br>
|
||||
"displayName": "A String", # The organizer's name, if available.<br>
|
||||
"email": "A String", # The organizer's email address, if available.<br>
|
||||
},<br>
|
||||
|
||||
@@ -33,6 +33,10 @@ Args:<br>
|
||||
"timeZone": "A String", # Time zone used in the response. Optional. The default is UTC.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,7 +17,11 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns a single user setting.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
setting: string, Name of the user setting. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -32,6 +36,10 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns all user settings for the authenticated user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -18,6 +18,7 @@
|
||||
<br>
|
||||
Args:<br>
|
||||
dateRestrict: string, Specifies all search results are from a time period<br>
|
||||
hl: string, Sets the user interface language.<br>
|
||||
orTerms: string, Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms<br>
|
||||
highRange: string, Creates a range in form as_nlo value..as_nhi value and attempts to append it to query<br>
|
||||
num: integer, Number of search results to return<br>
|
||||
@@ -34,10 +35,12 @@ Args:<br>
|
||||
Allowed values<br>
|
||||
0 - Turns off duplicate content filter.<br>
|
||||
1 - Turns on duplicate content filter.<br>
|
||||
pp: string, A parameter<br>
|
||||
gl: string, Geolocation of end user.<br>
|
||||
searchType: string, Specifies the search type: image.<br>
|
||||
Allowed values<br>
|
||||
image - custom image search<br>
|
||||
strict: string, A parameter<br>
|
||||
fileType: string, Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...<br>
|
||||
start: integer, The index of the first result to return<br>
|
||||
imgDominantColor: string, Returns images of a specific dominant color: yellow, green, teal, blue, purple, pink, white, gray, black and brown.<br>
|
||||
@@ -93,6 +96,7 @@ Args:<br>
|
||||
cref: string, The URL of a linked custom search engine<br>
|
||||
sort: string, The sort expression to apply to the results<br>
|
||||
hq: string, Appends the extra query terms to the query.<br>
|
||||
trace: string, A parameter<br>
|
||||
c2coff: string, Turns off the translation between zh-CN and zh-TW.<br>
|
||||
googlehost: string, The local Google domain to use to perform the search.<br>
|
||||
safe: string, Search safety level<br>
|
||||
@@ -101,7 +105,6 @@ Args:<br>
|
||||
medium - Enables moderate safe search filtering.<br>
|
||||
off - Disables safe search filtering.<br>
|
||||
exactTerms: string, Identifies a phrase that all documents in the search results must contain<br>
|
||||
hl: string, Sets the user interface language.<br>
|
||||
lowRange: string, Creates a range in form as_nlo value..as_nhi value and attempts to append it to query<br>
|
||||
imgSize: string, Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.<br>
|
||||
Allowed values<br>
|
||||
@@ -122,6 +125,7 @@ Args:<br>
|
||||
q: string, Query (required)<br>
|
||||
linkSite: string, Specifies that all search results should contain a link to a particular URL<br>
|
||||
cx: string, The custom search engine ID to scope this search query<br>
|
||||
userip: string, A parameter<br>
|
||||
siteSearchFilter: string, Controls whether to include or exclude results from the site named in the as_sitesearch parameter<br>
|
||||
Allowed values<br>
|
||||
e - exclude<br>
|
||||
@@ -133,21 +137,23 @@ Returns:<br>
|
||||
{<br>
|
||||
"promotions": [<br>
|
||||
{<br>
|
||||
"link": "A String",<br>
|
||||
"title": "A String",<br>
|
||||
"displayLink": "A String",<br>
|
||||
"htmlTitle": "A String",<br>
|
||||
"link": "A String",<br>
|
||||
"bodyLines": [<br>
|
||||
{<br>
|
||||
"url": "A String",<br>
|
||||
"htmlTitle": "A String",<br>
|
||||
"link": "A String",<br>
|
||||
"title": "A String",<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"image": {<br>
|
||||
"source": "A String",<br>
|
||||
"width": 42,<br>
|
||||
"height": 42,<br>
|
||||
},<br>
|
||||
"bodyLines": [<br>
|
||||
{<br>
|
||||
"url": "A String",<br>
|
||||
"link": "A String",<br>
|
||||
"title": "A String",<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"title": "A String",<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "customsearch#search",<br>
|
||||
|
||||
@@ -17,8 +17,12 @@
|
||||
<dl><dt><a name="Resource-getRest"><strong>getRest</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieve the description of a particular version of an api.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
api: string, The name of the API. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
version: string, The version of the API. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -68,13 +72,17 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieve the list of APIs supported at this endpoint.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
name: string, Only include APIs with the given name.<br>
|
||||
trace: string, A parameter<br>
|
||||
preferred: boolean, Return only the preferred version of an API.<br>
|
||||
label: string, Only include APIs with a matching label, such as 'graduated' or 'labs'.<br>
|
||||
Allowed values<br>
|
||||
deprecated - APIs that have been deprecated.<br>
|
||||
graduated - Supported APIs that have graduated from labs.<br>
|
||||
labs - APIs that are experimental<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
389
docs/dyn/drive.v1.files.html
Normal file
389
docs/dyn/drive.v1.files.html
Normal file
@@ -0,0 +1,389 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets a file's metadata by id.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
projection: string, Restrict information returned for simplicity and optimization.<br>
|
||||
Allowed values<br>
|
||||
BASIC - Includes only the basic metadata fields<br>
|
||||
FULL - Includes all metadata fields<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
updateViewedDate: boolean, Whether to update the view date after successfully retrieving the file.<br>
|
||||
id: string, The id for the file in question. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"mimeType": "A String", # The mimetype of the file<br>
|
||||
"selfLink": "A String", # A link back to this file.<br>
|
||||
"kind": "drive#file", # The type of file. This is always drive#file<br>
|
||||
"description": "A String", # A short description of the file<br>
|
||||
"title": "A String", # The title of this file.<br>
|
||||
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"labels": { # Labels for the file.<br>
|
||||
"hidden": True or False, # Whether this file is hidden from the user<br>
|
||||
"starred": True or False, # Whether this file is starred by the user.<br>
|
||||
"trashed": True or False, # Whether this file has been trashed.<br>
|
||||
},<br>
|
||||
"indexableText": { # Indexable text attributes for the file (can only be written)<br>
|
||||
"text": "A String", # The text to be indexed for this file<br>
|
||||
},<br>
|
||||
"parentsCollection": [ # Collection of parent folders which contain this file.<br>
|
||||
# On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.<br>
|
||||
{<br>
|
||||
"parentLink": "A String", # A link to get the metadata for this parent<br>
|
||||
"id": "A String", # The id of this parent<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"userPermission": { # The permissions for the authenticated user on this file.<br>
|
||||
"type": "A String", # The type of permission (For example: user, group etc).<br>
|
||||
"kind": "drive#permission", # The kind of this permission. This is always drive#permission<br>
|
||||
"etag": "A String", # An etag for this permission.<br>
|
||||
"role": "A String", # The role that this permission describes. (For example: reader, writer, owner)<br>
|
||||
"additionalRoles": [ # Any additional roles that this permission describes.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"etag": "A String", # ETag of the file.<br>
|
||||
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.<br>
|
||||
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).<br>
|
||||
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"id": "A String", # The id of the file.<br>
|
||||
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.<br>
|
||||
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts a file, and any settable metadata or blob content sent with the request.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body.<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"mimeType": "A String", # The mimetype of the file<br>
|
||||
"selfLink": "A String", # A link back to this file.<br>
|
||||
"kind": "drive#file", # The type of file. This is always drive#file<br>
|
||||
"description": "A String", # A short description of the file<br>
|
||||
"title": "A String", # The title of this file.<br>
|
||||
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"labels": { # Labels for the file.<br>
|
||||
"hidden": True or False, # Whether this file is hidden from the user<br>
|
||||
"starred": True or False, # Whether this file is starred by the user.<br>
|
||||
"trashed": True or False, # Whether this file has been trashed.<br>
|
||||
},<br>
|
||||
"indexableText": { # Indexable text attributes for the file (can only be written)<br>
|
||||
"text": "A String", # The text to be indexed for this file<br>
|
||||
},<br>
|
||||
"parentsCollection": [ # Collection of parent folders which contain this file.<br>
|
||||
# On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.<br>
|
||||
{<br>
|
||||
"parentLink": "A String", # A link to get the metadata for this parent<br>
|
||||
"id": "A String", # The id of this parent<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"userPermission": { # The permissions for the authenticated user on this file.<br>
|
||||
"type": "A String", # The type of permission (For example: user, group etc).<br>
|
||||
"kind": "drive#permission", # The kind of this permission. This is always drive#permission<br>
|
||||
"etag": "A String", # An etag for this permission.<br>
|
||||
"role": "A String", # The role that this permission describes. (For example: reader, writer, owner)<br>
|
||||
"additionalRoles": [ # Any additional roles that this permission describes.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"etag": "A String", # ETag of the file.<br>
|
||||
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.<br>
|
||||
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).<br>
|
||||
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"id": "A String", # The id of the file.<br>
|
||||
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.<br>
|
||||
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
}<br>
|
||||
<br>
|
||||
media_body: string, The filename of the media request body.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"mimeType": "A String", # The mimetype of the file<br>
|
||||
"selfLink": "A String", # A link back to this file.<br>
|
||||
"kind": "drive#file", # The type of file. This is always drive#file<br>
|
||||
"description": "A String", # A short description of the file<br>
|
||||
"title": "A String", # The title of this file.<br>
|
||||
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"labels": { # Labels for the file.<br>
|
||||
"hidden": True or False, # Whether this file is hidden from the user<br>
|
||||
"starred": True or False, # Whether this file is starred by the user.<br>
|
||||
"trashed": True or False, # Whether this file has been trashed.<br>
|
||||
},<br>
|
||||
"indexableText": { # Indexable text attributes for the file (can only be written)<br>
|
||||
"text": "A String", # The text to be indexed for this file<br>
|
||||
},<br>
|
||||
"parentsCollection": [ # Collection of parent folders which contain this file.<br>
|
||||
# On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.<br>
|
||||
{<br>
|
||||
"parentLink": "A String", # A link to get the metadata for this parent<br>
|
||||
"id": "A String", # The id of this parent<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"userPermission": { # The permissions for the authenticated user on this file.<br>
|
||||
"type": "A String", # The type of permission (For example: user, group etc).<br>
|
||||
"kind": "drive#permission", # The kind of this permission. This is always drive#permission<br>
|
||||
"etag": "A String", # An etag for this permission.<br>
|
||||
"role": "A String", # The role that this permission describes. (For example: reader, writer, owner)<br>
|
||||
"additionalRoles": [ # Any additional roles that this permission describes.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"etag": "A String", # ETag of the file.<br>
|
||||
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.<br>
|
||||
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).<br>
|
||||
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"id": "A String", # The id of the file.<br>
|
||||
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.<br>
|
||||
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates file metadata and/or content. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"mimeType": "A String", # The mimetype of the file<br>
|
||||
"selfLink": "A String", # A link back to this file.<br>
|
||||
"kind": "drive#file", # The type of file. This is always drive#file<br>
|
||||
"description": "A String", # A short description of the file<br>
|
||||
"title": "A String", # The title of this file.<br>
|
||||
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"labels": { # Labels for the file.<br>
|
||||
"hidden": True or False, # Whether this file is hidden from the user<br>
|
||||
"starred": True or False, # Whether this file is starred by the user.<br>
|
||||
"trashed": True or False, # Whether this file has been trashed.<br>
|
||||
},<br>
|
||||
"indexableText": { # Indexable text attributes for the file (can only be written)<br>
|
||||
"text": "A String", # The text to be indexed for this file<br>
|
||||
},<br>
|
||||
"parentsCollection": [ # Collection of parent folders which contain this file.<br>
|
||||
# On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.<br>
|
||||
{<br>
|
||||
"parentLink": "A String", # A link to get the metadata for this parent<br>
|
||||
"id": "A String", # The id of this parent<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"userPermission": { # The permissions for the authenticated user on this file.<br>
|
||||
"type": "A String", # The type of permission (For example: user, group etc).<br>
|
||||
"kind": "drive#permission", # The kind of this permission. This is always drive#permission<br>
|
||||
"etag": "A String", # An etag for this permission.<br>
|
||||
"role": "A String", # The role that this permission describes. (For example: reader, writer, owner)<br>
|
||||
"additionalRoles": [ # Any additional roles that this permission describes.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"etag": "A String", # ETag of the file.<br>
|
||||
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.<br>
|
||||
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).<br>
|
||||
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"id": "A String", # The id of the file.<br>
|
||||
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.<br>
|
||||
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
newRevision: boolean, Whether a blob upload should create a new revision. If not set or false, the blob data in the current head revision will be replaced.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
updateViewedDate: boolean, Whether to update the view date after successfully updating the file.<br>
|
||||
updateModifiedDate: boolean, Controls updating the modified date of the file. If true, the modified date will be updated to the current time, regardless of whether other changes are being made. If false, the modified date will only be updated to the current time if other changes are also being made (changing the title, for example).<br>
|
||||
id: string, The id for the file in question. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"mimeType": "A String", # The mimetype of the file<br>
|
||||
"selfLink": "A String", # A link back to this file.<br>
|
||||
"kind": "drive#file", # The type of file. This is always drive#file<br>
|
||||
"description": "A String", # A short description of the file<br>
|
||||
"title": "A String", # The title of this file.<br>
|
||||
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"labels": { # Labels for the file.<br>
|
||||
"hidden": True or False, # Whether this file is hidden from the user<br>
|
||||
"starred": True or False, # Whether this file is starred by the user.<br>
|
||||
"trashed": True or False, # Whether this file has been trashed.<br>
|
||||
},<br>
|
||||
"indexableText": { # Indexable text attributes for the file (can only be written)<br>
|
||||
"text": "A String", # The text to be indexed for this file<br>
|
||||
},<br>
|
||||
"parentsCollection": [ # Collection of parent folders which contain this file.<br>
|
||||
# On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.<br>
|
||||
{<br>
|
||||
"parentLink": "A String", # A link to get the metadata for this parent<br>
|
||||
"id": "A String", # The id of this parent<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"userPermission": { # The permissions for the authenticated user on this file.<br>
|
||||
"type": "A String", # The type of permission (For example: user, group etc).<br>
|
||||
"kind": "drive#permission", # The kind of this permission. This is always drive#permission<br>
|
||||
"etag": "A String", # An etag for this permission.<br>
|
||||
"role": "A String", # The role that this permission describes. (For example: reader, writer, owner)<br>
|
||||
"additionalRoles": [ # Any additional roles that this permission describes.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"etag": "A String", # ETag of the file.<br>
|
||||
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.<br>
|
||||
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).<br>
|
||||
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"id": "A String", # The id of the file.<br>
|
||||
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.<br>
|
||||
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates file metadata and/or content<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body.<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"mimeType": "A String", # The mimetype of the file<br>
|
||||
"selfLink": "A String", # A link back to this file.<br>
|
||||
"kind": "drive#file", # The type of file. This is always drive#file<br>
|
||||
"description": "A String", # A short description of the file<br>
|
||||
"title": "A String", # The title of this file.<br>
|
||||
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"labels": { # Labels for the file.<br>
|
||||
"hidden": True or False, # Whether this file is hidden from the user<br>
|
||||
"starred": True or False, # Whether this file is starred by the user.<br>
|
||||
"trashed": True or False, # Whether this file has been trashed.<br>
|
||||
},<br>
|
||||
"indexableText": { # Indexable text attributes for the file (can only be written)<br>
|
||||
"text": "A String", # The text to be indexed for this file<br>
|
||||
},<br>
|
||||
"parentsCollection": [ # Collection of parent folders which contain this file.<br>
|
||||
# On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.<br>
|
||||
{<br>
|
||||
"parentLink": "A String", # A link to get the metadata for this parent<br>
|
||||
"id": "A String", # The id of this parent<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"userPermission": { # The permissions for the authenticated user on this file.<br>
|
||||
"type": "A String", # The type of permission (For example: user, group etc).<br>
|
||||
"kind": "drive#permission", # The kind of this permission. This is always drive#permission<br>
|
||||
"etag": "A String", # An etag for this permission.<br>
|
||||
"role": "A String", # The role that this permission describes. (For example: reader, writer, owner)<br>
|
||||
"additionalRoles": [ # Any additional roles that this permission describes.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"etag": "A String", # ETag of the file.<br>
|
||||
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.<br>
|
||||
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).<br>
|
||||
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"id": "A String", # The id of the file.<br>
|
||||
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.<br>
|
||||
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
}<br>
|
||||
<br>
|
||||
media_body: string, The filename of the media request body.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
newRevision: boolean, Whether a blob upload should create a new revision. If not set or false, the blob data in the current head revision will be replaced.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
updateViewedDate: boolean, Whether to update the view date after successfully updating the file.<br>
|
||||
updateModifiedDate: boolean, Controls updating the modified date of the file. If true, the modified date will be updated to the current time, regardless of whether other changes are being made. If false, the modified date will only be updated to the current time if other changes are also being made (changing the title, for example).<br>
|
||||
id: string, The id for the file in question. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"mimeType": "A String", # The mimetype of the file<br>
|
||||
"selfLink": "A String", # A link back to this file.<br>
|
||||
"kind": "drive#file", # The type of file. This is always drive#file<br>
|
||||
"description": "A String", # A short description of the file<br>
|
||||
"title": "A String", # The title of this file.<br>
|
||||
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"labels": { # Labels for the file.<br>
|
||||
"hidden": True or False, # Whether this file is hidden from the user<br>
|
||||
"starred": True or False, # Whether this file is starred by the user.<br>
|
||||
"trashed": True or False, # Whether this file has been trashed.<br>
|
||||
},<br>
|
||||
"indexableText": { # Indexable text attributes for the file (can only be written)<br>
|
||||
"text": "A String", # The text to be indexed for this file<br>
|
||||
},<br>
|
||||
"parentsCollection": [ # Collection of parent folders which contain this file.<br>
|
||||
# On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.<br>
|
||||
{<br>
|
||||
"parentLink": "A String", # A link to get the metadata for this parent<br>
|
||||
"id": "A String", # The id of this parent<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"userPermission": { # The permissions for the authenticated user on this file.<br>
|
||||
"type": "A String", # The type of permission (For example: user, group etc).<br>
|
||||
"kind": "drive#permission", # The kind of this permission. This is always drive#permission<br>
|
||||
"etag": "A String", # An etag for this permission.<br>
|
||||
"role": "A String", # The role that this permission describes. (For example: reader, writer, owner)<br>
|
||||
"additionalRoles": [ # Any additional roles that this permission describes.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"etag": "A String", # ETag of the file.<br>
|
||||
"fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.<br>
|
||||
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).<br>
|
||||
"fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.<br>
|
||||
"lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
"id": "A String", # The id of the file.<br>
|
||||
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.<br>
|
||||
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp).<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
28
docs/dyn/drive.v1.html
Normal file
28
docs/dyn/drive.v1.html
Normal file
@@ -0,0 +1,28 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-files"><strong><a href="drive.v1.files.html">files</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -17,8 +17,12 @@
|
||||
<dl><dt><a name="Resource-image"><strong>image</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the scaled/cropped image attached to a freebase node.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
maxwidth: integer, Maximum width in pixels for resulting image.<br>
|
||||
trace: string, A parameter<br>
|
||||
maxheight: integer, Maximum height in pixels for resulting image.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
fallbackid: string, Use the image associated with this secondary id if no image is associated with the primary id.<br>
|
||||
pad: boolean, A boolean specifying whether the resulting image should be padded up to the requested dimensions.<br>
|
||||
mode: string, Method used to scale or crop image.<br>
|
||||
@@ -33,8 +37,9 @@ Args:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
lang: string, The language of the results - an id of a /type/lang object.<br>
|
||||
cursor: string, The mql cursor.<br>
|
||||
pp: string, A parameter<br>
|
||||
indent: integer, How many spaces to indent the json.<br>
|
||||
trace: string, A parameter<br>
|
||||
callback: string, JS method name for JSONP callbacks.<br>
|
||||
uniqueness_failure: string, How MQL responds to uniqueness failures.<br>
|
||||
Allowed values<br>
|
||||
@@ -42,8 +47,11 @@ Args:<br>
|
||||
soft - Just return the first encountered object.<br>
|
||||
dateline: string, The dateline that you get in a mqlwrite response to ensure consistent results.<br>
|
||||
html_escape: boolean, Whether or not to escape entities.<br>
|
||||
cursor: string, The mql cursor.<br>
|
||||
cost: boolean, Show the costs or not.<br>
|
||||
userip: string, A parameter<br>
|
||||
query: string, An envelope containing a single MQL query. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
as_of_time: string, Run the query as it would've been run at the specified point in time.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-text"><strong><a href="freebase.v1.text.html">text</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
@@ -17,12 +17,16 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns blob attached to node at specified id as HTML<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
format: string, Sanitizing transformation.<br>
|
||||
Allowed values<br>
|
||||
html - Return valid, sanitized html.<br>
|
||||
plain - Return plain text - strip html tags.<br>
|
||||
raw - Return the entire content as-is.<br>
|
||||
strict: string, A parameter<br>
|
||||
maxlength: integer, The max number of characters to return. Valid only for 'plain' format.<br>
|
||||
userip: string, A parameter<br>
|
||||
id: string, The id of the item that you want data about (required) (repeated)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -17,20 +17,24 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves data about a single advertiser if that the requesting advertiser/publisher has access to it. Only publishers can lookup advertisers. Advertisers can request information about themselves by omitting the advertiserId query parameter.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
||||
advertiserId: string, The ID of the advertiser to look up. Optional.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)<br>
|
||||
Allowed values<br>
|
||||
advertisers - The requester is requesting as an advertiser.<br>
|
||||
publishers - The requester is requesting as a publisher.<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{ # An AdvertiserResource.<br>
|
||||
"category": "A String", # Category that this advertiser belongs to. A valid list of categories can be found here: <a href="http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581">http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581</a><br>
|
||||
"productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.<br>
|
||||
"kind": "gan#advertiser", # The kind for an advertiser. The kind for one entity.<br>
|
||||
"contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.<br>
|
||||
"kind": "gan#advertiser", # The kind for an advertiser.<br>
|
||||
"siteUrl": "A String", # URL of the website this advertiser advertises from.<br>
|
||||
"contactPhone": "A String", # Phone that this advertiser would like publishers to contact them with.<br>
|
||||
"description": "A String", # Description of the website the advertiser advertises from.<br>
|
||||
@@ -45,11 +49,12 @@ Returns:<br>
|
||||
"amount": 3.14, # The amount of money.<br>
|
||||
"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
|
||||
},<br>
|
||||
"contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.<br>
|
||||
"allowPublisherCreatedLinks": True or False, # True if the advertiser allows publisher created links, otherwise false.<br>
|
||||
"item": # Object with schema name: Advertiser # The requested advertiser.<br>
|
||||
"joinDate": "A String", # Date that this advertiser was approved as a Google Affiliate Network advertiser.<br>
|
||||
"logoUrl": "A String", # URL to the logo this advertiser uses on the Google Affiliate Network.<br>
|
||||
"id": "A String", # The ID of this advertiser.<br>
|
||||
"productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.<br>
|
||||
"name": "A String", # The name of this advertiser.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
@@ -63,16 +68,20 @@ Args:<br>
|
||||
deactivated - Deactivated means either the advertiser has removed you from their program, or it could also mean that you chose to remove yourself from the advertiser's program.<br>
|
||||
declined - An advertiser that did not approve your application.<br>
|
||||
pending - An advertiser program that you've already applied to, but they haven't yet decided to approve or decline your application.<br>
|
||||
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
||||
minNinetyDayEpc: number, Filters out all advertisers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.<br>
|
||||
advertiserCategory: string, Caret(^) delimted list of advertiser categories. Valid categories are defined here: <a href="http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581">http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581</a>. Filters out all advertisers not in one of the given advertiser categories. Optional.<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, The value of 'nextPageToken' from the previous page. Optional.<br>
|
||||
pp: string, A parameter<br>
|
||||
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
||||
advertiserCategory: string, Caret(^) delimted list of advertiser categories. Valid categories are defined here: <a href="http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581">http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581</a>. Filters out all advertisers not in one of the given advertiser categories. Optional.<br>
|
||||
minNinetyDayEpc: number, Filters out all advertisers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.<br>
|
||||
strict: string, A parameter<br>
|
||||
role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)<br>
|
||||
Allowed values<br>
|
||||
advertisers - The requester is requesting as an advertiser.<br>
|
||||
publishers - The requester is requesting as a publisher.<br>
|
||||
maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.<br>
|
||||
minSevenDayEpc: number, Filters out all advertisers that have a seven day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.<br>
|
||||
userip: string, A parameter<br>
|
||||
minPayoutRank: integer, A value between 1 and 4, where 1 represents the quartile of advertisers with the lowest ranks and 4 represents the quartile of advertisers with the highest ranks. Filters out all advertisers with a lower rank than the given quartile. For example if a 2 was given only advertisers with a payout rank of 25 or higher would be included. Optional.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -83,8 +92,8 @@ Returns:<br>
|
||||
"items": [ # The advertiser list.<br>
|
||||
{ # An AdvertiserResource.<br>
|
||||
"category": "A String", # Category that this advertiser belongs to. A valid list of categories can be found here: <a href="http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581">http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581</a><br>
|
||||
"productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.<br>
|
||||
"kind": "gan#advertiser", # The kind for an advertiser. The kind for one entity.<br>
|
||||
"contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.<br>
|
||||
"kind": "gan#advertiser", # The kind for an advertiser.<br>
|
||||
"siteUrl": "A String", # URL of the website this advertiser advertises from.<br>
|
||||
"contactPhone": "A String", # Phone that this advertiser would like publishers to contact them with.<br>
|
||||
"description": "A String", # Description of the website the advertiser advertises from.<br>
|
||||
@@ -99,11 +108,12 @@ Returns:<br>
|
||||
"amount": 3.14, # The amount of money.<br>
|
||||
"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
|
||||
},<br>
|
||||
"contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.<br>
|
||||
"allowPublisherCreatedLinks": True or False, # True if the advertiser allows publisher created links, otherwise false.<br>
|
||||
"item": # Object with schema name: Advertiser # The requested advertiser.<br>
|
||||
"joinDate": "A String", # Date that this advertiser was approved as a Google Affiliate Network advertiser.<br>
|
||||
"logoUrl": "A String", # URL to the logo this advertiser uses on the Google Affiliate Network.<br>
|
||||
"id": "A String", # The ID of this advertiser.<br>
|
||||
"productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.<br>
|
||||
"name": "A String", # The name of this advertiser.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
|
||||
@@ -18,11 +18,15 @@
|
||||
<br>
|
||||
Args:<br>
|
||||
advertiser: string, The advertiser ID of a card issuer whose offers to include. Optional, may be repeated. (repeated)<br>
|
||||
pp: string, A parameter<br>
|
||||
projection: string, The set of fields to return.<br>
|
||||
Allowed values<br>
|
||||
full - Include all offer fields<br>
|
||||
summary - Include only the basic fields needed to display an offer. This is the default.<br>
|
||||
full - Include all offer fields. This is the default.<br>
|
||||
summary - Include only the basic fields needed to display an offer.<br>
|
||||
publisher: string, The ID of the publisher in question. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -66,7 +70,6 @@ Returns:<br>
|
||||
"prohibitedCategories": [ # Categories in which the issuer does not wish the card to be displayed. A summary field.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"creditRatingDisplay": "A String", # Text describing the credit ratings required for recipients of this card, for example "Excellent/Good." A summary field.<br>
|
||||
"fraudLiability": "A String", # If you get coverage when you use the card for the given activity, this field describes it.<br>
|
||||
"cashAdvanceTerms": "A String", # Text describing the terms for cash advances. A summary field.<br>
|
||||
"landingPageUrl": "A String", # The link to the issuer's page for this card. A summary field.<br>
|
||||
@@ -82,6 +85,7 @@ Returns:<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"extendedWarranty": "A String", # If you get coverage when you use the card for the given activity, this field describes it.<br>
|
||||
"emergencyInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.<br>
|
||||
"firstYearAnnualFee": 3.14, # The annual fee for the first year, if different from the ongoing fee. Optional.<br>
|
||||
"trackingUrl": "A String", # The link to ping to register a click on this offer. A summary field.<br>
|
||||
"latePaymentFee": "A String", # Text describing how much a late payment will cost, eg "up to $35." A summary field.<br>
|
||||
@@ -101,6 +105,7 @@ Returns:<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"ageMinimum": 3.14, # The youngest a recipient of this card may be.<br>
|
||||
"balanceComputationMethod": "A String", # Text describing how the balance is computed. A summary field.<br>
|
||||
"aprDisplay": "A String", # Text describing the purchase APR. A summary field.<br>
|
||||
"additionalCardHolderFee": "A String", # Any extra fees levied on card holders.<br>
|
||||
"variableRatesLastUpdated": "A String", # When variable rates were last updated.<br>
|
||||
@@ -108,7 +113,7 @@ Returns:<br>
|
||||
"purchaseRateType": "A String", # Fixed or variable.<br>
|
||||
"statementCopyFee": "A String", # Fee for requesting a copy of your statement.<br>
|
||||
"rewardsHaveBlackoutDates": True or False, # For airline miles rewards, tells whether blackout dates apply to the miles.<br>
|
||||
"emergencyInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.<br>
|
||||
"creditRatingDisplay": "A String", # Text describing the credit ratings required for recipients of this card, for example "Excellent/Good." A summary field.<br>
|
||||
"flightAccidentInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.<br>
|
||||
"annualRewardMaximum": 3.14, # The largest number of units you may accumulate in a year.<br>
|
||||
"balanceTransferTerms": "A String", # Text describing the terms for balance transfers. A summary field.<br>
|
||||
|
||||
@@ -18,12 +18,23 @@
|
||||
<br>
|
||||
Args:<br>
|
||||
orderId: string, Caret(^) delimited list of order IDs. Filters out all events that do not reference one of the given order IDs. Optional.<br>
|
||||
chargeType: string, Filters out all charge events that are not of the given charge type. Valid values: 'other', 'slotting_fee', 'monthly_minimum', 'tier_bonus', 'credit', 'debit'. Optional.<br>
|
||||
Allowed values<br>
|
||||
credit - A credit increases the publisher's payout amount and decreases the advertiser's invoice amount.<br>
|
||||
debit - A debit reduces the publisher's payout and increases the advertiser's invoice amount.<br>
|
||||
monthly_minimum - A payment made to Google by an advertiser as a minimum monthly network fee.<br>
|
||||
other - Catch all. Default if unset<br>
|
||||
slotting_fee - A one time payment made from an advertiser to a publisher.<br>
|
||||
tier_bonus - A payment from an advertiser to a publisher for the publisher maintaining a high tier level<br>
|
||||
linkId: string, Caret(^) delimited list of link IDs. Filters out all events that do not reference one of the given link IDs. Optional.<br>
|
||||
advertiserId: string, Caret(^) delimited list of advertiser IDs. Filters out all events that do not reference one of the given advertiser IDs. Only used when under publishers role. Optional.<br>
|
||||
sku: string, Caret(^) delimited list of SKUs. Filters out all events that do not reference one of the given SKU. Optional.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, The value of 'nextPageToken' from the previous page. Optional.<br>
|
||||
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
||||
productCategory: string, Caret(^) delimited list of product categories. Filters out all events that do not reference a product in one of the given product categories. Optional.<br>
|
||||
pageToken: string, The value of 'nextPageToken' from the previous page. Optional.<br>
|
||||
strict: string, A parameter<br>
|
||||
role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)<br>
|
||||
Allowed values<br>
|
||||
advertisers - The requester is requesting as an advertiser.<br>
|
||||
@@ -41,16 +52,9 @@ Args:<br>
|
||||
modifyDateMax: string, Filters out all events modified later than given date. Optional. Defaults to 24 hours after modifyDateMin, if modifyDateMin is explicitly set.<br>
|
||||
eventDateMin: string, Filters out all events earlier than given date. Optional. Defaults to 24 hours from current date/time.<br>
|
||||
maxResults: integer, Max number of offers to return in this page. Optional. Defaults to 20.<br>
|
||||
chargeType: string, Filters out all charge events that are not of the given charge type. Valid values: 'other', 'slotting_fee', 'monthly_minimum', 'tier_bonus', 'credit', 'debit'. Optional.<br>
|
||||
Allowed values<br>
|
||||
credit - A credit increases the publisher's payout amount and decreases the advertiser's invoice amount.<br>
|
||||
debit - A debit reduces the publisher's payout and increases the advertiser's invoice amount.<br>
|
||||
monthly_minimum - A payment made to Google by an advertiser as a minimum monthly network fee.<br>
|
||||
other - Catch all. Default if unset<br>
|
||||
slotting_fee - A one time payment made from an advertiser to a publisher.<br>
|
||||
tier_bonus - A payment from an advertiser to a publisher for the publisher maintaining a high tier level<br>
|
||||
eventDateMax: string, Filters out all events later than given date. Optional. Defaults to 24 hours after eventMin.<br>
|
||||
memberId: string, Caret(^) delimited list of member IDs. Filters out all events that do not reference one of the given member IDs. Optional.<br>
|
||||
userip: string, A parameter<br>
|
||||
publisherId: string, Caret(^) delimited list of publisher IDs. Filters out all events that do not reference one of the given publishers IDs. Only used when under advertiser role. Optional.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -20,6 +20,8 @@
|
||||
|
||||
<dl><dt><a name="Resource-events"><strong><a href="gan.v1beta1.events.html">events</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-links"><strong><a href="gan.v1beta1.links.html">links</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-publishers"><strong><a href="gan.v1beta1.publishers.html">publishers</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
|
||||
244
docs/dyn/gan.v1beta1.links.html
Normal file
244
docs/dyn/gan.v1beta1.links.html
Normal file
@@ -0,0 +1,244 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves data about a single link if the requesting advertiser/publisher has access to it. Advertisers can look up their own links. Publishers can look up visible links or links belonging to advertisers they are in a relationship with.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)<br>
|
||||
Allowed values<br>
|
||||
advertisers - The requester is requesting as an advertiser.<br>
|
||||
publishers - The requester is requesting as a publisher.<br>
|
||||
linkId: string, The ID of the link to look up. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{ # A LinkResource.<br>
|
||||
"startDate": "A String", # Date that this link becomes active.<br>
|
||||
"kind": "gan#link", # The kind for one entity.<br>
|
||||
"endDate": "A String", # Date that this link becomes inactive.<br>
|
||||
"description": "A String", # Description.<br>
|
||||
"name": "A String", # The logical name for this link.<br>
|
||||
"createDate": "A String", # Date that this link was created.<br>
|
||||
"imageAltText": "A String", # image alt text.<br>
|
||||
"id": "A String", # The ID of this link.<br>
|
||||
"advertiserId": "A String", # The advertiser id for the advertiser who owns this link.<br>
|
||||
"creativeType": "A String", # Creative Type.<br>
|
||||
"promotionType": "A String", # Promotion Type<br>
|
||||
"duration": "A String", # Duration<br>
|
||||
"authorship": "A String", # Authorship<br>
|
||||
"availability": "A String", # Availability.<br>
|
||||
"isActive": True or False, # Flag for if this link is active.<br>
|
||||
"destinationUrl": "A String", # The destination URL for the link.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts a new link.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{ # A LinkResource.<br>
|
||||
"startDate": "A String", # Date that this link becomes active.<br>
|
||||
"kind": "gan#link", # The kind for one entity.<br>
|
||||
"endDate": "A String", # Date that this link becomes inactive.<br>
|
||||
"description": "A String", # Description.<br>
|
||||
"name": "A String", # The logical name for this link.<br>
|
||||
"createDate": "A String", # Date that this link was created.<br>
|
||||
"imageAltText": "A String", # image alt text.<br>
|
||||
"id": "A String", # The ID of this link.<br>
|
||||
"advertiserId": "A String", # The advertiser id for the advertiser who owns this link.<br>
|
||||
"creativeType": "A String", # Creative Type.<br>
|
||||
"promotionType": "A String", # Promotion Type<br>
|
||||
"duration": "A String", # Duration<br>
|
||||
"authorship": "A String", # Authorship<br>
|
||||
"availability": "A String", # Availability.<br>
|
||||
"isActive": True or False, # Flag for if this link is active.<br>
|
||||
"destinationUrl": "A String", # The destination URL for the link.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)<br>
|
||||
Allowed values<br>
|
||||
advertisers - The requester is requesting as an advertiser.<br>
|
||||
publishers - The requester is requesting as a publisher.<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{ # A LinkResource.<br>
|
||||
"startDate": "A String", # Date that this link becomes active.<br>
|
||||
"kind": "gan#link", # The kind for one entity.<br>
|
||||
"endDate": "A String", # Date that this link becomes inactive.<br>
|
||||
"description": "A String", # Description.<br>
|
||||
"name": "A String", # The logical name for this link.<br>
|
||||
"createDate": "A String", # Date that this link was created.<br>
|
||||
"imageAltText": "A String", # image alt text.<br>
|
||||
"id": "A String", # The ID of this link.<br>
|
||||
"advertiserId": "A String", # The advertiser id for the advertiser who owns this link.<br>
|
||||
"creativeType": "A String", # Creative Type.<br>
|
||||
"promotionType": "A String", # Promotion Type<br>
|
||||
"duration": "A String", # Duration<br>
|
||||
"authorship": "A String", # Authorship<br>
|
||||
"availability": "A String", # Availability.<br>
|
||||
"isActive": True or False, # Flag for if this link is active.<br>
|
||||
"destinationUrl": "A String", # The destination URL for the link.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves all links that match the query parameters.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
linkType: string, The type of the link.<br>
|
||||
Allowed values<br>
|
||||
banner - <br>
|
||||
text - <br>
|
||||
promotionType: string, The promotion type. (repeated)<br>
|
||||
Allowed values<br>
|
||||
buy_get - <br>
|
||||
coupon - <br>
|
||||
free_gift - <br>
|
||||
free_gift_wrap - <br>
|
||||
free_shipping - <br>
|
||||
none - <br>
|
||||
ongoing - <br>
|
||||
percent_off - <br>
|
||||
price_cut - <br>
|
||||
product_promotion - <br>
|
||||
sale - <br>
|
||||
sweepstakes - <br>
|
||||
advertiserId: string, Limits the resulting links to the ones belonging to the listed advertisers. (repeated)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
||||
pageToken: string, The value of 'nextPageToken' from the previous page. Optional.<br>
|
||||
role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)<br>
|
||||
Allowed values<br>
|
||||
advertisers - The requester is requesting as an advertiser.<br>
|
||||
publishers - The requester is requesting as a publisher.<br>
|
||||
relationshipStatus: string, The status of the relationship.<br>
|
||||
Allowed values<br>
|
||||
approved - <br>
|
||||
available - <br>
|
||||
maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.<br>
|
||||
advertiserCategory: string, The advertiser's primary vertical. (repeated)<br>
|
||||
Allowed values<br>
|
||||
apparel_accessories - <br>
|
||||
appliances_electronics - <br>
|
||||
auto_dealer - <br>
|
||||
automotive - <br>
|
||||
babies_kids - <br>
|
||||
blogs_personal_sites - <br>
|
||||
books_magazines - <br>
|
||||
computers - <br>
|
||||
dating - <br>
|
||||
department_stores - <br>
|
||||
education - <br>
|
||||
employment - <br>
|
||||
financial_credit_cards - <br>
|
||||
financial_other - <br>
|
||||
flowers_gifts - <br>
|
||||
grocery - <br>
|
||||
health_beauty - <br>
|
||||
home_garden - <br>
|
||||
hosting_domain - <br>
|
||||
internet_providers - <br>
|
||||
legal - <br>
|
||||
media_entertainment - <br>
|
||||
medical - <br>
|
||||
movies_games - <br>
|
||||
music - <br>
|
||||
nonprofit - <br>
|
||||
office_supplies - <br>
|
||||
online_games - <br>
|
||||
outdoor - <br>
|
||||
pets - <br>
|
||||
real_estate - <br>
|
||||
restaurants - <br>
|
||||
sport_fitness - <br>
|
||||
telecom - <br>
|
||||
ticketing - <br>
|
||||
toys_hobbies - <br>
|
||||
travel - <br>
|
||||
utilities - <br>
|
||||
wholesale_relationship - <br>
|
||||
wine_spirits - <br>
|
||||
authorship: string, The role of the author of the link.<br>
|
||||
Allowed values<br>
|
||||
advertiser - <br>
|
||||
publisher - <br>
|
||||
startDateMin: string, The beginning of the start date range.<br>
|
||||
assetSize: string, The size of the given asset. (repeated)<br>
|
||||
startDateMax: string, The end of the start date range.<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"nextPageToken": "A String", # The next page token.<br>
|
||||
"items": [ # The links.<br>
|
||||
{ # A LinkResource.<br>
|
||||
"startDate": "A String", # Date that this link becomes active.<br>
|
||||
"kind": "gan#link", # The kind for one entity.<br>
|
||||
"endDate": "A String", # Date that this link becomes inactive.<br>
|
||||
"description": "A String", # Description.<br>
|
||||
"name": "A String", # The logical name for this link.<br>
|
||||
"createDate": "A String", # Date that this link was created.<br>
|
||||
"imageAltText": "A String", # image alt text.<br>
|
||||
"id": "A String", # The ID of this link.<br>
|
||||
"advertiserId": "A String", # The advertiser id for the advertiser who owns this link.<br>
|
||||
"creativeType": "A String", # Creative Type.<br>
|
||||
"promotionType": "A String", # Promotion Type<br>
|
||||
"duration": "A String", # Duration<br>
|
||||
"authorship": "A String", # Authorship<br>
|
||||
"availability": "A String", # Availability.<br>
|
||||
"isActive": True or False, # Flag for if this link is active.<br>
|
||||
"destinationUrl": "A String", # The destination URL for the link.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "gan#links", # The kind for a page of links.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -17,11 +17,15 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves data about a single advertiser if that the requesting advertiser/publisher has access to it. Only advertisers can look up publishers. Publishers can request information about themselves by omitting the publisherId query parameter.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)<br>
|
||||
Allowed values<br>
|
||||
advertisers - The requester is requesting as an advertiser.<br>
|
||||
publishers - The requester is requesting as a publisher.<br>
|
||||
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
publisherId: string, The ID of the publisher to look up. Optional.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -29,7 +33,7 @@ Returns:<br>
|
||||
<br>
|
||||
{ # A PublisherResource.<br>
|
||||
"status": "A String", # The status of the requesting advertiser's relationship with this publisher.<br>
|
||||
"kind": "gan#publisher", # The kind for one publisher. The kind for a publisher.<br>
|
||||
"kind": "gan#publisher", # The kind for a publisher.<br>
|
||||
"name": "A String", # The name of this publisher.<br>
|
||||
"classification": "A String", # Classification that this publisher belongs to. See this link for all publisher classifications: <a href="http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4">http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4</a><br>
|
||||
"epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher divided by the total number of clicks over the past seven days. Values are multiplied by 100 for display purposes.<br>
|
||||
@@ -60,15 +64,19 @@ Args:<br>
|
||||
deactivated - A publisher that you terminated from your program. Publishers also have the ability to remove themselves from your program.<br>
|
||||
declined - A publisher that you did not approve to your program.<br>
|
||||
pending - Publishers that have applied to your program. We recommend reviewing and deciding on pending publishers on a weekly basis.<br>
|
||||
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, The value of 'nextPageToken' from the previous page. Optional.<br>
|
||||
minSevenDayEpc: number, Filters out all publishers that have a seven day EPC average lower than the given value (inclusive). Min value 0.0. Optional.<br>
|
||||
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
minNinetyDayEpc: number, Filters out all publishers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.<br>
|
||||
strict: string, A parameter<br>
|
||||
role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)<br>
|
||||
Allowed values<br>
|
||||
advertisers - The requester is requesting as an advertiser.<br>
|
||||
publishers - The requester is requesting as a publisher.<br>
|
||||
maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.<br>
|
||||
userip: string, A parameter<br>
|
||||
minPayoutRank: integer, A value between 1 and 4, where 1 represents the quartile of publishers with the lowest ranks and 4 represents the quartile of publishers with the highest ranks. Filters out all publishers with a lower rank than the given quartile. For example if a 2 was given only publishers with a payout rank of 25 or higher would be included. Optional.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -79,7 +87,7 @@ Returns:<br>
|
||||
"items": [ # The entity list.<br>
|
||||
{ # A PublisherResource.<br>
|
||||
"status": "A String", # The status of the requesting advertiser's relationship with this publisher.<br>
|
||||
"kind": "gan#publisher", # The kind for one publisher. The kind for a publisher.<br>
|
||||
"kind": "gan#publisher", # The kind for a publisher.<br>
|
||||
"name": "A String", # The name of this publisher.<br>
|
||||
"classification": "A String", # Classification that this publisher belongs to. See this link for all publisher classifications: <a href="http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4">http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4</a><br>
|
||||
"epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher divided by the total number of clicks over the past seven days. Values are multiplied by 100 for display purposes.<br>
|
||||
|
||||
@@ -17,7 +17,11 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one resource by id.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
groupUniqueId: string, The resource ID (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -82,7 +86,11 @@ Args:<br>
|
||||
"allowGoogleCommunication": "A String", # Is google allowed to contact admins.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
groupUniqueId: string, The resource ID (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -147,7 +155,11 @@ Args:<br>
|
||||
"allowGoogleCommunication": "A String", # Is google allowed to contact admins.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
groupUniqueId: string, The resource ID (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -16,12 +16,23 @@
|
||||
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes the authenticated user's current location.<br>
|
||||
<br>
|
||||
Args:</tt></dd></dl>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the authenticated user's current location.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
granularity: string, Granularity of the requested location.<br>
|
||||
Allowed values<br>
|
||||
best - Request best available granularity.<br>
|
||||
city - Request city-level granularty.<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -58,6 +69,10 @@ Args:<br>
|
||||
"accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,13 +17,24 @@
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes a location from the user's location history.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
locationId: string, Timestamp of the location to delete (ms since epoch). (required)</tt></dd></dl>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
locationId: string, Timestamp of the location to delete (ms since epoch). (required)<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Reads a location from the user's location history.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
locationId: string, Timestamp of the location to read (ms since epoch). (required)<br>
|
||||
granularity: string, Granularity of the location to return.<br>
|
||||
Allowed values<br>
|
||||
best - Request best available granularity.<br>
|
||||
city - Request city-level granularty.<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -60,6 +71,10 @@ Args:<br>
|
||||
"accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -80,10 +95,17 @@ Returns:<br>
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists the user's location history.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
min_time: string, Minimum timestamp of locations to return (ms since epoch).<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: string, Maximum number of locations to return.<br>
|
||||
max_time: string, Maximum timestamp of locations to return (ms since epoch).<br>
|
||||
granularity: string, Granularity of the requested locations.<br>
|
||||
Allowed values<br>
|
||||
best - Request best available granularity.<br>
|
||||
city - Request city-level granularty.<br>
|
||||
max_time: string, Maximum timestamp of locations to return (ms since epoch).<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,6 +17,10 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists the featured series.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,6 +17,10 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists all series created by the authenticated user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,6 +17,10 @@
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists the series the authenticated user has visited.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,6 +17,10 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the profile information for the authenticated user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -61,6 +65,10 @@ Args:<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -105,6 +113,10 @@ Args:<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -19,8 +19,9 @@
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
topicId: integer, The decimal ID of the Topic within the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
unauthToken: string, User identifier for unauthenticated usage mode<br>
|
||||
parentSubmissionId: integer, The decimal ID of the parent Submission within the Series. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
@@ -73,6 +74,9 @@ Args:<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
parentSubmissionId: integer, The decimal ID of the parent Submission within the Series. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
anonymous: boolean, Set to true to mark the new submission as anonymous.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -132,11 +136,15 @@ Returns:<br>
|
||||
Args:<br>
|
||||
sort: string, Sort order.<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
author: string, Restricts the results to submissions by a specific author.<br>
|
||||
submissionId: integer, The decimal ID of the Submission within the Series. (required)<br>
|
||||
q: string, Search query.<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, Maximum number of results to return.<br>
|
||||
hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, Index of the first result to be retrieved.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -18,6 +18,10 @@
|
||||
<br>
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -94,6 +98,10 @@ Args:<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -135,7 +143,11 @@ Returns:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
q: string, Search query.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, Maximum number of results to return.<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, Index of the first result to be retrieved.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -219,6 +231,10 @@ Args:<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -300,6 +316,10 @@ Args:<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -19,10 +19,14 @@
|
||||
Args:<br>
|
||||
sort: string, Sort order.<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
author: string, Restricts the results to submissions by a specific author.<br>
|
||||
q: string, Search query.<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, Maximum number of results to return.<br>
|
||||
hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, Index of the first result to be retrieved.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -19,11 +19,15 @@
|
||||
Args:<br>
|
||||
lang: string, The language code for the language the client prefers resuls in.<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
includeVotes: boolean, Specifies whether to include the current user's vote<br>
|
||||
author: string, Restricts the results to submissions by a specific author.<br>
|
||||
sort: string, Sort order.<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, Maximum number of results to return.<br>
|
||||
q: string, Search query.<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, Index of the first result to be retrieved.<br>
|
||||
hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.<br>
|
||||
<br>
|
||||
|
||||
@@ -19,8 +19,12 @@
|
||||
Args:<br>
|
||||
lang: string, The language code for the language the client prefers resuls in.<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
includeVotes: boolean, Specifies whether to include the current user's vote<br>
|
||||
submissionId: integer, The decimal ID of the Submission within the Series. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -79,7 +83,9 @@ Returns:<br>
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
topicId: integer, The decimal ID of the Topic within the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
unauthToken: string, User identifier for unauthenticated usage mode<br>
|
||||
strict: string, A parameter<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
@@ -132,6 +138,8 @@ Args:<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
userip: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
anonymous: boolean, Set to true to mark the new submission as anonymous.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
|
||||
@@ -18,8 +18,12 @@
|
||||
<br>
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
tagId: string, A parameter (required)<br>
|
||||
submissionId: integer, The decimal ID of the Submission within the Series. (required)</tt></dd></dl>
|
||||
submissionId: integer, The decimal ID of the Submission within the Series. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts a new tag for the specified submission within the specified series.<br>
|
||||
<br>
|
||||
@@ -38,7 +42,11 @@ Args:<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
submissionId: integer, The decimal ID of the Submission within the Series. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -57,7 +65,11 @@ Returns:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
submissionId: integer, The decimal ID of the Submission within the Series. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -19,6 +19,10 @@
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
topicId: integer, The decimal ID of the Topic within the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -184,6 +188,10 @@ Args:<br>
|
||||
"name": "A String",<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -270,8 +278,12 @@ Returns:<br>
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
q: string, Search query.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, Maximum number of results to return.<br>
|
||||
mode: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, Index of the first result to be retrieved.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -366,6 +378,8 @@ Returns:<br>
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
topicId: integer, The decimal ID of the Topic within the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
@@ -446,6 +460,8 @@ Args:<br>
|
||||
"name": "A String",<br>
|
||||
}<br>
|
||||
<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -19,11 +19,15 @@
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
topicId: integer, The decimal ID of the Topic within the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
includeVotes: boolean, Specifies whether to include the current user's vote<br>
|
||||
author: string, Restricts the results to submissions by a specific author.<br>
|
||||
sort: string, Sort order.<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, Maximum number of results to return.<br>
|
||||
q: string, Search query.<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, Index of the first result to be retrieved.<br>
|
||||
hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.<br>
|
||||
<br>
|
||||
|
||||
@@ -18,9 +18,13 @@
|
||||
<br>
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
unauthToken: string, User identifier for unauthenticated usage mode<br>
|
||||
userId: string, A parameter<br>
|
||||
submissionId: integer, The decimal ID of the Submission within the Series. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -52,8 +56,12 @@ Args:<br>
|
||||
"kind": "moderator#vote",<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
unauthToken: string, User identifier for unauthenticated usage mode<br>
|
||||
submissionId: integer, The decimal ID of the Submission within the Series. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -72,7 +80,11 @@ Returns:<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, Maximum number of results to return.<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, Index of the first result to be retrieved.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
@@ -110,9 +122,13 @@ Args:<br>
|
||||
"kind": "moderator#vote",<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
unauthToken: string, User identifier for unauthenticated usage mode<br>
|
||||
userId: string, A parameter<br>
|
||||
submissionId: integer, The decimal ID of the Submission within the Series. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -144,9 +160,13 @@ Args:<br>
|
||||
"kind": "moderator#vote",<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
unauthToken: string, User identifier for unauthenticated usage mode<br>
|
||||
userId: string, A parameter<br>
|
||||
submissionId: integer, The decimal ID of the Submission within the Series. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -14,48 +14,15 @@
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-issueTokenGet"><strong>issueTokenGet</strong></a> = method(self, **kwargs)</dt><dd><tt>A description of how to use this function<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
origin: string, A parameter<br>
|
||||
force: boolean, A parameter<br>
|
||||
client_id: string, A parameter (required)<br>
|
||||
alg: string, A parameter<br>
|
||||
app_id: string, A parameter<br>
|
||||
android_device_id: string, A parameter<br>
|
||||
audience: string, A parameter<br>
|
||||
hl: string, A parameter<br>
|
||||
scope: string, A parameter (required)<br>
|
||||
response_type: string, A parameter (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"consent": {<br>
|
||||
"scopes": [<br>
|
||||
{<br>
|
||||
"description": "A String",<br>
|
||||
"detail": "A String",<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"oauthClient": {<br>
|
||||
"iconUri": "A String",<br>
|
||||
"developerEmail": "A String",<br>
|
||||
"name": "A String",<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"token": "A String",<br>
|
||||
"code": "A String",<br>
|
||||
"issueAdvice": "A String",<br>
|
||||
"idToken": "A String",<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-tokeninfo"><strong>tokeninfo</strong></a> = method(self, **kwargs)</dt><dd><tt>A description of how to use this function<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
access_token: string, A parameter<br>
|
||||
id_token: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -64,7 +31,7 @@ Returns:<br>
|
||||
"issued_to": "A String", # To whom was the token issued to. In general the same as audience.<br>
|
||||
"user_id": "A String", # The Gaia obfuscated user id.<br>
|
||||
"expires_in": 42, # The expiry time of the token, as number of seconds left until expiry.<br>
|
||||
"access_type": "A String", # The access type granted with this toke. It can be offline or online.<br>
|
||||
"access_type": "A String", # The access type granted with this token. It can be offline or online.<br>
|
||||
"audience": "A String", # Who is the intended audience for this token. In general the same as issued_to.<br>
|
||||
"scope": "A String", # The space separated list of scopes granted to this token.<br>
|
||||
"email": "A String", # The email address of the user. Present only if the email scope is present in the request.<br>
|
||||
|
||||
@@ -17,23 +17,27 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>A description of how to use this function<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"family_name": "A String",<br>
|
||||
"name": "A String",<br>
|
||||
"picture": "A String",<br>
|
||||
"locale": "A String",<br>
|
||||
"gender": "A String",<br>
|
||||
"email": "A String",<br>
|
||||
"birthday": "A String",<br>
|
||||
"link": "A String",<br>
|
||||
"given_name": "A String",<br>
|
||||
"timezone": "A String",<br>
|
||||
"id": "A String",<br>
|
||||
"verified_email": True or False,<br>
|
||||
"family_name": "A String", # The user's last name.<br>
|
||||
"name": "A String", # The user's full name.<br>
|
||||
"picture": "A String", # URL of the user's picture image.<br>
|
||||
"locale": "A String", # The user's default locale.<br>
|
||||
"gender": "A String", # The user's gender.<br>
|
||||
"email": "A String", # The user's email address.<br>
|
||||
"birthday": "A String", # The user's birthday. The year is not present.<br>
|
||||
"link": "A String", # URL of the profile page.<br>
|
||||
"given_name": "A String", # The user's first name.<br>
|
||||
"timezone": "A String", # The user's default timezone.<br>
|
||||
"id": "A String", # The focus obfuscated gaia id of the user.<br>
|
||||
"verified_email": True or False, # Boolean flag which is true if the email address is verified.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-v2"><strong><a href="oauth2.v2.userinfo.v2.html">v2</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
@@ -17,23 +17,27 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>A description of how to use this function<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"family_name": "A String",<br>
|
||||
"name": "A String",<br>
|
||||
"picture": "A String",<br>
|
||||
"locale": "A String",<br>
|
||||
"gender": "A String",<br>
|
||||
"email": "A String",<br>
|
||||
"birthday": "A String",<br>
|
||||
"link": "A String",<br>
|
||||
"given_name": "A String",<br>
|
||||
"timezone": "A String",<br>
|
||||
"id": "A String",<br>
|
||||
"verified_email": True or False,<br>
|
||||
"family_name": "A String", # The user's last name.<br>
|
||||
"name": "A String", # The user's full name.<br>
|
||||
"picture": "A String", # URL of the user's picture image.<br>
|
||||
"locale": "A String", # The user's default locale.<br>
|
||||
"gender": "A String", # The user's gender.<br>
|
||||
"email": "A String", # The user's email address.<br>
|
||||
"birthday": "A String", # The user's birthday. The year is not present.<br>
|
||||
"link": "A String", # URL of the profile page.<br>
|
||||
"given_name": "A String", # The user's first name.<br>
|
||||
"timezone": "A String", # The user's default timezone.<br>
|
||||
"id": "A String", # The focus obfuscated gaia id of the user.<br>
|
||||
"verified_email": True or False, # Boolean flag which is true if the email address is verified.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
|
||||
@@ -17,8 +17,12 @@
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Excludes an element from the ACL of the activity.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
userId: string, ID of the user to be removed from the activity. (required)<br>
|
||||
activityId: string, ID of the activity. (required)</tt></dd></dl>
|
||||
strict: string, A parameter<br>
|
||||
activityId: string, ID of the activity. (required)<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
|
||||
@@ -17,20 +17,28 @@
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes an existing activity, if the access controls allow it.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
activityId: string, ID of the activity to remove. (required)</tt></dd></dl>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
activityId: string, ID of the activity to remove. (required)<br>
|
||||
userip: string, A parameter</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of activities.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, A continuation token that allows pagination.<br>
|
||||
hl: string, Specifies the interface language (host language) of your user interface.<br>
|
||||
userId: string, The ID of the user whose activities will be listed. Can be me to refer to the viewer (i.e. the authenticated user). (required)<br>
|
||||
maxResults: integer, The maximum number of activities to include in the response.<br>
|
||||
strict: string, A parameter<br>
|
||||
collection: string, The collection of activities to list. (required)<br>
|
||||
Allowed values<br>
|
||||
all - All activities created by the specified user that the authenticated user is authorized to view.<br>
|
||||
scraps - The specified user's scrapbook.<br>
|
||||
stream - The specified user's stream feed, intended for consumption. This includes activities posted by people that the user is following, and activities in which the user has been mentioned.<br>
|
||||
hl: string, Specifies the interface language (host language) of your user interface.<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
@@ -17,7 +17,11 @@
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the visibility of an existing activity.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
activityId: string, ID of the activity to get the visibility. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -58,7 +62,11 @@ Args:<br>
|
||||
],<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
activityId: string, ID of the activity. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
@@ -99,7 +107,11 @@ Args:<br>
|
||||
],<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
activityId: string, ID of the activity. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user