From b417caf3c9cfa17ebce4d08357d67d9d88c67c21 Mon Sep 17 00:00:00 2001 From: Joe Gregorio Date: Thu, 8 Dec 2011 12:04:24 -0500 Subject: [PATCH] Updated generated docs --- docs/apiclient.anyjson.html | 2 +- docs/apiclient.discovery.html | 9 +- docs/apiclient.errors.html | 200 +++++- docs/apiclient.ext.appengine.html | 2 +- docs/apiclient.html | 3 +- docs/apiclient.http.html | 58 +- docs/apiclient.model.html | 92 ++- docs/apiclient.oauth.html | 10 +- docs/dyn/adsense.v1.adclients.html | 19 +- docs/dyn/adsense.v1.adunits.html | 25 +- docs/dyn/adsense.v1.customchannels.html | 19 +- docs/dyn/adsense.v1.reports.html | 31 +- docs/dyn/adsense.v1.urlchannels.html | 18 +- docs/dyn/analytics.v3.html | 4 +- .../dyn/analytics.v3.management.accounts.html | 31 +- docs/dyn/analytics.v3.management.goals.html | 71 +- .../dyn/analytics.v3.management.profiles.html | 44 +- .../dyn/analytics.v3.management.segments.html | 29 +- ...analytics.v3.management.webproperties.html | 38 +- docs/dyn/audit.v1.activities.html | 41 +- docs/dyn/blogger.v2.blogs.html | 29 +- docs/dyn/blogger.v2.comments.html | 63 +- docs/dyn/blogger.v2.pages.html | 59 +- docs/dyn/blogger.v2.posts.html | 75 ++- docs/dyn/blogger.v2.users.blogs.html | 34 +- docs/dyn/blogger.v2.users.html | 23 +- docs/dyn/books.v1.bookshelves.html | 41 +- docs/dyn/books.v1.bookshelves.volumes.html | 140 +++- docs/dyn/books.v1.mylibrary.bookshelves.html | 41 +- ...ooks.v1.mylibrary.bookshelves.volumes.html | 138 +++- docs/dyn/books.v1.mylibrary.html | 2 + docs/dyn/books.v1.volumes.html | 269 +++++++- docs/dyn/customsearch.v1.cse.html | 59 +- docs/dyn/discovery.v1.apis.html | 70 +- docs/dyn/freebase.v1.text.html | 9 +- docs/dyn/latitude.v1.currentLocation.html | 51 +- docs/dyn/latitude.v1.location.html | 74 ++- docs/dyn/moderator.v1.featured.series.html | 43 +- docs/dyn/moderator.v1.my.series.html | 43 +- docs/dyn/moderator.v1.myrecent.series.html | 43 +- docs/dyn/moderator.v1.profiles.html | 104 ++- docs/dyn/moderator.v1.responses.html | 164 ++++- docs/dyn/moderator.v1.series.html | 300 ++++++++- docs/dyn/moderator.v1.series.responses.html | 43 +- docs/dyn/moderator.v1.series.submissions.html | 59 +- docs/dyn/moderator.v1.submissions.html | 159 ++++- docs/dyn/moderator.v1.tags.html | 47 +- docs/dyn/moderator.v1.topics.html | 491 +++++++++++++- docs/dyn/moderator.v1.topics.submissions.html | 59 +- docs/dyn/moderator.v1.votes.html | 116 +++- docs/dyn/orkut.v2.activities.html | 119 +++- docs/dyn/orkut.v2.activityVisibility.html | 94 ++- docs/dyn/orkut.v2.badges.html | 39 +- docs/dyn/orkut.v2.comments.html | 140 +++- docs/dyn/orkut.v2.counters.html | 24 +- docs/dyn/orkut.v2.scraps.html | 223 ++++++- docs/dyn/pagespeedonline.v1.pagespeedapi.html | 40 +- docs/dyn/plus.v1.activities.html | 351 +++++++++- docs/dyn/plus.v1.comments.html | 78 ++- docs/dyn/plus.v1.people.html | 294 +++++++- docs/dyn/prediction.v1.4.hostedmodels.html | 29 +- docs/dyn/prediction.v1.4.trainedmodels.html | 175 ++++- docs/dyn/shopping.v1.products.html | 609 ++++++++++++++++- docs/dyn/siteVerification.v1.webResource.html | 133 +++- docs/dyn/taskqueue.v1beta1.taskqueues.html | 28 +- docs/dyn/taskqueue.v1beta1.tasks.html | 52 +- docs/dyn/tasks.v1.tasklists.html | 102 ++- docs/dyn/tasks.v1.tasks.html | 259 +++++++- docs/dyn/translate.v2.detections.html | 17 +- docs/dyn/translate.v2.languages.html | 14 +- docs/dyn/translate.v2.translations.html | 14 +- docs/dyn/transparencyreport.v1.traffic.html | 18 +- docs/dyn/urlshortener.v1.url.html | 625 +++++++++++++++++- docs/dyn/webfonts.v1.webfonts.html | 17 +- docs/oauth2client.appengine.html | 230 ++++++- docs/oauth2client.client.html | 234 ++++++- docs/oauth2client.clientsecrets.html | 6 +- docs/oauth2client.file.html | 2 +- docs/oauth2client.html | 9 +- docs/oauth2client.multistore_file.html | 8 +- 80 files changed, 7365 insertions(+), 212 deletions(-) diff --git a/docs/apiclient.anyjson.html b/docs/apiclient.anyjson.html index 77e5b88..a2995a0 100644 --- a/docs/apiclient.anyjson.html +++ b/docs/apiclient.anyjson.html @@ -20,7 +20,7 @@ we get a simplejson module from.

Modules         -
django.utils.simplejson
+
simplejson

diff --git a/docs/apiclient.discovery.html b/docs/apiclient.discovery.html index 2cec87e..1f594cb 100644 --- a/docs/apiclient.discovery.html +++ b/docs/apiclient.discovery.html @@ -25,10 +25,11 @@ A client library for Google's discovery based 
apiclient.mimeparse
mimetypes
os
-		re
-django.utils.simplejson
-uritemplate
-		urllib
+		random
+re
+simplejson
+		uritemplate
+urllib
urlparse

diff --git a/docs/apiclient.errors.html b/docs/apiclient.errors.html index 80b320f..56b67d4 100644 --- a/docs/apiclient.errors.html +++ b/docs/apiclient.errors.html @@ -20,7 +20,7 @@ should be defined in this file.

Modules -
       
django.utils.simplejson
+
simplejson

@@ -35,12 +35,15 @@ should be defined in this file.

Error
-
HttpError +
BatchError +
HttpError
InvalidJsonError
MediaUploadSizeError +
ResumableUploadError
UnacceptableMimeTypeError
UnexpectedBodyError
UnexpectedMethodError +
UnknownApiNameOrVersion
UnknownLinkType
@@ -51,6 +54,67 @@ should be defined in this file.

+ + + + +
 
+class BatchError(Error)
   Error occured during batch operations.
 
 
Method resolution order:
+
BatchError
+
Error
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors inherited from Error:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + @@ -69,7 +133,7 @@ Data descriptors defined here:
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -191,7 +255,7 @@ Data descriptors inherited from Error:
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -252,7 +316,7 @@ Data descriptors inherited from Error:
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -282,6 +346,67 @@ Use of negative indices is not supported.
__unicode__(...)
+
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+
 
class Error(exceptions.Exception)
   

+ + + + + + + +
 
+class ResumableUploadError(Error)
   Error occured during resumable upload.
 
 
Method resolution order:
+
ResumableUploadError
+
Error
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors inherited from Error:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+
Data descriptors inherited from exceptions.BaseException:
__dict__
@@ -313,7 +438,7 @@ Data descriptors inherited from Error:
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -465,6 +590,67 @@ Use of negative indices is not supported.
__unicode__(...)
+
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + + + +
 
+class UnknownApiNameOrVersion(Error)
   No API with that name and version exists.
 
 
Method resolution order:
+
UnknownApiNameOrVersion
+
Error
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors inherited from Error:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+
Data descriptors inherited from exceptions.BaseException:
__dict__
@@ -496,7 +682,7 @@ Data descriptors inherited from Error:
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
diff --git a/docs/apiclient.ext.appengine.html b/docs/apiclient.ext.appengine.html index b5aafca..9a59842 100644 --- a/docs/apiclient.ext.appengine.html +++ b/docs/apiclient.ext.appengine.html @@ -8,7 +8,7 @@ 		 
 
apiclient.ext.appengine		index
/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/ext/appengine.py
+>index
/usr/local/google/home/jcgregorio/projects/apiclient-release/apiclient/ext/appengine.py

Utilities for Google App Engine
 
Utilities for making it easier to use the
diff --git a/docs/apiclient.html b/docs/apiclient.html index 891c4f7..1920d38 100644 --- a/docs/apiclient.html +++ b/docs/apiclient.html @@ -26,5 +26,6 @@ mimeparse
model
oauth
- +schema
+ \ No newline at end of file diff --git a/docs/apiclient.http.html b/docs/apiclient.http.html index d35f7fa..3776a97 100644 --- a/docs/apiclient.http.html +++ b/docs/apiclient.http.html @@ -21,10 +21,18 @@ actuall HTTP request.

Modules         -
httplib2
+
StringIO
+copy
+gzip
+		httplib2
+apiclient.mimeparse
+mimetypes
os
-		django.utils.simplejson
-

+simplejson
+urllib
+urlparse
+uuid
+

 
@@ -50,7 +58,7 @@ actuall HTTP request.

Encapsulates a single HTTP request.
 
  Methods defined here:
-
__init__(self, http, postproc, uri, method='GET', body=None, headers=None, methodId=None)
Constructor for an HttpRequest.
+
__init__(self, http, postproc, uri, method='GET', body=None, headers=None, methodId=None, resumable=None)
Constructor for an HttpRequest.
 
Args:
  http: httplib2.Http, the transport object to use to make a request
@@ -59,9 +67,10 @@ Args:
            on an error.
  uri: string, the absolute URI to send the request to
  method: string, the HTTP method to use
-  body: string, the request body of the HTTP request
+  body: string, the request body of the HTTP request,
  headers: dict, the HTTP request headers
-  methodId: string, a unique identifier for the API method being called.
+  methodId: string, a unique identifier for the API method being called.
+  resumable: MediaUpload, None if this is not a resumbale request.
execute(self, http=None)
Execute the request.
 
@@ -77,6 +86,37 @@ Raises:
  apiclient.errors.HttpError if the response was not a 2xx.
  httplib2.Error if a transport error has occured.
+
next_chunk(self, http=None)
Execute the next step of a resumable upload.
+ 
+Can only be used if the method being executed supports media uploads and
+the MediaUpload object passed in was flagged as using resumable upload.
+ 
+Example:
+ 
+  media = MediaFileUpload('smiley.png', mimetype='image/png',
+                          chunksize=1000, resumable=True)
+  request = service.objects().insert(
+      bucket=buckets['items'][0]['id'],
+      name='smiley.png',
+      media_body=media)
+ 
+  response = None
+  while response is None:
+    status, response = request.next_chunk()
+    if status:
+      print "Upload %d%% complete." % int(status.progress() * 100)
+ 
+ 
+Returns:
+  (status, body): (ResumableMediaStatus, object)
+     The body will be None until the resumable media is fully uploaded.
+ +
to_json(self)
Returns a JSON representation of the HttpRequest.
+ +
+Static methods defined here:
+
from_json(s, http, postproc)
Returns an HttpRequest populated with info from a JSON object.
+
Data descriptors defined here:
__dict__
@@ -111,14 +151,14 @@ Example:
  apiclient.discovery.build("plus", "v1", requestBuilder=requestBuilder)
 
Methods that you do not supply a response for will return a
-200 OK with an empty string as the response content or raise an excpetion if
-check_unexpected is set to True. The methodId is taken from the rpcName
+200 OK with an empty string as the response content or raise an excpetion
+if check_unexpected is set to True. The methodId is taken from the rpcName
in the discovery document.
 
For more details see the project wiki.
 
  Methods defined here:
-
__call__(self, http, postproc, uri, method='GET', body=None, headers=None, methodId=None)
Implements the callable interface that discovery.build() expects
+
__call__(self, http, postproc, uri, method='GET', body=None, headers=None, methodId=None, resumable=None)
Implements the callable interface that discovery.build() expects
of requestBuilder, which is to build an object compatible with
HttpRequest.execute(). See that method for the description of the
parameters and the expected response.
diff --git a/docs/apiclient.model.html b/docs/apiclient.model.html index b15b85d..04d4fba 100644 --- a/docs/apiclient.model.html +++ b/docs/apiclient.model.html @@ -24,7 +24,7 @@ for converting between the wire format and th
       
gflags
logging
-		django.utils.simplejson
+		simplejson
urllib

@@ -44,7 +44,12 @@ for converting between the wire format and th
JsonModel -
ProtocolBufferModel +
+
+
RawModel +
+
+
ProtocolBufferModel
@@ -345,6 +350,89 @@ Returns:
Raises:
  apiclient.errors.HttpError if a non 2xx response is received. +
+Data descriptors inherited from Model:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + + + +
 
+class RawModel(JsonModel)
   Model class for requests that don't return JSON.
+ 
+Serializes and de-serializes between JSON and the Python
+object representation of HTTP request, and returns the raw bytes
+of the response body.
 
 
Method resolution order:
+
RawModel
+
JsonModel
+
BaseModel
+
Model
+
__builtin__.object
+
+
+Methods defined here:
+
deserialize(self, content)
+ +
+Data descriptors defined here:
+
no_content_response
+
+
+Data and other attributes defined here:
+
accept = '*/*'
+ +
alt_param = None
+ +
content_type = 'application/json'
+ +
+Methods inherited from JsonModel:
+
__init__(self, data_wrapper=False)
Construct a JsonModel.
+ 
+Args:
+  data_wrapper: boolean, wrap requests and responses in a data wrapper
+ +
serialize(self, body_value)
+ +
+Methods inherited from BaseModel:
+
request(self, headers, path_params, query_params, body_value)
Updates outgoing requests with a serialized body.
+ 
+Args:
+  headers: dict, request headers
+  path_params: dict, parameters that appear in the request path
+  query_params: dict, parameters that appear in the query
+  body_value: object, the request body as a Python object, which must be
+              serializable by simplejson.
+Returns:
+  A tuple of (headers, path_params, query, body)
+ 
+  headers: dict, request headers
+  path_params: dict, parameters that appear in the request path
+  query: string, query part of the request URI
+  body: string, the body serialized as JSON
+ +
response(self, resp, content)
Convert the response wire format into a Python object.
+ 
+Args:
+  resp: httplib2.Response, the HTTP response headers and status
+  content: string, the body of the HTTP response
+ 
+Returns:
+  The body de-serialized as a Python object.
+ 
+Raises:
+  apiclient.errors.HttpError if a non 2xx response is received.
+
Data descriptors inherited from Model:
__dict__
diff --git a/docs/apiclient.oauth.html b/docs/apiclient.oauth.html index de6234c..0e51ed3 100644 --- a/docs/apiclient.oauth.html +++ b/docs/apiclient.oauth.html @@ -23,7 +23,7 @@ Utilities for making it easier to work with&n httplib2
logging
oauth2
-		django.utils.simplejson
+		simplejson
urllib
urlparse

@@ -115,7 +115,7 @@ Data descriptors inherited from Error:<

Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -175,7 +175,7 @@ Data descriptors defined here:
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -303,7 +303,7 @@ Data descriptors inherited from Error:<
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -432,7 +432,7 @@ Data descriptors inherited from Error:<
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
diff --git a/docs/dyn/adsense.v1.adclients.html b/docs/dyn/adsense.v1.adclients.html index e155136..9ce30fc 100644 --- a/docs/dyn/adsense.v1.adclients.html +++ b/docs/dyn/adsense.v1.adclients.html @@ -18,7 +18,24 @@  
Args:
  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.
-  maxResults: integer, The maximum number of ad clients to include in the response, used for paging. +  maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
+    "items": [ # The ad clients returned in this list response.
+      {
+        "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
+        "kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.
+        "id": "A String", # Unique identifier of this ad client.
+        "supportsReporting": True or False, # Whether this ad client supports being reported on.
+      },
+    ],
+    "kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.
+    "etag": "A String", # ETag of this response for caching purposes.
+  }
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
diff --git a/docs/dyn/adsense.v1.adunits.html b/docs/dyn/adsense.v1.adunits.html index e2fea85..69d9f3c 100644 --- a/docs/dyn/adsense.v1.adunits.html +++ b/docs/dyn/adsense.v1.adunits.html @@ -20,7 +20,30 @@ Args:
  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.
  includeInactive: boolean, Whether to include inactive ad units. Default: true.
  adClientId: string, Ad client for which to list ad units. (required)
-  maxResults: integer, The maximum number of ad units to include in the response, used for paging.
+  maxResults: integer, The maximum number of ad units to include in the response, used for paging.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
+    "items": [ # The ad units returned in this list response.
+      {
+        "status": "A String", # Status of this ad unit. Possible values are:
+            # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
+            #
+            # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
+            #
+            # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
+        "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
+        "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
+        "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+        "name": "A String", # Name of this ad unit.
+      },
+    ],
+    "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
+    "etag": "A String", # ETag of this response for caching purposes.
+  }
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
diff --git a/docs/dyn/adsense.v1.customchannels.html b/docs/dyn/adsense.v1.customchannels.html index 1854eed..057aa26 100644 --- a/docs/dyn/adsense.v1.customchannels.html +++ b/docs/dyn/adsense.v1.customchannels.html @@ -19,7 +19,24 @@ Args:
  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.
  adClientId: string, Ad client for which to list custom channels. (required)
-  maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
+  maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
+    "items": [ # The custom channels returned in this list response.
+      {
+        "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
+        "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
+        "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+        "name": "A String", # Name of this custom channel.
+      },
+    ],
+    "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
+    "etag": "A String", # ETag of this response for caching purposes.
+  }
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
diff --git a/docs/dyn/adsense.v1.reports.html b/docs/dyn/adsense.v1.reports.html index cb7aa5f..2e47b0d 100644 --- a/docs/dyn/adsense.v1.reports.html +++ b/docs/dyn/adsense.v1.reports.html @@ -26,7 +26,36 @@ Args:
  maxResults: integer, The maximum number of rows of report data to return.
  filter: string, Filters to be run on the report. (repeated)
  startIndex: integer, Index of the first row of report data to return.
-  dimension: string, Dimensions to base the report on. (repeated)
+  dimension: string, Dimensions to base the report on. (repeated)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "adsense#report", # Kind this is, in this case adsense#report.
+    "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
+      [
+        "A String",
+      ],
+    ],
+    "warnings": [ # Any warnings associated with generation of the report.
+      "A String",
+    ],
+    "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+      "A String",
+    ],
+    "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
+      {
+        "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
+        "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
+        "name": "A String", # The name of the header.
+      },
+    ],
+    "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
+    "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
+      "A String",
+    ],
+  }
Data descriptors defined here:
diff --git a/docs/dyn/adsense.v1.urlchannels.html b/docs/dyn/adsense.v1.urlchannels.html index 401f989..8fa6084 100644 --- a/docs/dyn/adsense.v1.urlchannels.html +++ b/docs/dyn/adsense.v1.urlchannels.html @@ -19,7 +19,23 @@ Args:
  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.
  adClientId: string, Ad client for which to list URL channels. (required)
-  maxResults: integer, The maximum number of URL channels to include in the response, used for paging. +  maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
+    "items": [ # The URL channels returned in this list response.
+      {
+        "kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.
+        "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
+        "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
+      },
+    ],
+    "kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.
+    "etag": "A String", # ETag of this response for caching purposes.
+  }
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
diff --git a/docs/dyn/analytics.v3.html b/docs/dyn/analytics.v3.html index 6949bf9..621bd9b 100644 --- a/docs/dyn/analytics.v3.html +++ b/docs/dyn/analytics.v3.html @@ -14,9 +14,9 @@ Methods defined here:
__init__(self)
-
management = methodResource(self)
A collection resource.
+
data = methodResource(self)
A collection resource.
-
report = methodResource(self)
A collection resource.
+
management = methodResource(self)
A collection resource.
Data descriptors defined here:
diff --git a/docs/dyn/analytics.v3.management.accounts.html b/docs/dyn/analytics.v3.management.accounts.html index fbc469a..6c24c6a 100644 --- a/docs/dyn/analytics.v3.management.accounts.html +++ b/docs/dyn/analytics.v3.management.accounts.html @@ -17,8 +17,35 @@
list = method(self, **kwargs)
Lists all accounts to which the user has access.
 
Args:
-  max_results: string, The maximum number of entries to include in this response.
-  start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
+  max_results: integer, The maximum number of entries to include in this response.
+  start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "username": "A String", # Email ID of the authenticated user
+    "kind": "analytics#accounts", # Collection type.
+    "items": [ # A list of accounts.
+      {
+        "kind": "analytics#account", # Resource type for Analytics account.
+        "name": "A String", # Account name.
+        "created": "A String", # Time the account was created.
+        "updated": "A String", # Time the account was last modified.
+        "childLink": { # Child link for an account entry. Points to the list of web properties for this account.
+          "href": "A String", # Link to the list of web properties for this account.
+          "type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".
+        },
+        "id": "A String", # Account ID.
+        "selfLink": "A String", # Link for this account.
+      },
+    ],
+    "itemsPerPage": 42, # The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
+    "previousLink": "A String", # Previous link for this account collection.
+    "startIndex": 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.
+    "nextLink": "A String", # Next link for this account collection.
+    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/analytics.v3.management.goals.html b/docs/dyn/analytics.v3.management.goals.html index 9816a93..9fc3bdd 100644 --- a/docs/dyn/analytics.v3.management.goals.html +++ b/docs/dyn/analytics.v3.management.goals.html @@ -17,11 +17,78 @@
list = method(self, **kwargs)
Lists goals to which the user has access.
 
Args:
-  max_results: string, The maximum number of entries to include in this response.
+  max_results: integer, The maximum number of entries to include in this response.
  webPropertyId: string, Web property ID for the web properties 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)
  profileId: string, Profile ID for the web properties to retrieve. Can either be a specific profile ID or '~all', which refers to all the profiles to which the user has access. (required)
  start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
-  accountId: string, Account ID for the web properties to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)
+  accountId: string, Account ID for the web properties to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "username": "A String", # Email ID of the authenticated user
+    "kind": "analytics#goals", # Collection type.
+    "items": [ # A list of goals.
+      {
+        "kind": "analytics#goal", # Resource type for an Analytics goal.
+        "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
+          "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
+          "comparisonValue": "A String", # Value used for this comparison.
+        },
+        "name": "A String", # Goal name.
+        "created": "A String", # Time this goal was created.
+        "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
+          "url": "A String", # URL for this goal.
+          "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
+          "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
+          "steps": [ # List of steps configured for this goal funnel.
+            {
+              "url": "A String", # URL for this step.
+              "name": "A String", # Step name.
+              "number": 42, # Step number.
+            },
+          ],
+          "firstStepRequired": True or False, # Determines if the first step in this goal is required.
+        },
+        "updated": "A String", # Time this goal was last modified.
+        "value": 3.140000, # Goal value.
+        "visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.
+          "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.
+          "comparisonValue": "A String", # Value used for this comparison.
+        },
+        "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.
+        "eventDetails": { # Details for the goal of the type EVENT.
+          "eventConditions": [ # List of event conditions.
+            {
+              "type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.
+              "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
+              "expression": "A String", # Expression used for this match.
+              "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
+              "comparisonValue": "A String", # Value used for this comparison.
+            },
+          ],
+          "useEventValue": True or False, # Determines if the event value should be used as the value for this goal.
+        },
+        "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
+        "active": True or False, # Determines whether this goal is active.
+        "profileId": "A String", # Profile ID to which this goal belongs.
+        "parentLink": { # Parent link for a goal. Points to the profile to which this goal belongs.
+          "href": "A String", # Link to the profile to which this goal belongs.
+          "type": "analytics#profile", # Value is "analytics#profile".
+        },
+        "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
+        "id": "A String", # Goal ID.
+        "selfLink": "A String", # Link for this goal.
+        "accountId": "A String", # Account ID to which this goal belongs.
+      },
+    ],
+    "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
+    "previousLink": "A String", # Link to previous page for this goal collection.
+    "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
+    "nextLink": "A String", # Link to next page for this goal collection.
+    "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/analytics.v3.management.profiles.html b/docs/dyn/analytics.v3.management.profiles.html index f723d41..ce0e21e 100644 --- a/docs/dyn/analytics.v3.management.profiles.html +++ b/docs/dyn/analytics.v3.management.profiles.html @@ -17,10 +17,50 @@
list = method(self, **kwargs)
Lists profiles to which the user has access.
 
Args:
-  max_results: string, The maximum number of entries to include in this response.
+  max_results: integer, The maximum number of entries to include in this response.
  webPropertyId: string, Web property ID for the web properties 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)
  start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
-  accountId: string, Account ID for the web properties to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)
+  accountId: string, Account ID for the web properties to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "username": "A String", # Email ID of the authenticated user
+    "kind": "analytics#profiles", # Collection type.
+    "items": [ # A list of profiles.
+      {
+        "defaultPage": "A String", # Default page for this profile.
+        "kind": "analytics#profile", # Resource type for Analytics profile.
+        "excludeQueryParameters": "A String", # The query parameters that are excluded from this profile.
+        "name": "A String", # Name of this profile.
+        "created": "A String", # Time this profile was created.
+        "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this profile belongs.
+        "updated": "A String", # Time this profile was last modified.
+        "siteSearchQueryParameters": "A String", # The site search query parameters for this profile.
+        "currency": "A String", # The currency type associated with this profile.
+        "internalWebPropertyId": "A String", # Internal ID for the web property to which this profile belongs.
+        "childLink": { # Child link for this profile. Points to the list of goals for this profile.
+          "href": "A String", # Link to the list of goals for this profile.
+          "type": "analytics#goals", # Value is "analytics#goals".
+        },
+        "timezone": "A String", # Time zone for which this profile has been configured.
+        "siteSearchCategoryParameters": "A String", # Site search category parameters for this profile.
+        "parentLink": { # Parent link for this profile. Points to the web property to which this profile belongs.
+          "href": "A String", # Link to the web property to which this profile belongs.
+          "type": "analytics#webproperty", # Value is "analytics#webproperty".
+        },
+        "id": "A String", # Profile ID.
+        "selfLink": "A String", # Link for this profile.
+        "accountId": "A String", # Account ID to which this profile belongs.
+      },
+    ],
+    "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
+    "previousLink": "A String", # Link to previous page for this profile collection.
+    "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
+    "nextLink": "A String", # Link to next page for this profile collection.
+    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/analytics.v3.management.segments.html b/docs/dyn/analytics.v3.management.segments.html index 668f333..e9ad983 100644 --- a/docs/dyn/analytics.v3.management.segments.html +++ b/docs/dyn/analytics.v3.management.segments.html @@ -17,8 +17,33 @@
list = method(self, **kwargs)
Lists advanced segments to which the user has access.
 
Args:
-  max_results: string, The maximum number of entries to include in this response.
-  start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
+  max_results: integer, The maximum number of entries to include in this response.
+  start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "username": "A String", # Email ID of the authenticated user
+    "kind": "analytics#segments", # Collection type for advanced segments.
+    "items": [ # A list of advanced segments.
+      {
+        "definition": "A String", # Advanced segment definition.
+        "kind": "analytics#segment", # Resource type for Analytics advanced segment.
+        "segmentId": "A String", # Segment ID. Can be used with the 'segment' parameter in Data Feed.
+        "created": "A String", # Time the advanced segment was created.
+        "updated": "A String", # Time the advanced segment was last modified.
+        "id": "A String", # Advanced segment ID.
+        "selfLink": "A String", # Link for this advanced segment.
+        "name": "A String", # Advanced segment name.
+      },
+    ],
+    "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
+    "previousLink": "A String", # Link to previous page for this advanced segment collection.
+    "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
+    "nextLink": "A String", # Link to next page for this advanced segment collection.
+    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/analytics.v3.management.webproperties.html b/docs/dyn/analytics.v3.management.webproperties.html index 32cbee5..d9cf207 100644 --- a/docs/dyn/analytics.v3.management.webproperties.html +++ b/docs/dyn/analytics.v3.management.webproperties.html @@ -17,9 +17,43 @@
list = method(self, **kwargs)
Lists web properties to which the user has access.
 
Args:
-  max_results: string, The maximum number of entries to include in this response.
+  max_results: integer, The maximum number of entries to include in this response.
  start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
-  accountId: string, Account ID for the web properties to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which user has access. (required)
+  accountId: string, Account ID for the web properties to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which user has access. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "username": "A String", # Email ID of the authenticated user
+    "kind": "analytics#webproperties", # Collection type.
+    "items": [ # A list of web properties.
+      {
+        "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
+        "name": "A String", # Name of this web property.
+        "created": "A String", # Time this web property was created.
+        "updated": "A String", # Time this web property was last modified.
+        "websiteUrl": "A String", # Website url for this web property.
+        "internalWebPropertyId": "A String", # Internal ID for this web property.
+        "childLink": { # Child link for this web property. Points to the list of profiles for this web property.
+          "href": "A String", # Link to the list of profiles for this web property.
+          "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
+        },
+        "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
+          "href": "A String", # Link to the account for this web property.
+          "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
+        },
+        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
+        "selfLink": "A String", # Link for this web property.
+        "accountId": "A String", # Account ID to which this web property belongs.
+      },
+    ],
+    "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
+    "previousLink": "A String", # Link to previous page for this web property collection.
+    "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
+    "nextLink": "A String", # Link to next page for this web property collection.
+    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/audit.v1.activities.html b/docs/dyn/audit.v1.activities.html index bce94b4..4b1916a 100644 --- a/docs/dyn/audit.v1.activities.html +++ b/docs/dyn/audit.v1.activities.html @@ -31,7 +31,46 @@ Args:
  startTime: string, Return events which occured at or after this time.
  parameters: string, Event parameters in the form [parameter1 name]:[parameter1 value],[parameter2 name]:[parameter2 value],...
  applicationId: string, Application ID of the application on which the event was performed. (required)
-  customerId: string, Represents the customer who is the owner of target object on which action was performed. (required) +  customerId: string, Represents the customer who is the owner of target object on which action was performed. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # Each record in read response.
+      {
+        "kind": "audit#activity", # Kind of resource this is.
+        "ownerDomain": "A String", # Domain of source customer.
+        "actor": { # User doing the action.
+          "applicationId": "A String", # ID of application which interacted on behalf of the user.
+          "email": "A String", # Email address of the user.
+          "key": "A String", # For OAuth 2LO API requests, consumer_key of the requestor.
+          "callerType": "A String", # User or OAuth 2LO request.
+        },
+        "id": { # Unique identifier for each activity record.
+          "uniqQualifier": "A String", # Unique qualifier if multiple events have the same time.
+          "applicationId": "A String", # Application ID of the source application.
+          "customerId": "A String", # Obfuscated customer ID of the source customer.
+          "time": "A String", # Time of occurrence of the activity.
+        },
+        "ipAddress": "A String", # IP Address of the user doing the action.
+        "events": [ # Activity events.
+          {
+            "eventType": "A String", # Type of event.
+            "name": "A String", # Name of event.
+            "parameters": [ # Event parameters.
+              {
+                "name": "A String", # Name of the parameter.
+                "value": "A String", # Value of the parameter.
+              },
+            ],
+          },
+        ],
+      },
+    ],
+    "kind": "audit#activities", # Kind of list response this is.
+    "next": "A String", # Next page URL.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/blogger.v2.blogs.html b/docs/dyn/blogger.v2.blogs.html index 8f5084d..d227c91 100644 --- a/docs/dyn/blogger.v2.blogs.html +++ b/docs/dyn/blogger.v2.blogs.html @@ -17,7 +17,34 @@
get = method(self, **kwargs)
Gets one blog by id.
 
Args:
-  blogId: string, The ID of the blog to get. (required)
+  blogId: string, The ID of the blog to get. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
+    "description": "A String", # The description of this blog. This is displayed underneath the title.
+    "locale": { # The locale this Blog is set to.
+      "country": "A String", # The country this blog's locale is set to.
+      "variant": "A String", # The language variant this blog is authored in.
+      "language": "A String", # The language this blog is authored in.
+    },
+    "posts": { # The container of posts in this blog.
+      "totalItems": 42, # The count of posts in this blog.
+      "selfLink": "A String", # The URL of the container for posts in this blog.
+    },
+    "updated": "A String", # RFC 3339 date-time when this blog was last updated.
+    "id": "A String", # The identifier for this resource.
+    "url": "A String", # The URL where this blog is published.
+    "published": "A String", # RFC 3339 date-time when this blog was published.
+    "pages": { # The container of pages in this blog.
+      "totalItems": 42, # The count of pages in this blog.
+      "selfLink": "A String", # The URL of the container for pages in this blog.
+    },
+    "selfLink": "A String", # The API REST URL to fetch this resource from.
+    "name": "A String", # The name of this blog. This is displayed as the title.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/blogger.v2.comments.html b/docs/dyn/blogger.v2.comments.html index 526406b..5814578 100644 --- a/docs/dyn/blogger.v2.comments.html +++ b/docs/dyn/blogger.v2.comments.html @@ -19,7 +19,33 @@ Args:
  commentId: string, The ID of the comment to get. (required)
  postId: string, ID of the post to fetch posts from. (required)
-  blogId: string, ID of the blog to containing the comment. (required) +  blogId: string, ID of the blog to containing the comment. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "content": "A String", # The actual content of the comment. May include HTML markup.
+    "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
+    "author": { # The author of this Comment.
+      "url": "A String", # The URL of the Comment creator's Profile page.
+      "image": { # The comment creator's avatar.
+        "url": "A String", # The comment creator's avatar URL.
+      },
+      "displayName": "A String", # The display name.
+      "id": "A String", # The identifier of the Comment creator.
+    },
+    "updated": "A String", # RFC 3339 date-time when this comment was last updated.
+    "blog": { # Data about the blog containing this comment.
+      "id": "A String", # The identifier of the blog containing this comment.
+    },
+    "published": "A String", # RFC 3339 date-time when this comment was published.
+    "post": { # Data about the post containing this comment.
+      "id": "A String", # The identifier of the post containing this comment.
+    },
+    "id": "A String", # The identifier for this resource.
+    "selfLink": "A String", # The API REST URL to fetch this resource from.
+  }
list = method(self, **kwargs)
Retrieves the comments for a blog, possibly filtered.
 
@@ -29,7 +55,40 @@ Args:
  pageToken: string, Continuation token if request is paged.
  maxResults: integer, Maximum number of comments to include in the result.
  postId: string, ID of the post to fetch posts from. (required)
-  blogId: string, ID of the blog to fetch comments from. (required)
+  blogId: string, ID of the blog to fetch comments from. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
+    "items": [ # The List of Comments for a Post.
+      {
+        "content": "A String", # The actual content of the comment. May include HTML markup.
+        "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
+        "author": { # The author of this Comment.
+          "url": "A String", # The URL of the Comment creator's Profile page.
+          "image": { # The comment creator's avatar.
+            "url": "A String", # The comment creator's avatar URL.
+          },
+          "displayName": "A String", # The display name.
+          "id": "A String", # The identifier of the Comment creator.
+        },
+        "updated": "A String", # RFC 3339 date-time when this comment was last updated.
+        "blog": { # Data about the blog containing this comment.
+          "id": "A String", # The identifier of the blog containing this comment.
+        },
+        "published": "A String", # RFC 3339 date-time when this comment was published.
+        "post": { # Data about the post containing this comment.
+          "id": "A String", # The identifier of the post containing this comment.
+        },
+        "id": "A String", # The identifier for this resource.
+        "selfLink": "A String", # The API REST URL to fetch this resource from.
+      },
+    ],
+    "kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
+    "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
+  }
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
diff --git a/docs/dyn/blogger.v2.pages.html b/docs/dyn/blogger.v2.pages.html index 24b5e8a..1d84614 100644 --- a/docs/dyn/blogger.v2.pages.html +++ b/docs/dyn/blogger.v2.pages.html @@ -18,13 +18,68 @@  
Args:
  pageId: string, The ID of the page to get. (required)
-  blogId: string, ID of the blog containing the page. (required)
+  blogId: string, ID of the blog containing the page. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "content": "A String", # The body content of this Page, in HTML.
+    "kind": "blogger#page", # The kind of this entity. Always blogger#page
+    "author": { # The author of this Page.
+      "url": "A String", # The URL of the Page creator's Profile page.
+      "image": { # The page author's avatar.
+        "url": "A String", # The page author's avatar URL.
+      },
+      "displayName": "A String", # The display name.
+      "id": "A String", # The identifier of the Page creator.
+    },
+    "url": "A String", # The URL that this Page is displayed at.
+    "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
+    "updated": "A String", # RFC 3339 date-time when this Page was last updated.
+    "blog": { # Data about the blog containing this Page.
+      "id": "A String", # The identifier of the blog containing this page.
+    },
+    "published": "A String", # RFC 3339 date-time when this Page was published.
+    "id": "A String", # The identifier for this resource.
+    "selfLink": "A String", # The API REST URL to fetch this resource from.
+  }
list = method(self, **kwargs)
Retrieves pages for a blog, possibly filtered.
 
Args:
  fetchBodies: boolean, Whether to retrieve the Page bodies.
-  blogId: string, ID of the blog to fetch pages from. (required)
+  blogId: string, ID of the blog to fetch pages from. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # The list of Pages for a Blog.
+      {
+        "content": "A String", # The body content of this Page, in HTML.
+        "kind": "blogger#page", # The kind of this entity. Always blogger#page
+        "author": { # The author of this Page.
+          "url": "A String", # The URL of the Page creator's Profile page.
+          "image": { # The page author's avatar.
+            "url": "A String", # The page author's avatar URL.
+          },
+          "displayName": "A String", # The display name.
+          "id": "A String", # The identifier of the Page creator.
+        },
+        "url": "A String", # The URL that this Page is displayed at.
+        "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
+        "updated": "A String", # RFC 3339 date-time when this Page was last updated.
+        "blog": { # Data about the blog containing this Page.
+          "id": "A String", # The identifier of the blog containing this page.
+        },
+        "published": "A String", # RFC 3339 date-time when this Page was published.
+        "id": "A String", # The identifier for this resource.
+        "selfLink": "A String", # The API REST URL to fetch this resource from.
+      },
+    ],
+    "kind": "blogger#pageList", # The kind of this entity. Always blogger#pageList
+  }
Data descriptors defined here:
diff --git a/docs/dyn/blogger.v2.posts.html b/docs/dyn/blogger.v2.posts.html index 8b72531..7d05ffe 100644 --- a/docs/dyn/blogger.v2.posts.html +++ b/docs/dyn/blogger.v2.posts.html @@ -18,7 +18,39 @@  
Args:
  postId: string, The ID of the post (required)
-  blogId: string, ID of the blog to fetch the post from. (required) +  blogId: string, ID of the blog to fetch the post from. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "content": "A String", # The content of the Post. May contain HTML markup.
+    "kind": "blogger#post", # The kind of this entity. Always blogger#post
+    "author": { # The author of this Post.
+      "url": "A String", # The URL of the Post creator's Profile page.
+      "image": { # The Post author's avatar.
+        "url": "A String", # The Post author's avatar URL.
+      },
+      "displayName": "A String", # The display name.
+      "id": "A String", # The identifier of the Post creator.
+    },
+    "replies": { # The container of comments on this Post.
+      "totalItems": "A String", # The count of comments on this post.
+      "selfLink": "A String", # The URL of the comments on this post.
+    },
+    "labels": [ # The list of labels this Post was tagged with.
+      "A String",
+    ],
+    "updated": "A String", # RFC 3339 date-time when this Post was last updated.
+    "blog": { # Data about the blog containing this Post.
+      "id": "A String", # The identifier of the Blog that contains this Post.
+    },
+    "url": "A String", # The URL where this Post is displayed.
+    "published": "A String", # RFC 3339 date-time when this Post was published.
+    "title": "A String", # The title of the Post.
+    "id": "A String", # The identifier of this Post.
+    "selfLink": "A String", # The API REST URL to fetch this resource from.
+  }
list = method(self, **kwargs)
Retrieves a list of posts, possibly filtered.
 
@@ -27,7 +59,46 @@ Args:
  pageToken: string, Continuation token if the request is paged.
  maxResults: integer, Maximum number of posts to fetch.
  fetchBodies: boolean, Whether the body content of posts is included.
-  blogId: string, ID of the blog to fetch posts from. (required)
+  blogId: string, ID of the blog to fetch posts from. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
+    "items": [ # The list of Posts for this Blog.
+      {
+        "content": "A String", # The content of the Post. May contain HTML markup.
+        "kind": "blogger#post", # The kind of this entity. Always blogger#post
+        "author": { # The author of this Post.
+          "url": "A String", # The URL of the Post creator's Profile page.
+          "image": { # The Post author's avatar.
+            "url": "A String", # The Post author's avatar URL.
+          },
+          "displayName": "A String", # The display name.
+          "id": "A String", # The identifier of the Post creator.
+        },
+        "replies": { # The container of comments on this Post.
+          "totalItems": "A String", # The count of comments on this post.
+          "selfLink": "A String", # The URL of the comments on this post.
+        },
+        "labels": [ # The list of labels this Post was tagged with.
+          "A String",
+        ],
+        "updated": "A String", # RFC 3339 date-time when this Post was last updated.
+        "blog": { # Data about the blog containing this Post.
+          "id": "A String", # The identifier of the Blog that contains this Post.
+        },
+        "url": "A String", # The URL where this Post is displayed.
+        "published": "A String", # RFC 3339 date-time when this Post was published.
+        "title": "A String", # The title of the Post.
+        "id": "A String", # The identifier of this Post.
+        "selfLink": "A String", # The API REST URL to fetch this resource from.
+      },
+    ],
+    "kind": "blogger#postList", # The kind of this entity. Always blogger#postList
+    "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
+  }
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
diff --git a/docs/dyn/blogger.v2.users.blogs.html b/docs/dyn/blogger.v2.users.blogs.html index eaabe4e..b878ee3 100644 --- a/docs/dyn/blogger.v2.users.blogs.html +++ b/docs/dyn/blogger.v2.users.blogs.html @@ -17,7 +17,39 @@
list = method(self, **kwargs)
Retrieves a list of blogs, possibly filtered.
 
Args:
-  userId: string, ID of the user whose blogs are to be fetched. (required)
+  userId: string, ID of the user whose blogs are to be fetched. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # The list of Blogs this user has Authorship or Admin rights over.
+      {
+        "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
+        "description": "A String", # The description of this blog. This is displayed underneath the title.
+        "locale": { # The locale this Blog is set to.
+          "country": "A String", # The country this blog's locale is set to.
+          "variant": "A String", # The language variant this blog is authored in.
+          "language": "A String", # The language this blog is authored in.
+        },
+        "posts": { # The container of posts in this blog.
+          "totalItems": 42, # The count of posts in this blog.
+          "selfLink": "A String", # The URL of the container for posts in this blog.
+        },
+        "updated": "A String", # RFC 3339 date-time when this blog was last updated.
+        "id": "A String", # The identifier for this resource.
+        "url": "A String", # The URL where this blog is published.
+        "published": "A String", # RFC 3339 date-time when this blog was published.
+        "pages": { # The container of pages in this blog.
+          "totalItems": 42, # The count of pages in this blog.
+          "selfLink": "A String", # The URL of the container for pages in this blog.
+        },
+        "selfLink": "A String", # The API REST URL to fetch this resource from.
+        "name": "A String", # The name of this blog. This is displayed as the title.
+      },
+    ],
+    "kind": "blogger#blogList", # The kind of this entity. Always blogger#blogList
+  }
Data descriptors defined here:
diff --git a/docs/dyn/blogger.v2.users.html b/docs/dyn/blogger.v2.users.html index 7cb34cc..2258009 100644 --- a/docs/dyn/blogger.v2.users.html +++ b/docs/dyn/blogger.v2.users.html @@ -19,7 +19,28 @@
get = method(self, **kwargs)
Gets one user by id.
 
Args:
-  userId: string, The ID of the user to get. (required)
+  userId: string, The ID of the user to get. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "about": "A String", # Profile summary information.
+    "displayName": "A String", # The display name.
+    "created": "A String", # The timestamp of when this profile was created, in seconds since epoch.
+    "locale": { # This user's locale
+      "country": "A String", # The user's country setting.
+      "variant": "A String", # The user's language variant setting.
+      "language": "A String", # The user's language setting.
+    },
+    "blogs": { # The container of blogs for this user.
+      "selfLink": "A String", # The URL of the Blogs for this user.
+    },
+    "kind": "blogger#user", # The kind of this entity. Always blogger#user
+    "url": "A String", # The user's profile page.
+    "id": "A String", # The identifier for this User.
+    "selfLink": "A String", # The API REST URL to fetch this resource from.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/books.v1.bookshelves.html b/docs/dyn/books.v1.bookshelves.html index 01cdb2a..1533cf2 100644 --- a/docs/dyn/books.v1.bookshelves.html +++ b/docs/dyn/books.v1.bookshelves.html @@ -20,14 +20,51 @@ Args:
  source: string, String to identify the originator of this request.
  country: string, ISO-3166-1 code to override the IP-based location.
  userId: string, Id of user for whom to retrieve bookshelves. (required)
-  shelf: string, Id of bookshelf to retrieve. (required) +  shelf: string, Id of bookshelf to retrieve. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "books#bookshelf", # Resource type for bookshelf metadata.
+    "description": "A String", # Description of this bookshelf.
+    "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
+    "volumeCount": 42, # Number of volumes in this bookshelf.
+    "title": "A String", # Title of this bookshelf.
+    "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
+    "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
+    "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
+    "id": 42, # Id of this bookshelf, only unique by user.
+    "selfLink": "A String", # URL to this resource.
+  }
list = method(self, **kwargs)
Retrieves a list of public bookshelves for the specified user.
 
Args:
  source: string, String to identify the originator of this request.
  country: string, ISO-3166-1 code to override the IP-based location.
-  userId: string, Id of user for whom to retrieve bookshelves. (required)
+  userId: string, Id of user for whom to retrieve bookshelves. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # A list of bookshelves.
+      {
+        "kind": "books#bookshelf", # Resource type for bookshelf metadata.
+        "description": "A String", # Description of this bookshelf.
+        "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
+        "volumeCount": 42, # Number of volumes in this bookshelf.
+        "title": "A String", # Title of this bookshelf.
+        "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
+        "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
+        "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
+        "id": 42, # Id of this bookshelf, only unique by user.
+        "selfLink": "A String", # URL to this resource.
+      },
+    ],
+    "kind": "books#bookshelves", # Resource type.
+  }
volumes = methodResource(self)
A collection resource.
diff --git a/docs/dyn/books.v1.bookshelves.volumes.html b/docs/dyn/books.v1.bookshelves.volumes.html index 0b0957b..0989ae1 100644 --- a/docs/dyn/books.v1.bookshelves.volumes.html +++ b/docs/dyn/books.v1.bookshelves.volumes.html @@ -19,10 +19,146 @@ Args:
  shelf: string, Id of bookshelf to retrieve volumes. (required)
  source: string, String to identify the originator of this request.
-  userId: string, Id of user for whom to retrieve bookshelf volumes. (required)
+  showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.
  maxResults: integer, Maximum number of results to return
  startIndex: integer, Index of the first element to return (starts at 0)
-  country: string, ISO-3166-1 code to override the IP-based location. +  country: string, ISO-3166-1 code to override the IP-based location.
+  userId: string, Id of user for whom to retrieve bookshelf volumes. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "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.
+    "items": [ # A list of volumes.
+      {
+        "kind": "books#volume", # Resource type for a volume. (In LITE projection.)
+        "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.).
+          "publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
+          "embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
+          "downloadAccess": { # Information about a volume's download license access restrictions.
+            "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
+            "kind": "books#downloadAccessRestriction", # Resource type.
+            "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
+            "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
+            "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
+            "signature": "A String", # Response signature.
+            "volumeId": "A String", # Identifies the volume for which this entry applies.
+            "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
+            "source": "A String", # Client app identifier for verification. Download access and client-validation only.
+            "restricted": True or False, # Whether this volume has any download access restrictions.
+            "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
+            "message": "A String", # Error/warning message.
+          },
+          "country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
+          "textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
+          "pdf": { # Information about pdf content. (In LITE projection.)
+            "downloadLink": "A String", # URL to download pdf. (In LITE projection.)
+            "acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
+          },
+          "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.
+          "epub": { # Information about epub content. (In LITE projection.)
+            "downloadLink": "A String", # URL to download epub. (In LITE projection.)
+            "acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
+          },
+          "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.)
+        },
+        "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).
+          "country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
+          "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.)
+            "amount": 3.140000, # Amount in the currency listed below. (In LITE projection.)
+            "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+          },
+          "isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
+          "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.
+          "buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
+          "onSaleDate": "A String", # The date on which this book is available for sale.
+          "listPrice": { # Suggested retail price. (In LITE projection.)
+            "amount": 3.140000, # Amount in the currency listed below. (In LITE projection.)
+            "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+          },
+        },
+        "etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
+        "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
+          "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. (RFC 3339 UTC date-time format).
+          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
+          "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
+          "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
+            "kind": "books#readingPosition", # Resource type for a reading position.
+            "gbImagePosition": "A String", # Position in a volume for image-based content.
+            "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
+            "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
+            "volumeId": "A String", # Volume id associated with this reading position.
+            "pdfPosition": "A String", # Position in a PDF file.
+            "gbTextPosition": "A String", # Position in a volume for text-based content.
+          },
+          "review": { # This user's review of this volume, if one exists.
+            "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
+            "kind": "books#review", # Resource type for a review.
+            "author": { # Author of this review.
+              "displayName": "A String", # Name of this person.
+            },
+            "title": "A String", # Title for this review.
+            "volumeId": "A String", # Volume that this review is for.
+            "content": "A String", # Review text.
+            "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
+              "extraDescription": "A String", # Extra text about the source of the review.
+              "url": "A String", # URL of the source of the review.
+              "description": "A String", # Name of the source.
+            },
+            "date": "A String", # Date of this review.
+            "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
+            "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
+          },
+        },
+        "volumeInfo": { # General volume information.
+          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
+          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
+          "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.)
+          "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.
+          "pageCount": 42, # Total number of pages.
+          "imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
+            "medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
+            "smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
+            "large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
+            "extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
+            "small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
+            "thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
+          },
+          "publishedDate": "A String", # Date of publication. (In LITE projection.)
+          "previewLink": "A String", # URL to preview this volume on the Google Books site.
+          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
+          "ratingsCount": 42, # The number of review ratings for this volume.
+          "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.
+          "dimensions": { # Physical dimensions of this volume.
+            "width": "A String", # Width of this volume (in cm).
+            "thickness": "A String", # Thickness of this volume (in cm).
+            "height": "A String", # Height or length of this volume (in cm).
+          },
+          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
+          "industryIdentifiers": [ # Industry standard identifiers for this volume.
+            {
+              "identifier": "A String", # Industry specific volume identifier.
+              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
+            },
+          ],
+          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
+            "A String",
+          ],
+          "title": "A String", # Volume title. (In LITE projection.)
+          "canonicalVolumeLink": "A String", # Canonical URL for a volume. Use this URL to plus one a Google Book. (In LITE projection)
+          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
+          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
+            "A String",
+          ],
+          "averageRating": 3.140000, # The mean review rating for this volume. (min = 1.0, max = 5.0)
+        },
+        "id": "A String", # Unique identifier for a volume. (In LITE projection.)
+        "selfLink": "A String", # URL to this resource. (In LITE projection.)
+      },
+    ],
+    "kind": "books#volumes", # Resource type.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/books.v1.mylibrary.bookshelves.html b/docs/dyn/books.v1.mylibrary.bookshelves.html index d1050ca..54cfaac 100644 --- a/docs/dyn/books.v1.mylibrary.bookshelves.html +++ b/docs/dyn/books.v1.mylibrary.bookshelves.html @@ -36,13 +36,50 @@ Args:
Args:
  source: string, String to identify the originator of this request.
  shelf: string, Id of bookshelf to retrieve. (required)
-  country: string, ISO-3166-1 code to override the IP-based location. +  country: string, ISO-3166-1 code to override the IP-based location.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "books#bookshelf", # Resource type for bookshelf metadata.
+    "description": "A String", # Description of this bookshelf.
+    "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
+    "volumeCount": 42, # Number of volumes in this bookshelf.
+    "title": "A String", # Title of this bookshelf.
+    "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
+    "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
+    "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
+    "id": 42, # Id of this bookshelf, only unique by user.
+    "selfLink": "A String", # URL to this resource.
+  }
list = method(self, **kwargs)
Retrieves a list of bookshelves belonging to the authenticated user.
 
Args:
  country: string, ISO-3166-1 code to override the IP-based location.
-  source: string, String to identify the originator of this request.
+  source: string, String to identify the originator of this request.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # A list of bookshelves.
+      {
+        "kind": "books#bookshelf", # Resource type for bookshelf metadata.
+        "description": "A String", # Description of this bookshelf.
+        "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
+        "volumeCount": 42, # Number of volumes in this bookshelf.
+        "title": "A String", # Title of this bookshelf.
+        "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
+        "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
+        "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
+        "id": 42, # Id of this bookshelf, only unique by user.
+        "selfLink": "A String", # URL to this resource.
+      },
+    ],
+    "kind": "books#bookshelves", # Resource type.
+  }
removeVolume = method(self, **kwargs)
Removes a volume from a bookshelf.
 
diff --git a/docs/dyn/books.v1.mylibrary.bookshelves.volumes.html b/docs/dyn/books.v1.mylibrary.bookshelves.volumes.html index 146b381..666325d 100644 --- a/docs/dyn/books.v1.mylibrary.bookshelves.volumes.html +++ b/docs/dyn/books.v1.mylibrary.bookshelves.volumes.html @@ -23,10 +23,146 @@ Args:
      lite - Includes a subset of fields in volumeInfo and accessInfo.
  source: string, String to identify the originator of this request.
  country: string, ISO-3166-1 code to override the IP-based location.
+  showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.
  maxResults: integer, Maximum number of results to return
  q: string, Full-text search query string in this bookshelf.
  startIndex: integer, Index of the first element to return (starts at 0)
-  shelf: string, The bookshelf id or name retrieve volumes for.
+  shelf: string, The bookshelf id or name retrieve volumes for.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "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.
+    "items": [ # A list of volumes.
+      {
+        "kind": "books#volume", # Resource type for a volume. (In LITE projection.)
+        "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.).
+          "publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
+          "embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
+          "downloadAccess": { # Information about a volume's download license access restrictions.
+            "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
+            "kind": "books#downloadAccessRestriction", # Resource type.
+            "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
+            "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
+            "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
+            "signature": "A String", # Response signature.
+            "volumeId": "A String", # Identifies the volume for which this entry applies.
+            "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
+            "source": "A String", # Client app identifier for verification. Download access and client-validation only.
+            "restricted": True or False, # Whether this volume has any download access restrictions.
+            "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
+            "message": "A String", # Error/warning message.
+          },
+          "country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
+          "textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
+          "pdf": { # Information about pdf content. (In LITE projection.)
+            "downloadLink": "A String", # URL to download pdf. (In LITE projection.)
+            "acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
+          },
+          "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.
+          "epub": { # Information about epub content. (In LITE projection.)
+            "downloadLink": "A String", # URL to download epub. (In LITE projection.)
+            "acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
+          },
+          "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.)
+        },
+        "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).
+          "country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
+          "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.)
+            "amount": 3.140000, # Amount in the currency listed below. (In LITE projection.)
+            "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+          },
+          "isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
+          "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.
+          "buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
+          "onSaleDate": "A String", # The date on which this book is available for sale.
+          "listPrice": { # Suggested retail price. (In LITE projection.)
+            "amount": 3.140000, # Amount in the currency listed below. (In LITE projection.)
+            "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+          },
+        },
+        "etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
+        "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
+          "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. (RFC 3339 UTC date-time format).
+          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
+          "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
+          "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
+            "kind": "books#readingPosition", # Resource type for a reading position.
+            "gbImagePosition": "A String", # Position in a volume for image-based content.
+            "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
+            "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
+            "volumeId": "A String", # Volume id associated with this reading position.
+            "pdfPosition": "A String", # Position in a PDF file.
+            "gbTextPosition": "A String", # Position in a volume for text-based content.
+          },
+          "review": { # This user's review of this volume, if one exists.
+            "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
+            "kind": "books#review", # Resource type for a review.
+            "author": { # Author of this review.
+              "displayName": "A String", # Name of this person.
+            },
+            "title": "A String", # Title for this review.
+            "volumeId": "A String", # Volume that this review is for.
+            "content": "A String", # Review text.
+            "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
+              "extraDescription": "A String", # Extra text about the source of the review.
+              "url": "A String", # URL of the source of the review.
+              "description": "A String", # Name of the source.
+            },
+            "date": "A String", # Date of this review.
+            "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
+            "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
+          },
+        },
+        "volumeInfo": { # General volume information.
+          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
+          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
+          "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.)
+          "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.
+          "pageCount": 42, # Total number of pages.
+          "imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
+            "medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
+            "smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
+            "large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
+            "extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
+            "small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
+            "thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
+          },
+          "publishedDate": "A String", # Date of publication. (In LITE projection.)
+          "previewLink": "A String", # URL to preview this volume on the Google Books site.
+          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
+          "ratingsCount": 42, # The number of review ratings for this volume.
+          "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.
+          "dimensions": { # Physical dimensions of this volume.
+            "width": "A String", # Width of this volume (in cm).
+            "thickness": "A String", # Thickness of this volume (in cm).
+            "height": "A String", # Height or length of this volume (in cm).
+          },
+          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
+          "industryIdentifiers": [ # Industry standard identifiers for this volume.
+            {
+              "identifier": "A String", # Industry specific volume identifier.
+              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
+            },
+          ],
+          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
+            "A String",
+          ],
+          "title": "A String", # Volume title. (In LITE projection.)
+          "canonicalVolumeLink": "A String", # Canonical URL for a volume. Use this URL to plus one a Google Book. (In LITE projection)
+          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
+          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
+            "A String",
+          ],
+          "averageRating": 3.140000, # The mean review rating for this volume. (min = 1.0, max = 5.0)
+        },
+        "id": "A String", # Unique identifier for a volume. (In LITE projection.)
+        "selfLink": "A String", # URL to this resource. (In LITE projection.)
+      },
+    ],
+    "kind": "books#volumes", # Resource type.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/books.v1.mylibrary.html b/docs/dyn/books.v1.mylibrary.html index 9ac898f..77114c7 100644 --- a/docs/dyn/books.v1.mylibrary.html +++ b/docs/dyn/books.v1.mylibrary.html @@ -14,6 +14,8 @@ Methods defined here:
__init__(self)
+
annotations = methodResource(self)
A collection resource.
+
bookshelves = methodResource(self)
A collection resource.
diff --git a/docs/dyn/books.v1.volumes.html b/docs/dyn/books.v1.volumes.html index 07de731..5c34b0e 100644 --- a/docs/dyn/books.v1.volumes.html +++ b/docs/dyn/books.v1.volumes.html @@ -24,7 +24,136 @@ Args:
  source: string, String to identify the originator of this request.
  country: string, ISO-3166-1 code to override the IP-based location.
  volumeId: string, Id of volume to retrieve. (required)
-  partner: string, Identifier of partner for whom to brand results. +  partner: string, Identifier of partner for whom to brand results.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "books#volume", # Resource type for a volume. (In LITE projection.)
+    "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.).
+      "publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
+      "embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
+      "downloadAccess": { # Information about a volume's download license access restrictions.
+        "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
+        "kind": "books#downloadAccessRestriction", # Resource type.
+        "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
+        "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
+        "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
+        "signature": "A String", # Response signature.
+        "volumeId": "A String", # Identifies the volume for which this entry applies.
+        "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
+        "source": "A String", # Client app identifier for verification. Download access and client-validation only.
+        "restricted": True or False, # Whether this volume has any download access restrictions.
+        "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
+        "message": "A String", # Error/warning message.
+      },
+      "country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
+      "textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
+      "pdf": { # Information about pdf content. (In LITE projection.)
+        "downloadLink": "A String", # URL to download pdf. (In LITE projection.)
+        "acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
+      },
+      "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.
+      "epub": { # Information about epub content. (In LITE projection.)
+        "downloadLink": "A String", # URL to download epub. (In LITE projection.)
+        "acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
+      },
+      "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.)
+    },
+    "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).
+      "country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
+      "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.)
+        "amount": 3.140000, # Amount in the currency listed below. (In LITE projection.)
+        "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+      },
+      "isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
+      "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.
+      "buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
+      "onSaleDate": "A String", # The date on which this book is available for sale.
+      "listPrice": { # Suggested retail price. (In LITE projection.)
+        "amount": 3.140000, # Amount in the currency listed below. (In LITE projection.)
+        "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+      },
+    },
+    "etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
+    "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
+      "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. (RFC 3339 UTC date-time format).
+      "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
+      "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
+      "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
+        "kind": "books#readingPosition", # Resource type for a reading position.
+        "gbImagePosition": "A String", # Position in a volume for image-based content.
+        "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
+        "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
+        "volumeId": "A String", # Volume id associated with this reading position.
+        "pdfPosition": "A String", # Position in a PDF file.
+        "gbTextPosition": "A String", # Position in a volume for text-based content.
+      },
+      "review": { # This user's review of this volume, if one exists.
+        "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
+        "kind": "books#review", # Resource type for a review.
+        "author": { # Author of this review.
+          "displayName": "A String", # Name of this person.
+        },
+        "title": "A String", # Title for this review.
+        "volumeId": "A String", # Volume that this review is for.
+        "content": "A String", # Review text.
+        "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
+          "extraDescription": "A String", # Extra text about the source of the review.
+          "url": "A String", # URL of the source of the review.
+          "description": "A String", # Name of the source.
+        },
+        "date": "A String", # Date of this review.
+        "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
+        "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
+      },
+    },
+    "volumeInfo": { # General volume information.
+      "publisher": "A String", # Publisher of this volume. (In LITE projection.)
+      "subtitle": "A String", # Volume subtitle. (In LITE projection.)
+      "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.)
+      "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.
+      "pageCount": 42, # Total number of pages.
+      "imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
+        "medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
+        "smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
+        "large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
+        "extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
+        "small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
+        "thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
+      },
+      "publishedDate": "A String", # Date of publication. (In LITE projection.)
+      "previewLink": "A String", # URL to preview this volume on the Google Books site.
+      "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
+      "ratingsCount": 42, # The number of review ratings for this volume.
+      "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.
+      "dimensions": { # Physical dimensions of this volume.
+        "width": "A String", # Width of this volume (in cm).
+        "thickness": "A String", # Thickness of this volume (in cm).
+        "height": "A String", # Height or length of this volume (in cm).
+      },
+      "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
+      "industryIdentifiers": [ # Industry standard identifiers for this volume.
+        {
+          "identifier": "A String", # Industry specific volume identifier.
+          "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
+        },
+      ],
+      "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
+        "A String",
+      ],
+      "title": "A String", # Volume title. (In LITE projection.)
+      "canonicalVolumeLink": "A String", # Canonical URL for a volume. Use this URL to plus one a Google Book. (In LITE projection)
+      "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
+      "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
+        "A String",
+      ],
+      "averageRating": 3.140000, # The mean review rating for this volume. (min = 1.0, max = 5.0)
+    },
+    "id": "A String", # Unique identifier for a volume. (In LITE projection.)
+    "selfLink": "A String", # URL to this resource. (In LITE projection.)
+  }
list = method(self, **kwargs)
Performs a book search.
 
@@ -62,7 +191,143 @@ Args:
  partner: string, Identifier of partner for whom to restrict and brand results.
  download: string, Restrict to volumes by download availability.
    Allowed values
-      epub - All volumes with epub.
+      epub - All volumes with epub.
+  showPreorders: boolean, Set to true to show books available for preorder. Defaults to false.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "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.
+    "items": [ # A list of volumes.
+      {
+        "kind": "books#volume", # Resource type for a volume. (In LITE projection.)
+        "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.).
+          "publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
+          "embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
+          "downloadAccess": { # Information about a volume's download license access restrictions.
+            "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
+            "kind": "books#downloadAccessRestriction", # Resource type.
+            "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
+            "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
+            "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
+            "signature": "A String", # Response signature.
+            "volumeId": "A String", # Identifies the volume for which this entry applies.
+            "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
+            "source": "A String", # Client app identifier for verification. Download access and client-validation only.
+            "restricted": True or False, # Whether this volume has any download access restrictions.
+            "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
+            "message": "A String", # Error/warning message.
+          },
+          "country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
+          "textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
+          "pdf": { # Information about pdf content. (In LITE projection.)
+            "downloadLink": "A String", # URL to download pdf. (In LITE projection.)
+            "acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
+          },
+          "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.
+          "epub": { # Information about epub content. (In LITE projection.)
+            "downloadLink": "A String", # URL to download epub. (In LITE projection.)
+            "acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
+          },
+          "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.)
+        },
+        "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).
+          "country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
+          "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.)
+            "amount": 3.140000, # Amount in the currency listed below. (In LITE projection.)
+            "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+          },
+          "isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
+          "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.
+          "buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
+          "onSaleDate": "A String", # The date on which this book is available for sale.
+          "listPrice": { # Suggested retail price. (In LITE projection.)
+            "amount": 3.140000, # Amount in the currency listed below. (In LITE projection.)
+            "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+          },
+        },
+        "etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
+        "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
+          "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. (RFC 3339 UTC date-time format).
+          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
+          "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
+          "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
+            "kind": "books#readingPosition", # Resource type for a reading position.
+            "gbImagePosition": "A String", # Position in a volume for image-based content.
+            "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
+            "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
+            "volumeId": "A String", # Volume id associated with this reading position.
+            "pdfPosition": "A String", # Position in a PDF file.
+            "gbTextPosition": "A String", # Position in a volume for text-based content.
+          },
+          "review": { # This user's review of this volume, if one exists.
+            "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
+            "kind": "books#review", # Resource type for a review.
+            "author": { # Author of this review.
+              "displayName": "A String", # Name of this person.
+            },
+            "title": "A String", # Title for this review.
+            "volumeId": "A String", # Volume that this review is for.
+            "content": "A String", # Review text.
+            "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
+              "extraDescription": "A String", # Extra text about the source of the review.
+              "url": "A String", # URL of the source of the review.
+              "description": "A String", # Name of the source.
+            },
+            "date": "A String", # Date of this review.
+            "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
+            "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
+          },
+        },
+        "volumeInfo": { # General volume information.
+          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
+          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
+          "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.)
+          "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.
+          "pageCount": 42, # Total number of pages.
+          "imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
+            "medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
+            "smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
+            "large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
+            "extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
+            "small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
+            "thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
+          },
+          "publishedDate": "A String", # Date of publication. (In LITE projection.)
+          "previewLink": "A String", # URL to preview this volume on the Google Books site.
+          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
+          "ratingsCount": 42, # The number of review ratings for this volume.
+          "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.
+          "dimensions": { # Physical dimensions of this volume.
+            "width": "A String", # Width of this volume (in cm).
+            "thickness": "A String", # Thickness of this volume (in cm).
+            "height": "A String", # Height or length of this volume (in cm).
+          },
+          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
+          "industryIdentifiers": [ # Industry standard identifiers for this volume.
+            {
+              "identifier": "A String", # Industry specific volume identifier.
+              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
+            },
+          ],
+          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
+            "A String",
+          ],
+          "title": "A String", # Volume title. (In LITE projection.)
+          "canonicalVolumeLink": "A String", # Canonical URL for a volume. Use this URL to plus one a Google Book. (In LITE projection)
+          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
+          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
+            "A String",
+          ],
+          "averageRating": 3.140000, # The mean review rating for this volume. (min = 1.0, max = 5.0)
+        },
+        "id": "A String", # Unique identifier for a volume. (In LITE projection.)
+        "selfLink": "A String", # URL to this resource. (In LITE projection.)
+      },
+    ],
+    "kind": "books#volumes", # Resource type.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/customsearch.v1.cse.html b/docs/dyn/customsearch.v1.cse.html index b9c252e..fcada86 100644 --- a/docs/dyn/customsearch.v1.cse.html +++ b/docs/dyn/customsearch.v1.cse.html @@ -71,7 +71,64 @@ Args:
      lang_zh-TW - Chinese (Traditional)
  cr: string, Country restrict(s).
  gl: string, Geolocation of end user.
-  cref: string, The URL of a linked custom search engine +  cref: string, The URL of a linked custom search engine
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "promotions": [
+      {
+        "link": "A String",
+        "displayLink": "A String",
+        "image": {
+          "source": "A String",
+          "width": 42,
+          "height": 42,
+        },
+        "bodyLines": [
+          {
+            "url": "A String",
+            "link": "A String",
+            "title": "A String",
+          },
+        ],
+        "title": "A String",
+      },
+    ],
+    "kind": "customsearch#search",
+    "url": {
+      "type": "application/json",
+      "template": "https://www.googleapis.com/customsearch/v1?q={searchTerms}&num={count?}&start={startIndex?}&hr={language?}&safe={safe?}&cx={cx?}&cref={cref?}&sort={sort?}&filter={filter?}&gl={gl?}&cr={cr?}&googlehost={googleHost?}&alt=json",
+    },
+    "items": [
+      {
+        "kind": "customsearch#result",
+        "title": "A String",
+        "displayLink": "A String",
+        "cacheId": "A String",
+        "pagemap": {
+        },
+        "snippet": "A String",
+        "htmlSnippet": "A String",
+        "link": "A String",
+        "htmlTitle": "A String",
+      },
+    ],
+    "context": {
+      "facets": [
+        [
+          {
+            "anchor": "A String",
+            "label": "A String",
+          },
+        ],
+      ],
+      "title": "A String",
+    },
+    "queries": {
+    },
+  }
Data descriptors defined here:
diff --git a/docs/dyn/discovery.v1.apis.html b/docs/dyn/discovery.v1.apis.html index fb4a3ea..5980341 100644 --- a/docs/dyn/discovery.v1.apis.html +++ b/docs/dyn/discovery.v1.apis.html @@ -18,7 +18,46 @@  
Args:
  api: string, The name of the API. (required)
-  version: string, The version of the API. (required) +  version: string, The version of the API. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "discovery#restDescription", # The kind for this response.
+    "protocol": "rest", # The protocol described by this document.
+    "features": [ # A list of supported features for this API.
+      "A String",
+    ],
+    "parameters": { # Common parameters that apply across all apis.
+    },
+    "icons": { # Links to 16x16 and 32x32 icons representing the API.
+      "x32": "A String", # The url of the 32x32 icon.
+      "x16": "A String", # The url of the 16x16 icon.
+    },
+    "basePath": "A String", # The base URI path for REST requests.
+    "labels": [ # Labels for the status of this API, such as labs or deprecated.
+      "A String",
+    ],
+    "auth": { # Authentication information.
+      "oauth2": { # OAuth 2.0 authentication information.
+        "scopes": { # Available OAuth 2.0 scopes.
+        },
+      },
+    },
+    "name": "A String", # The name of this API.
+    "methods": { # API-level methods for this API.
+    },
+    "version": "A String", # The version of this API.
+    "schemas": { # The schemas for this API.
+    },
+    "title": "A String", # The title of this API.
+    "documentationLink": "A String", # A link to human readable documentation for the API.
+    "id": "A String", # The id of this API.
+    "resources": { # The resources in this API.
+    },
+    "description": "A String", # The description of this API.
+  }
list = method(self, **kwargs)
Retrieve the list of APIs supported at this endpoint.
 
@@ -29,7 +68,34 @@ Args:
    Allowed values
      deprecated - APIs that have been deprecated.
      graduated - Supported APIs that have graduated from labs.
-      labs - APIs that are experimental
+      labs - APIs that are experimental
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # The individual directory entries. One entry per api/version pair.
+      {
+        "kind": "discovery#directoryItem", # The kind for this response.
+        "description": "A String", # The description of this API.
+        "icons": { # Links to 16x16 and 32x32 icons representing the API.
+          "x32": "A String", # The url of the 32x32 icon.
+          "x16": "A String", # The url of the 16x16 icon.
+        },
+        "labels": [ # Labels for the status of this API, such as labs or deprecated.
+          "A String",
+        ],
+        "preferred": True or False, # True if this version is the preferred version to use.
+        "name": "A String", # The name of the API.
+        "discoveryLink": "A String", # A link to the discovery document.
+        "version": "A String", # The version of the API.
+        "title": "A String", # The title of this API.
+        "id": "A String", # The id of this API.
+        "documentationLink": "A String", # A link to human readable documentation for the API.
+      },
+    ],
+    "kind": "discovery#directoryList", # The kind for this response.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/freebase.v1.text.html b/docs/dyn/freebase.v1.text.html index 8521a90..1909ab8 100644 --- a/docs/dyn/freebase.v1.text.html +++ b/docs/dyn/freebase.v1.text.html @@ -23,7 +23,14 @@ Args:
      plain - Return plain text - strip html tags.
      raw - Return the entire content as-is.
  maxlength: integer, The max number of characters to return. Valid only for 'plain' format.
-  id: string, The id of the item that you want data about (required) (repeated) +  id: string, The id of the item that you want data about (required) (repeated)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "result": "A String", # The text requested.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/latitude.v1.currentLocation.html b/docs/dyn/latitude.v1.currentLocation.html index 49a1025..bf0cda4 100644 --- a/docs/dyn/latitude.v1.currentLocation.html +++ b/docs/dyn/latitude.v1.currentLocation.html @@ -21,12 +21,59 @@ Args:
get = method(self, **kwargs)
Returns the authenticated user's current location.
 
Args:
-  granularity: string, Granularity of the requested location.
+  granularity: string, Granularity of the requested location.
+ 
+Returns:
+  An object of the form
+ 
+    { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
+      "kind": "latitude#location", # Kind of this item.
+      "altitude": "", # Altitude of the location, in meters. Optional.
+      "longitude": "", # Longitude of the location, in decimal degrees.
+      "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
+      "latitude": "", # Latitude of the location, in decimal degrees.
+      "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
+      "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
+      "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
+      "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
+      "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
+    }
insert = method(self, **kwargs)
Updates or creates the user's current location.
 
Args:
-  body: object, The request body. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{ # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
+    "kind": "latitude#location", # Kind of this item.
+    "altitude": "", # Altitude of the location, in meters. Optional.
+    "longitude": "", # Longitude of the location, in decimal degrees.
+    "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
+    "latitude": "", # Latitude of the location, in decimal degrees.
+    "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
+    "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
+    "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
+    "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
+    "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
+  }
+ 
+ 
+Returns:
+  An object of the form
+ 
+    { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
+      "kind": "latitude#location", # Kind of this item.
+      "altitude": "", # Altitude of the location, in meters. Optional.
+      "longitude": "", # Longitude of the location, in decimal degrees.
+      "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
+      "latitude": "", # Latitude of the location, in decimal degrees.
+      "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
+      "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
+      "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
+      "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
+      "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
+    }
Data descriptors defined here:
diff --git a/docs/dyn/latitude.v1.location.html b/docs/dyn/latitude.v1.location.html index 1ddb011..e0f2b0a 100644 --- a/docs/dyn/latitude.v1.location.html +++ b/docs/dyn/latitude.v1.location.html @@ -23,12 +23,59 @@ Args:
 
Args:
  locationId: string, Timestamp of the location to read (ms since epoch). (required)
-  granularity: string, Granularity of the location to return. +  granularity: string, Granularity of the location to return.
+ 
+Returns:
+  An object of the form
+ 
+    { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
+    "kind": "latitude#location", # Kind of this item.
+    "altitude": "", # Altitude of the location, in meters. Optional.
+    "longitude": "", # Longitude of the location, in decimal degrees.
+    "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
+    "latitude": "", # Latitude of the location, in decimal degrees.
+    "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
+    "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
+    "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
+    "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
+    "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
+  }
insert = method(self, **kwargs)
Inserts or updates a location in the user's location history.
 
Args:
-  body: object, The request body. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{ # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
+  "kind": "latitude#location", # Kind of this item.
+  "altitude": "", # Altitude of the location, in meters. Optional.
+  "longitude": "", # Longitude of the location, in decimal degrees.
+  "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
+  "latitude": "", # Latitude of the location, in decimal degrees.
+  "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
+  "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
+  "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
+  "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
+  "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
+}
+ 
+ 
+Returns:
+  An object of the form
+ 
+    { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
+    "kind": "latitude#location", # Kind of this item.
+    "altitude": "", # Altitude of the location, in meters. Optional.
+    "longitude": "", # Longitude of the location, in decimal degrees.
+    "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
+    "latitude": "", # Latitude of the location, in decimal degrees.
+    "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
+    "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
+    "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
+    "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
+    "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
+  }
list = method(self, **kwargs)
Lists the user's location history.
 
@@ -36,7 +83,28 @@ Args:
  min_time: string, Minimum timestamp of locations to return (ms since epoch).
  max_results: string, Maximum number of locations to return.
  max_time: string, Maximum timestamp of locations to return (ms since epoch).
-  granularity: string, Granularity of the requested locations.
+  granularity: string, Granularity of the requested locations.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [
+      { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
+        "kind": "latitude#location", # Kind of this item.
+        "altitude": "", # Altitude of the location, in meters. Optional.
+        "longitude": "", # Longitude of the location, in decimal degrees.
+        "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
+        "latitude": "", # Latitude of the location, in decimal degrees.
+        "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
+        "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
+        "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
+        "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
+        "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
+      },
+    ],
+    "kind": "latitude#locationFeed",
+  }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.featured.series.html b/docs/dyn/moderator.v1.featured.series.html index 90a5b89..84f141a 100644 --- a/docs/dyn/moderator.v1.featured.series.html +++ b/docs/dyn/moderator.v1.featured.series.html @@ -16,7 +16,48 @@
list = method(self, **kwargs)
Lists the featured series.
 
-Args:
+Args:
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [
+      {
+        "kind": "moderator#series",
+        "description": "A String",
+        "rules": {
+          "votes": {
+            "close": "A String",
+            "open": "A String",
+          },
+          "submissions": {
+            "close": "A String",
+            "open": "A String",
+          },
+        },
+        "unauthVotingAllowed": True or False,
+        "videoSubmissionAllowed": True or False,
+        "name": "A String",
+        "numTopics": 42,
+        "anonymousSubmissionAllowed": True or False,
+        "unauthSubmissionAllowed": True or False,
+        "id": {
+          "seriesId": "A String",
+        },
+        "counters": {
+          "users": 42,
+          "noneVotes": 42,
+          "videoSubmissions": 42,
+          "minusVotes": 42,
+          "anonymousSubmissions": 42,
+          "submissions": 42,
+          "plusVotes": 42,
+        },
+      },
+    ],
+    "kind": "moderator#seriesList",
+  }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.my.series.html b/docs/dyn/moderator.v1.my.series.html index faf5bd2..afdfa3e 100644 --- a/docs/dyn/moderator.v1.my.series.html +++ b/docs/dyn/moderator.v1.my.series.html @@ -16,7 +16,48 @@
list = method(self, **kwargs)
Lists all series created by the authenticated user.
 
-Args:
+Args:
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [
+      {
+        "kind": "moderator#series",
+        "description": "A String",
+        "rules": {
+          "votes": {
+            "close": "A String",
+            "open": "A String",
+          },
+          "submissions": {
+            "close": "A String",
+            "open": "A String",
+          },
+        },
+        "unauthVotingAllowed": True or False,
+        "videoSubmissionAllowed": True or False,
+        "name": "A String",
+        "numTopics": 42,
+        "anonymousSubmissionAllowed": True or False,
+        "unauthSubmissionAllowed": True or False,
+        "id": {
+          "seriesId": "A String",
+        },
+        "counters": {
+          "users": 42,
+          "noneVotes": 42,
+          "videoSubmissions": 42,
+          "minusVotes": 42,
+          "anonymousSubmissions": 42,
+          "submissions": 42,
+          "plusVotes": 42,
+        },
+      },
+    ],
+    "kind": "moderator#seriesList",
+  }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.myrecent.series.html b/docs/dyn/moderator.v1.myrecent.series.html index 8ab5c8c..d43402c 100644 --- a/docs/dyn/moderator.v1.myrecent.series.html +++ b/docs/dyn/moderator.v1.myrecent.series.html @@ -16,7 +16,48 @@
list = method(self, **kwargs)
Lists the series the authenticated user has visited.
 
-Args:
+Args:
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [
+      {
+        "kind": "moderator#series",
+        "description": "A String",
+        "rules": {
+          "votes": {
+            "close": "A String",
+            "open": "A String",
+          },
+          "submissions": {
+            "close": "A String",
+            "open": "A String",
+          },
+        },
+        "unauthVotingAllowed": True or False,
+        "videoSubmissionAllowed": True or False,
+        "name": "A String",
+        "numTopics": 42,
+        "anonymousSubmissionAllowed": True or False,
+        "unauthSubmissionAllowed": True or False,
+        "id": {
+          "seriesId": "A String",
+        },
+        "counters": {
+          "users": 42,
+          "noneVotes": 42,
+          "videoSubmissions": 42,
+          "minusVotes": 42,
+          "anonymousSubmissions": 42,
+          "submissions": 42,
+          "plusVotes": 42,
+        },
+      },
+    ],
+    "kind": "moderator#seriesList",
+  }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.profiles.html b/docs/dyn/moderator.v1.profiles.html index 0273442..b3a21da 100644 --- a/docs/dyn/moderator.v1.profiles.html +++ b/docs/dyn/moderator.v1.profiles.html @@ -16,17 +16,115 @@
get = method(self, **kwargs)
Returns the profile information for the authenticated user.
 
-Args:
+Args:
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "moderator#profile",
+      "attribution": {
+        "geo": {
+          "latitude": 3.140000,
+          "location": "A String",
+          "longitude": 3.140000,
+        },
+        "displayName": "A String",
+        "location": "A String",
+        "avatarUrl": "A String",
+      },
+      "id": {
+        "user": "A String",
+      },
+    }
patch = method(self, **kwargs)
Updates the profile information for the authenticated user. This method supports patch semantics.
 
Args:
-  body: object, The request body. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "kind": "moderator#profile",
+    "attribution": {
+      "geo": {
+        "latitude": 3.140000,
+        "location": "A String",
+        "longitude": 3.140000,
+      },
+      "displayName": "A String",
+      "location": "A String",
+      "avatarUrl": "A String",
+    },
+    "id": {
+      "user": "A String",
+    },
+  }
+ 
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "moderator#profile",
+      "attribution": {
+        "geo": {
+          "latitude": 3.140000,
+          "location": "A String",
+          "longitude": 3.140000,
+        },
+        "displayName": "A String",
+        "location": "A String",
+        "avatarUrl": "A String",
+      },
+      "id": {
+        "user": "A String",
+      },
+    }
update = method(self, **kwargs)
Updates the profile information for the authenticated user.
 
Args:
-  body: object, The request body. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "kind": "moderator#profile",
+    "attribution": {
+      "geo": {
+        "latitude": 3.140000,
+        "location": "A String",
+        "longitude": 3.140000,
+      },
+      "displayName": "A String",
+      "location": "A String",
+      "avatarUrl": "A String",
+    },
+    "id": {
+      "user": "A String",
+    },
+  }
+ 
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "moderator#profile",
+      "attribution": {
+        "geo": {
+          "latitude": 3.140000,
+          "location": "A String",
+          "longitude": 3.140000,
+        },
+        "displayName": "A String",
+        "location": "A String",
+        "avatarUrl": "A String",
+      },
+      "id": {
+        "user": "A String",
+      },
+    }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.responses.html b/docs/dyn/moderator.v1.responses.html index 0c75d09..b95703d 100644 --- a/docs/dyn/moderator.v1.responses.html +++ b/docs/dyn/moderator.v1.responses.html @@ -22,7 +22,110 @@ Args:
  unauthToken: string, User identifier for unauthenticated usage mode
  parentSubmissionId: integer, The decimal ID of the parent Submission within the Series. (required)
  body: object, The request body. (required)
-  anonymous: boolean, Set to true to mark the new submission as anonymous. +    The object takes the form of:
+ 
+{
+    "kind": "moderator#submission",
+    "attribution": {
+      "displayName": "A String",
+      "location": "A String",
+      "avatarUrl": "A String",
+    },
+    "created": "A String",
+    "text": "A String",
+    "topics": [
+      {
+        "id": {
+          "seriesId": "A String",
+          "topicId": "A String",
+        },
+      },
+    ],
+    "author": "A String",
+    "translations": [
+      {
+        "lang": "A String",
+        "text": "A String",
+      },
+    ],
+    "parentSubmissionId": {
+      "seriesId": "A String",
+      "submissionId": "A String",
+    },
+    "vote": {
+      "vote": "A String",
+      "flag": "A String",
+    },
+    "attachmentUrl": "A String",
+    "geo": {
+      "latitude": 3.140000,
+      "location": "A String",
+      "longitude": 3.140000,
+    },
+    "id": {
+      "seriesId": "A String",
+      "submissionId": "A String",
+    },
+    "counters": {
+      "noneVotes": 42,
+      "minusVotes": 42,
+      "plusVotes": 42,
+    },
+  }
+ 
+  anonymous: boolean, Set to true to mark the new submission as anonymous.
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "moderator#submission",
+      "attribution": {
+        "displayName": "A String",
+        "location": "A String",
+        "avatarUrl": "A String",
+      },
+      "created": "A String",
+      "text": "A String",
+      "topics": [
+        {
+          "id": {
+            "seriesId": "A String",
+            "topicId": "A String",
+          },
+        },
+      ],
+      "author": "A String",
+      "translations": [
+        {
+          "lang": "A String",
+          "text": "A String",
+        },
+      ],
+      "parentSubmissionId": {
+        "seriesId": "A String",
+        "submissionId": "A String",
+      },
+      "vote": {
+        "vote": "A String",
+        "flag": "A String",
+      },
+      "attachmentUrl": "A String",
+      "geo": {
+        "latitude": 3.140000,
+        "location": "A String",
+        "longitude": 3.140000,
+      },
+      "id": {
+        "seriesId": "A String",
+        "submissionId": "A String",
+      },
+      "counters": {
+        "noneVotes": 42,
+        "minusVotes": 42,
+        "plusVotes": 42,
+      },
+    }
list = method(self, **kwargs)
Lists or searches the responses for the specified submission within the specified series and returns the search results.
 
@@ -34,7 +137,64 @@ Args:
  q: string, Search query.
  max_results: integer, Maximum number of results to return.
  hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
-  start_index: integer, Index of the first result to be retrieved.
+  start_index: integer, Index of the first result to be retrieved.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [
+      {
+          "kind": "moderator#submission",
+          "attribution": {
+            "displayName": "A String",
+            "location": "A String",
+            "avatarUrl": "A String",
+          },
+          "created": "A String",
+          "text": "A String",
+          "topics": [
+            {
+              "id": {
+                "seriesId": "A String",
+                "topicId": "A String",
+              },
+            },
+          ],
+          "author": "A String",
+          "translations": [
+            {
+              "lang": "A String",
+              "text": "A String",
+            },
+          ],
+          "parentSubmissionId": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "vote": {
+            "vote": "A String",
+            "flag": "A String",
+          },
+          "attachmentUrl": "A String",
+          "geo": {
+            "latitude": 3.140000,
+            "location": "A String",
+            "longitude": 3.140000,
+          },
+          "id": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "counters": {
+            "noneVotes": 42,
+            "minusVotes": 42,
+            "plusVotes": 42,
+          },
+        },
+    ],
+    "kind": "moderator#submissionList",
+  }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.series.html b/docs/dyn/moderator.v1.series.html index 67532b3..c81c7c7 100644 --- a/docs/dyn/moderator.v1.series.html +++ b/docs/dyn/moderator.v1.series.html @@ -17,25 +17,244 @@
get = method(self, **kwargs)
Returns the specified series.
 
Args:
-  seriesId: integer, The decimal ID of the Series. (required)
+  seriesId: integer, The decimal ID of the Series. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "moderator#series",
+    "description": "A String",
+    "rules": {
+      "votes": {
+        "close": "A String",
+        "open": "A String",
+      },
+      "submissions": {
+        "close": "A String",
+        "open": "A String",
+      },
+    },
+    "unauthVotingAllowed": True or False,
+    "videoSubmissionAllowed": True or False,
+    "name": "A String",
+    "numTopics": 42,
+    "anonymousSubmissionAllowed": True or False,
+    "unauthSubmissionAllowed": True or False,
+    "id": {
+      "seriesId": "A String",
+    },
+    "counters": {
+      "users": 42,
+      "noneVotes": 42,
+      "videoSubmissions": 42,
+      "minusVotes": 42,
+      "anonymousSubmissions": 42,
+      "submissions": 42,
+      "plusVotes": 42,
+    },
+  }
insert = method(self, **kwargs)
Inserts a new series.
 
Args:
-  body: object, The request body. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+  "kind": "moderator#series",
+  "description": "A String",
+  "rules": {
+    "votes": {
+      "close": "A String",
+      "open": "A String",
+    },
+    "submissions": {
+      "close": "A String",
+      "open": "A String",
+    },
+  },
+  "unauthVotingAllowed": True or False,
+  "videoSubmissionAllowed": True or False,
+  "name": "A String",
+  "numTopics": 42,
+  "anonymousSubmissionAllowed": True or False,
+  "unauthSubmissionAllowed": True or False,
+  "id": {
+    "seriesId": "A String",
+  },
+  "counters": {
+    "users": 42,
+    "noneVotes": 42,
+    "videoSubmissions": 42,
+    "minusVotes": 42,
+    "anonymousSubmissions": 42,
+    "submissions": 42,
+    "plusVotes": 42,
+  },
+}
+ 
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "moderator#series",
+    "description": "A String",
+    "rules": {
+      "votes": {
+        "close": "A String",
+        "open": "A String",
+      },
+      "submissions": {
+        "close": "A String",
+        "open": "A String",
+      },
+    },
+    "unauthVotingAllowed": True or False,
+    "videoSubmissionAllowed": True or False,
+    "name": "A String",
+    "numTopics": 42,
+    "anonymousSubmissionAllowed": True or False,
+    "unauthSubmissionAllowed": True or False,
+    "id": {
+      "seriesId": "A String",
+    },
+    "counters": {
+      "users": 42,
+      "noneVotes": 42,
+      "videoSubmissions": 42,
+      "minusVotes": 42,
+      "anonymousSubmissions": 42,
+      "submissions": 42,
+      "plusVotes": 42,
+    },
+  }
list = method(self, **kwargs)
Searches the series and returns the search results.
 
Args:
  q: string, Search query.
  max_results: integer, Maximum number of results to return.
-  start_index: integer, Index of the first result to be retrieved.
+  start_index: integer, Index of the first result to be retrieved.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [
+      {
+        "kind": "moderator#series",
+        "description": "A String",
+        "rules": {
+          "votes": {
+            "close": "A String",
+            "open": "A String",
+          },
+          "submissions": {
+            "close": "A String",
+            "open": "A String",
+          },
+        },
+        "unauthVotingAllowed": True or False,
+        "videoSubmissionAllowed": True or False,
+        "name": "A String",
+        "numTopics": 42,
+        "anonymousSubmissionAllowed": True or False,
+        "unauthSubmissionAllowed": True or False,
+        "id": {
+          "seriesId": "A String",
+        },
+        "counters": {
+          "users": 42,
+          "noneVotes": 42,
+          "videoSubmissions": 42,
+          "minusVotes": 42,
+          "anonymousSubmissions": 42,
+          "submissions": 42,
+          "plusVotes": 42,
+        },
+      },
+    ],
+    "kind": "moderator#seriesList",
+  }
patch = method(self, **kwargs)
Updates the specified series. This method supports patch semantics.
 
Args:
  seriesId: integer, The decimal ID of the Series. (required)
-  body: object, The request body. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+  "kind": "moderator#series",
+  "description": "A String",
+  "rules": {
+    "votes": {
+      "close": "A String",
+      "open": "A String",
+    },
+    "submissions": {
+      "close": "A String",
+      "open": "A String",
+    },
+  },
+  "unauthVotingAllowed": True or False,
+  "videoSubmissionAllowed": True or False,
+  "name": "A String",
+  "numTopics": 42,
+  "anonymousSubmissionAllowed": True or False,
+  "unauthSubmissionAllowed": True or False,
+  "id": {
+    "seriesId": "A String",
+  },
+  "counters": {
+    "users": 42,
+    "noneVotes": 42,
+    "videoSubmissions": 42,
+    "minusVotes": 42,
+    "anonymousSubmissions": 42,
+    "submissions": 42,
+    "plusVotes": 42,
+  },
+}
+ 
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "moderator#series",
+    "description": "A String",
+    "rules": {
+      "votes": {
+        "close": "A String",
+        "open": "A String",
+      },
+      "submissions": {
+        "close": "A String",
+        "open": "A String",
+      },
+    },
+    "unauthVotingAllowed": True or False,
+    "videoSubmissionAllowed": True or False,
+    "name": "A String",
+    "numTopics": 42,
+    "anonymousSubmissionAllowed": True or False,
+    "unauthSubmissionAllowed": True or False,
+    "id": {
+      "seriesId": "A String",
+    },
+    "counters": {
+      "users": 42,
+      "noneVotes": 42,
+      "videoSubmissions": 42,
+      "minusVotes": 42,
+      "anonymousSubmissions": 42,
+      "submissions": 42,
+      "plusVotes": 42,
+    },
+  }
responses = methodResource(self)
A collection resource.
@@ -45,7 +264,78 @@ Args:
 
Args:
  seriesId: integer, The decimal ID of the Series. (required)
-  body: object, The request body. (required) +  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+  "kind": "moderator#series",
+  "description": "A String",
+  "rules": {
+    "votes": {
+      "close": "A String",
+      "open": "A String",
+    },
+    "submissions": {
+      "close": "A String",
+      "open": "A String",
+    },
+  },
+  "unauthVotingAllowed": True or False,
+  "videoSubmissionAllowed": True or False,
+  "name": "A String",
+  "numTopics": 42,
+  "anonymousSubmissionAllowed": True or False,
+  "unauthSubmissionAllowed": True or False,
+  "id": {
+    "seriesId": "A String",
+  },
+  "counters": {
+    "users": 42,
+    "noneVotes": 42,
+    "videoSubmissions": 42,
+    "minusVotes": 42,
+    "anonymousSubmissions": 42,
+    "submissions": 42,
+    "plusVotes": 42,
+  },
+}
+ 
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "moderator#series",
+    "description": "A String",
+    "rules": {
+      "votes": {
+        "close": "A String",
+        "open": "A String",
+      },
+      "submissions": {
+        "close": "A String",
+        "open": "A String",
+      },
+    },
+    "unauthVotingAllowed": True or False,
+    "videoSubmissionAllowed": True or False,
+    "name": "A String",
+    "numTopics": 42,
+    "anonymousSubmissionAllowed": True or False,
+    "unauthSubmissionAllowed": True or False,
+    "id": {
+      "seriesId": "A String",
+    },
+    "counters": {
+      "users": 42,
+      "noneVotes": 42,
+      "videoSubmissions": 42,
+      "minusVotes": 42,
+      "anonymousSubmissions": 42,
+      "submissions": 42,
+      "plusVotes": 42,
+    },
+  }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.series.responses.html b/docs/dyn/moderator.v1.series.responses.html index 4d2ce0d..14557cb 100644 --- a/docs/dyn/moderator.v1.series.responses.html +++ b/docs/dyn/moderator.v1.series.responses.html @@ -23,7 +23,48 @@ Args:
  q: string, Search query.
  max_results: integer, Maximum number of results to return.
  hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
-  start_index: integer, Index of the first result to be retrieved. +  start_index: integer, Index of the first result to be retrieved.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [
+      {
+        "kind": "moderator#series",
+        "description": "A String",
+        "rules": {
+          "votes": {
+            "close": "A String",
+            "open": "A String",
+          },
+          "submissions": {
+            "close": "A String",
+            "open": "A String",
+          },
+        },
+        "unauthVotingAllowed": True or False,
+        "videoSubmissionAllowed": True or False,
+        "name": "A String",
+        "numTopics": 42,
+        "anonymousSubmissionAllowed": True or False,
+        "unauthSubmissionAllowed": True or False,
+        "id": {
+          "seriesId": "A String",
+        },
+        "counters": {
+          "users": 42,
+          "noneVotes": 42,
+          "videoSubmissions": 42,
+          "minusVotes": 42,
+          "anonymousSubmissions": 42,
+          "submissions": 42,
+          "plusVotes": 42,
+        },
+      },
+    ],
+    "kind": "moderator#seriesList",
+  }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.series.submissions.html b/docs/dyn/moderator.v1.series.submissions.html index 8dec541..fd5b3ec 100644 --- a/docs/dyn/moderator.v1.series.submissions.html +++ b/docs/dyn/moderator.v1.series.submissions.html @@ -25,7 +25,64 @@ Args:
  max_results: integer, Maximum number of results to return.
  q: string, Search query.
  start_index: integer, Index of the first result to be retrieved.
-  hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached. +  hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [
+      {
+          "kind": "moderator#submission",
+          "attribution": {
+            "displayName": "A String",
+            "location": "A String",
+            "avatarUrl": "A String",
+          },
+          "created": "A String",
+          "text": "A String",
+          "topics": [
+            {
+              "id": {
+                "seriesId": "A String",
+                "topicId": "A String",
+              },
+            },
+          ],
+          "author": "A String",
+          "translations": [
+            {
+              "lang": "A String",
+              "text": "A String",
+            },
+          ],
+          "parentSubmissionId": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "vote": {
+            "vote": "A String",
+            "flag": "A String",
+          },
+          "attachmentUrl": "A String",
+          "geo": {
+            "latitude": 3.140000,
+            "location": "A String",
+            "longitude": 3.140000,
+          },
+          "id": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "counters": {
+            "noneVotes": 42,
+            "minusVotes": 42,
+            "plusVotes": 42,
+          },
+        },
+    ],
+    "kind": "moderator#submissionList",
+  }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.submissions.html b/docs/dyn/moderator.v1.submissions.html index 6fd13c1..7e06227 100644 --- a/docs/dyn/moderator.v1.submissions.html +++ b/docs/dyn/moderator.v1.submissions.html @@ -20,7 +20,59 @@ Args:
  lang: string, The language code for the language the client prefers resuls in.
  seriesId: integer, The decimal ID of the Series. (required)
  includeVotes: boolean, Specifies whether to include the current user's vote
-  submissionId: integer, The decimal ID of the Submission within the Series. (required) +  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "moderator#submission",
+      "attribution": {
+        "displayName": "A String",
+        "location": "A String",
+        "avatarUrl": "A String",
+      },
+      "created": "A String",
+      "text": "A String",
+      "topics": [
+        {
+          "id": {
+            "seriesId": "A String",
+            "topicId": "A String",
+          },
+        },
+      ],
+      "author": "A String",
+      "translations": [
+        {
+          "lang": "A String",
+          "text": "A String",
+        },
+      ],
+      "parentSubmissionId": {
+        "seriesId": "A String",
+        "submissionId": "A String",
+      },
+      "vote": {
+        "vote": "A String",
+        "flag": "A String",
+      },
+      "attachmentUrl": "A String",
+      "geo": {
+        "latitude": 3.140000,
+        "location": "A String",
+        "longitude": 3.140000,
+      },
+      "id": {
+        "seriesId": "A String",
+        "submissionId": "A String",
+      },
+      "counters": {
+        "noneVotes": 42,
+        "minusVotes": 42,
+        "plusVotes": 42,
+      },
+    }
insert = method(self, **kwargs)
Inserts a new submission in the specified topic within the specified series.
 
@@ -29,7 +81,110 @@ Args:
  topicId: integer, The decimal ID of the Topic within the Series. (required)
  unauthToken: string, User identifier for unauthenticated usage mode
  body: object, The request body. (required)
-  anonymous: boolean, Set to true to mark the new submission as anonymous.
+    The object takes the form of:
+ 
+{
+    "kind": "moderator#submission",
+    "attribution": {
+      "displayName": "A String",
+      "location": "A String",
+      "avatarUrl": "A String",
+    },
+    "created": "A String",
+    "text": "A String",
+    "topics": [
+      {
+        "id": {
+          "seriesId": "A String",
+          "topicId": "A String",
+        },
+      },
+    ],
+    "author": "A String",
+    "translations": [
+      {
+        "lang": "A String",
+        "text": "A String",
+      },
+    ],
+    "parentSubmissionId": {
+      "seriesId": "A String",
+      "submissionId": "A String",
+    },
+    "vote": {
+      "vote": "A String",
+      "flag": "A String",
+    },
+    "attachmentUrl": "A String",
+    "geo": {
+      "latitude": 3.140000,
+      "location": "A String",
+      "longitude": 3.140000,
+    },
+    "id": {
+      "seriesId": "A String",
+      "submissionId": "A String",
+    },
+    "counters": {
+      "noneVotes": 42,
+      "minusVotes": 42,
+      "plusVotes": 42,
+    },
+  }
+ 
+  anonymous: boolean, Set to true to mark the new submission as anonymous.
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "moderator#submission",
+      "attribution": {
+        "displayName": "A String",
+        "location": "A String",
+        "avatarUrl": "A String",
+      },
+      "created": "A String",
+      "text": "A String",
+      "topics": [
+        {
+          "id": {
+            "seriesId": "A String",
+            "topicId": "A String",
+          },
+        },
+      ],
+      "author": "A String",
+      "translations": [
+        {
+          "lang": "A String",
+          "text": "A String",
+        },
+      ],
+      "parentSubmissionId": {
+        "seriesId": "A String",
+        "submissionId": "A String",
+      },
+      "vote": {
+        "vote": "A String",
+        "flag": "A String",
+      },
+      "attachmentUrl": "A String",
+      "geo": {
+        "latitude": 3.140000,
+        "location": "A String",
+        "longitude": 3.140000,
+      },
+      "id": {
+        "seriesId": "A String",
+        "submissionId": "A String",
+      },
+      "counters": {
+        "noneVotes": 42,
+        "minusVotes": 42,
+        "plusVotes": 42,
+      },
+    }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.tags.html b/docs/dyn/moderator.v1.tags.html index 1fe8964..58254a5 100644 --- a/docs/dyn/moderator.v1.tags.html +++ b/docs/dyn/moderator.v1.tags.html @@ -26,13 +26,56 @@ Args:
Args:
  seriesId: integer, The decimal ID of the Series. (required)
  body: object, The request body. (required)
-  submissionId: integer, The decimal ID of the Submission within the Series. (required) +    The object takes the form of:
+ 
+{
+    "text": "A String",
+    "kind": "moderator#tag",
+    "id": {
+      "seriesId": "A String",
+      "tagId": "A String",
+      "submissionId": "A String",
+    },
+  }
+ 
+  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "text": "A String",
+      "kind": "moderator#tag",
+      "id": {
+        "seriesId": "A String",
+        "tagId": "A String",
+        "submissionId": "A String",
+      },
+    }
list = method(self, **kwargs)
Lists all tags for the specified submission within the specified series.
 
Args:
  seriesId: integer, The decimal ID of the Series. (required)
-  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [
+      {
+          "text": "A String",
+          "kind": "moderator#tag",
+          "id": {
+            "seriesId": "A String",
+            "tagId": "A String",
+            "submissionId": "A String",
+          },
+        },
+    ],
+    "kind": "moderator#tagList",
+  }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.topics.html b/docs/dyn/moderator.v1.topics.html index f78626b..866d996 100644 --- a/docs/dyn/moderator.v1.topics.html +++ b/docs/dyn/moderator.v1.topics.html @@ -18,13 +18,252 @@  
Args:
  seriesId: integer, The decimal ID of the Series. (required)
-  topicId: integer, The decimal ID of the Topic within the Series. (required) +  topicId: integer, The decimal ID of the Topic within the Series. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "moderator#topic",
+      "description": "A String",
+      "rules": {
+        "votes": {
+          "close": "A String",
+          "open": "A String",
+        },
+        "submissions": {
+          "close": "A String",
+          "open": "A String",
+        },
+      },
+      "featuredSubmission": {
+          "kind": "moderator#submission",
+          "attribution": {
+            "displayName": "A String",
+            "location": "A String",
+            "avatarUrl": "A String",
+          },
+          "created": "A String",
+          "text": "A String",
+          "topics": [
+            {
+              "id": {
+                "seriesId": "A String",
+                "topicId": "A String",
+              },
+            },
+          ],
+          "author": "A String",
+          "translations": [
+            {
+              "lang": "A String",
+              "text": "A String",
+            },
+          ],
+          "parentSubmissionId": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "vote": {
+            "vote": "A String",
+            "flag": "A String",
+          },
+          "attachmentUrl": "A String",
+          "geo": {
+            "latitude": 3.140000,
+            "location": "A String",
+            "longitude": 3.140000,
+          },
+          "id": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "counters": {
+            "noneVotes": 42,
+            "minusVotes": 42,
+            "plusVotes": 42,
+          },
+        },
+      "presenter": "A String",
+      "counters": {
+        "users": 42,
+        "noneVotes": 42,
+        "videoSubmissions": 42,
+        "minusVotes": 42,
+        "submissions": 42,
+        "plusVotes": 42,
+      },
+      "id": {
+        "seriesId": "A String",
+        "topicId": "A String",
+      },
+      "name": "A String",
+    }
insert = method(self, **kwargs)
Inserts a new topic into the specified series.
 
Args:
  seriesId: integer, The decimal ID of the Series. (required)
-  body: object, The request body. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "kind": "moderator#topic",
+    "description": "A String",
+    "rules": {
+      "votes": {
+        "close": "A String",
+        "open": "A String",
+      },
+      "submissions": {
+        "close": "A String",
+        "open": "A String",
+      },
+    },
+    "featuredSubmission": {
+        "kind": "moderator#submission",
+        "attribution": {
+          "displayName": "A String",
+          "location": "A String",
+          "avatarUrl": "A String",
+        },
+        "created": "A String",
+        "text": "A String",
+        "topics": [
+          {
+            "id": {
+              "seriesId": "A String",
+              "topicId": "A String",
+            },
+          },
+        ],
+        "author": "A String",
+        "translations": [
+          {
+            "lang": "A String",
+            "text": "A String",
+          },
+        ],
+        "parentSubmissionId": {
+          "seriesId": "A String",
+          "submissionId": "A String",
+        },
+        "vote": {
+          "vote": "A String",
+          "flag": "A String",
+        },
+        "attachmentUrl": "A String",
+        "geo": {
+          "latitude": 3.140000,
+          "location": "A String",
+          "longitude": 3.140000,
+        },
+        "id": {
+          "seriesId": "A String",
+          "submissionId": "A String",
+        },
+        "counters": {
+          "noneVotes": 42,
+          "minusVotes": 42,
+          "plusVotes": 42,
+        },
+      },
+    "presenter": "A String",
+    "counters": {
+      "users": 42,
+      "noneVotes": 42,
+      "videoSubmissions": 42,
+      "minusVotes": 42,
+      "submissions": 42,
+      "plusVotes": 42,
+    },
+    "id": {
+      "seriesId": "A String",
+      "topicId": "A String",
+    },
+    "name": "A String",
+  }
+ 
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "moderator#topic",
+      "description": "A String",
+      "rules": {
+        "votes": {
+          "close": "A String",
+          "open": "A String",
+        },
+        "submissions": {
+          "close": "A String",
+          "open": "A String",
+        },
+      },
+      "featuredSubmission": {
+          "kind": "moderator#submission",
+          "attribution": {
+            "displayName": "A String",
+            "location": "A String",
+            "avatarUrl": "A String",
+          },
+          "created": "A String",
+          "text": "A String",
+          "topics": [
+            {
+              "id": {
+                "seriesId": "A String",
+                "topicId": "A String",
+              },
+            },
+          ],
+          "author": "A String",
+          "translations": [
+            {
+              "lang": "A String",
+              "text": "A String",
+            },
+          ],
+          "parentSubmissionId": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "vote": {
+            "vote": "A String",
+            "flag": "A String",
+          },
+          "attachmentUrl": "A String",
+          "geo": {
+            "latitude": 3.140000,
+            "location": "A String",
+            "longitude": 3.140000,
+          },
+          "id": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "counters": {
+            "noneVotes": 42,
+            "minusVotes": 42,
+            "plusVotes": 42,
+          },
+        },
+      "presenter": "A String",
+      "counters": {
+        "users": 42,
+        "noneVotes": 42,
+        "videoSubmissions": 42,
+        "minusVotes": 42,
+        "submissions": 42,
+        "plusVotes": 42,
+      },
+      "id": {
+        "seriesId": "A String",
+        "topicId": "A String",
+      },
+      "name": "A String",
+    }
list = method(self, **kwargs)
Searches the topics within the specified series and returns the search results.
 
@@ -33,7 +272,92 @@ Args:
  q: string, Search query.
  max_results: integer, Maximum number of results to return.
  mode: string, A parameter
-  start_index: integer, Index of the first result to be retrieved.
+  start_index: integer, Index of the first result to be retrieved.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [
+      {
+          "kind": "moderator#topic",
+          "description": "A String",
+          "rules": {
+            "votes": {
+              "close": "A String",
+              "open": "A String",
+            },
+            "submissions": {
+              "close": "A String",
+              "open": "A String",
+            },
+          },
+          "featuredSubmission": {
+              "kind": "moderator#submission",
+              "attribution": {
+                "displayName": "A String",
+                "location": "A String",
+                "avatarUrl": "A String",
+              },
+              "created": "A String",
+              "text": "A String",
+              "topics": [
+                {
+                  "id": {
+                    "seriesId": "A String",
+                    "topicId": "A String",
+                  },
+                },
+              ],
+              "author": "A String",
+              "translations": [
+                {
+                  "lang": "A String",
+                  "text": "A String",
+                },
+              ],
+              "parentSubmissionId": {
+                "seriesId": "A String",
+                "submissionId": "A String",
+              },
+              "vote": {
+                "vote": "A String",
+                "flag": "A String",
+              },
+              "attachmentUrl": "A String",
+              "geo": {
+                "latitude": 3.140000,
+                "location": "A String",
+                "longitude": 3.140000,
+              },
+              "id": {
+                "seriesId": "A String",
+                "submissionId": "A String",
+              },
+              "counters": {
+                "noneVotes": 42,
+                "minusVotes": 42,
+                "plusVotes": 42,
+              },
+            },
+          "presenter": "A String",
+          "counters": {
+            "users": 42,
+            "noneVotes": 42,
+            "videoSubmissions": 42,
+            "minusVotes": 42,
+            "submissions": 42,
+            "plusVotes": 42,
+          },
+          "id": {
+            "seriesId": "A String",
+            "topicId": "A String",
+          },
+          "name": "A String",
+        },
+    ],
+    "kind": "moderator#topicList",
+  }
submissions = methodResource(self)
A collection resource.
@@ -42,7 +366,166 @@ Args:
Args:
  seriesId: integer, The decimal ID of the Series. (required)
  topicId: integer, The decimal ID of the Topic within the Series. (required)
-  body: object, The request body. (required) +  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "kind": "moderator#topic",
+    "description": "A String",
+    "rules": {
+      "votes": {
+        "close": "A String",
+        "open": "A String",
+      },
+      "submissions": {
+        "close": "A String",
+        "open": "A String",
+      },
+    },
+    "featuredSubmission": {
+        "kind": "moderator#submission",
+        "attribution": {
+          "displayName": "A String",
+          "location": "A String",
+          "avatarUrl": "A String",
+        },
+        "created": "A String",
+        "text": "A String",
+        "topics": [
+          {
+            "id": {
+              "seriesId": "A String",
+              "topicId": "A String",
+            },
+          },
+        ],
+        "author": "A String",
+        "translations": [
+          {
+            "lang": "A String",
+            "text": "A String",
+          },
+        ],
+        "parentSubmissionId": {
+          "seriesId": "A String",
+          "submissionId": "A String",
+        },
+        "vote": {
+          "vote": "A String",
+          "flag": "A String",
+        },
+        "attachmentUrl": "A String",
+        "geo": {
+          "latitude": 3.140000,
+          "location": "A String",
+          "longitude": 3.140000,
+        },
+        "id": {
+          "seriesId": "A String",
+          "submissionId": "A String",
+        },
+        "counters": {
+          "noneVotes": 42,
+          "minusVotes": 42,
+          "plusVotes": 42,
+        },
+      },
+    "presenter": "A String",
+    "counters": {
+      "users": 42,
+      "noneVotes": 42,
+      "videoSubmissions": 42,
+      "minusVotes": 42,
+      "submissions": 42,
+      "plusVotes": 42,
+    },
+    "id": {
+      "seriesId": "A String",
+      "topicId": "A String",
+    },
+    "name": "A String",
+  }
+ 
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "moderator#topic",
+      "description": "A String",
+      "rules": {
+        "votes": {
+          "close": "A String",
+          "open": "A String",
+        },
+        "submissions": {
+          "close": "A String",
+          "open": "A String",
+        },
+      },
+      "featuredSubmission": {
+          "kind": "moderator#submission",
+          "attribution": {
+            "displayName": "A String",
+            "location": "A String",
+            "avatarUrl": "A String",
+          },
+          "created": "A String",
+          "text": "A String",
+          "topics": [
+            {
+              "id": {
+                "seriesId": "A String",
+                "topicId": "A String",
+              },
+            },
+          ],
+          "author": "A String",
+          "translations": [
+            {
+              "lang": "A String",
+              "text": "A String",
+            },
+          ],
+          "parentSubmissionId": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "vote": {
+            "vote": "A String",
+            "flag": "A String",
+          },
+          "attachmentUrl": "A String",
+          "geo": {
+            "latitude": 3.140000,
+            "location": "A String",
+            "longitude": 3.140000,
+          },
+          "id": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "counters": {
+            "noneVotes": 42,
+            "minusVotes": 42,
+            "plusVotes": 42,
+          },
+        },
+      "presenter": "A String",
+      "counters": {
+        "users": 42,
+        "noneVotes": 42,
+        "videoSubmissions": 42,
+        "minusVotes": 42,
+        "submissions": 42,
+        "plusVotes": 42,
+      },
+      "id": {
+        "seriesId": "A String",
+        "topicId": "A String",
+      },
+      "name": "A String",
+    }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.topics.submissions.html b/docs/dyn/moderator.v1.topics.submissions.html index 8283e3c..43a063f 100644 --- a/docs/dyn/moderator.v1.topics.submissions.html +++ b/docs/dyn/moderator.v1.topics.submissions.html @@ -25,7 +25,64 @@ Args:
  max_results: integer, Maximum number of results to return.
  q: string, Search query.
  start_index: integer, Index of the first result to be retrieved.
-  hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached. +  hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [
+      {
+          "kind": "moderator#submission",
+          "attribution": {
+            "displayName": "A String",
+            "location": "A String",
+            "avatarUrl": "A String",
+          },
+          "created": "A String",
+          "text": "A String",
+          "topics": [
+            {
+              "id": {
+                "seriesId": "A String",
+                "topicId": "A String",
+              },
+            },
+          ],
+          "author": "A String",
+          "translations": [
+            {
+              "lang": "A String",
+              "text": "A String",
+            },
+          ],
+          "parentSubmissionId": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "vote": {
+            "vote": "A String",
+            "flag": "A String",
+          },
+          "attachmentUrl": "A String",
+          "geo": {
+            "latitude": 3.140000,
+            "location": "A String",
+            "longitude": 3.140000,
+          },
+          "id": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "counters": {
+            "noneVotes": 42,
+            "minusVotes": 42,
+            "plusVotes": 42,
+          },
+        },
+    ],
+    "kind": "moderator#submissionList",
+  }
Data descriptors defined here:
diff --git a/docs/dyn/moderator.v1.votes.html b/docs/dyn/moderator.v1.votes.html index 57e4963..0827d74 100644 --- a/docs/dyn/moderator.v1.votes.html +++ b/docs/dyn/moderator.v1.votes.html @@ -20,40 +20,146 @@ Args:
  seriesId: integer, The decimal ID of the Series. (required)
  unauthToken: string, User identifier for unauthenticated usage mode
  userId: string, A parameter
-  submissionId: integer, The decimal ID of the Submission within the Series. (required) +  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "vote": "A String",
+      "flag": "A String",
+      "id": {
+        "seriesId": "A String",
+        "submissionId": "A String",
+      },
+      "kind": "moderator#vote",
+    }
insert = method(self, **kwargs)
Inserts a new vote by the authenticated user for the specified submission within the specified series.
 
Args:
  seriesId: integer, The decimal ID of the Series. (required)
  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "vote": "A String",
+    "flag": "A String",
+    "id": {
+      "seriesId": "A String",
+      "submissionId": "A String",
+    },
+    "kind": "moderator#vote",
+  }
+ 
  unauthToken: string, User identifier for unauthenticated usage mode
-  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "vote": "A String",
+      "flag": "A String",
+      "id": {
+        "seriesId": "A String",
+        "submissionId": "A String",
+      },
+      "kind": "moderator#vote",
+    }
list = method(self, **kwargs)
Lists the votes by the authenticated user for the given series.
 
Args:
  seriesId: integer, The decimal ID of the Series. (required)
  max_results: integer, Maximum number of results to return.
-  start_index: integer, Index of the first result to be retrieved.
+  start_index: integer, Index of the first result to be retrieved.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [
+      {
+          "vote": "A String",
+          "flag": "A String",
+          "id": {
+            "seriesId": "A String",
+            "submissionId": "A String",
+          },
+          "kind": "moderator#vote",
+        },
+    ],
+    "kind": "moderator#voteList",
+  }
patch = method(self, **kwargs)
Updates the votes by the authenticated user for the specified submission within the specified series. This method supports patch semantics.
 
Args:
  seriesId: integer, The decimal ID of the Series. (required)
  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "vote": "A String",
+    "flag": "A String",
+    "id": {
+      "seriesId": "A String",
+      "submissionId": "A String",
+    },
+    "kind": "moderator#vote",
+  }
+ 
  unauthToken: string, User identifier for unauthenticated usage mode
  userId: string, A parameter
-  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "vote": "A String",
+      "flag": "A String",
+      "id": {
+        "seriesId": "A String",
+        "submissionId": "A String",
+      },
+      "kind": "moderator#vote",
+    }
update = method(self, **kwargs)
Updates the votes by the authenticated user for the specified submission within the specified series.
 
Args:
  seriesId: integer, The decimal ID of the Series. (required)
  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "vote": "A String",
+    "flag": "A String",
+    "id": {
+      "seriesId": "A String",
+      "submissionId": "A String",
+    },
+    "kind": "moderator#vote",
+  }
+ 
  unauthToken: string, User identifier for unauthenticated usage mode
  userId: string, A parameter
-  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "vote": "A String",
+      "flag": "A String",
+      "id": {
+        "seriesId": "A String",
+        "submissionId": "A String",
+      },
+      "kind": "moderator#vote",
+    }
Data descriptors defined here:
diff --git a/docs/dyn/orkut.v2.activities.html b/docs/dyn/orkut.v2.activities.html index 6dc674c..d682ee5 100644 --- a/docs/dyn/orkut.v2.activities.html +++ b/docs/dyn/orkut.v2.activities.html @@ -30,7 +30,124 @@ Args:
      all - All activities created by the specified user that the authenticated user is authorized to view.
      scraps - The specified user's scrapbook.
      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.
-  hl: string, Specifies the interface language (host language) of your user interface. +  hl: string, Specifies the interface language (host language) of your user interface.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The value of pageToken query parameter in activities.list request to get the next page, if there are more to retrieve.
+    "items": [ # List of activities retrieved.
+      {
+        "kind": "orkut#activity", # The kind of activity. Always orkut#activity.
+        "links": [ # Links to resources related to this activity.
+          { # Links to resources related to the parent object.
+            "href": "A String", # URL of the link.
+            "type": "A String", # Media type of the link.
+            "rel": "A String", # Relation between the resource and the parent object.
+            "title": "A String", # Title of the link.
+          },
+        ],
+        "title": "A String", # Title of the activity.
+        "object": { # The activity's object.
+          "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
+          "items": [ # The list of additional items.
+            {
+              "displayName": "A String", # The title of the object.
+              "links": [ # Links to other resources related to this object.
+                { # Links to resources related to the parent object.
+                  "href": "A String", # URL of the link.
+                  "type": "A String", # Media type of the link.
+                  "rel": "A String", # Relation between the resource and the parent object.
+                  "title": "A String", # Title of the link.
+                },
+              ],
+              "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
+              "person": { # The person who is related with this activity, e.g. an Added User.
+                "name": { # An object that encapsulates the individual components of a person's name.
+                  "givenName": "A String", # The given name (first name) of this person.
+                  "familyName": "A String", # The family name (last name) of this person.
+                },
+                "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+                "gender": "A String", # The person's gender. Values include "male", "female", and "other".
+                "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+                  "url": "A String", # The URL of the person's profile photo.
+                },
+                "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+                "id": "A String", # The person's opensocial ID.
+              },
+              "id": "A String", # The ID for the object.
+              "objectType": "A String", # The object type.
+            },
+          ],
+          "replies": { # Comments in reply to this activity.
+            "totalItems": "A String", # Total number of comments.
+            "items": [ # The list of comments.
+              {
+                "inReplyTo": { # Link to the original activity where this comment was posted.
+                  "type": "A String", # Type of the post on activity stream being commented. Always text/html.
+                  "href": "A String", # Link to the post on activity stream being commented.
+                  "ref": "A String", # Unique identifier of the post on activity stream being commented.
+                  "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
+                },
+                "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
+                "links": [ # List of resources for the comment.
+                  { # Links to resources related to the parent object.
+                    "href": "A String", # URL of the link.
+                    "type": "A String", # Media type of the link.
+                    "rel": "A String", # Relation between the resource and the parent object.
+                    "title": "A String", # Title of the link.
+                  },
+                ],
+                "actor": { # The person who posted the comment.
+                  "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+                  "image": { # Image data about the actor.
+                    "url": "A String", # A URL that points to a thumbnail photo of the author.
+                  },
+                  "displayName": "A String", # The name of the author, suitable for display.
+                  "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+                },
+                "content": "A String", # The content of the comment in text/html
+                "published": "A String", # The time the comment was initially published, in RFC 3339 format.
+                "id": "A String", # The unique ID for the comment.
+              },
+            ],
+            "url": "A String", # URL for the collection of comments in reply to this activity.
+          },
+          "objectType": "A String", # The type of the object affected by the activity. Clients can use this information to style the rendered activity object differently depending on the content.
+        },
+        "updated": "A String", # The time at which the activity was last updated.
+        "actor": { # The person who performed the activity.
+          "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+          "image": { # Image data about the actor.
+            "url": "A String", # A URL that points to a thumbnail photo of the author.
+          },
+          "displayName": "A String", # The name of the author, suitable for display.
+          "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+        },
+        "access": { # Identifies who has access to see this activity.
+          "items": [ # The list of ACL entries.
+            {
+              "type": "A String", # The type of entity to whom access is granted.
+              "id": "A String", # The ID of the entity. For entities of type "person" or "circle", this is the ID of the resource. For other types, this will be unset.
+            },
+          ],
+          "kind": "orkut#acl", # Identifies this resource as an access control list. Value: "orkut#acl"
+          "description": "A String", # Human readable description of the access granted.
+          "totalParticipants": 42, # The total count of participants of the parent resource.
+        },
+        "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
+            # - add - User added new content to profile or album, e.g. video, photo.
+            # - post - User publish content to the stream, e.g. status, scrap.
+            # - update - User commented on an activity.
+            # - make-friend - User added a new friend.
+            # - birthday - User has a birthday.
+        "published": "A String", # The time at which the activity was initially published.
+        "id": "A String", # The ID for the activity.
+      },
+    ],
+    "kind": "orkut#activityList", # Identifies this resource as a collection of activities. Value: "orkut#activityList"
+  }
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
diff --git a/docs/dyn/orkut.v2.activityVisibility.html b/docs/dyn/orkut.v2.activityVisibility.html index 4844bdc..ce76a76 100644 --- a/docs/dyn/orkut.v2.activityVisibility.html +++ b/docs/dyn/orkut.v2.activityVisibility.html @@ -17,19 +17,107 @@
get = method(self, **kwargs)
Gets the visibility of an existing activity.
 
Args:
-  activityId: string, ID of the activity to get the visibility. (required)
+  activityId: string, ID of the activity to get the visibility. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
+      "visibility": "A String", # The visibility of the resource. Possible values are:
+          # - default: not hidden by the user
+          # - hidden: hidden
+      "links": [ # List of resources for the visibility item.
+        { # Links to resources related to the parent object.
+          "href": "A String", # URL of the link.
+          "type": "A String", # Media type of the link.
+          "rel": "A String", # Relation between the resource and the parent object.
+          "title": "A String", # Title of the link.
+        },
+      ],
+    }
patch = method(self, **kwargs)
Updates the visibility of an existing activity. This method supports patch semantics.
 
Args:
  body: object, The request body. (required)
-  activityId: string, ID of the activity. (required)
+    The object takes the form of:
+ 
+{
+    "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
+    "visibility": "A String", # The visibility of the resource. Possible values are:
+        # - default: not hidden by the user
+        # - hidden: hidden
+    "links": [ # List of resources for the visibility item.
+      { # Links to resources related to the parent object.
+        "href": "A String", # URL of the link.
+        "type": "A String", # Media type of the link.
+        "rel": "A String", # Relation between the resource and the parent object.
+        "title": "A String", # Title of the link.
+      },
+    ],
+  }
+ 
+  activityId: string, ID of the activity. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
+      "visibility": "A String", # The visibility of the resource. Possible values are:
+          # - default: not hidden by the user
+          # - hidden: hidden
+      "links": [ # List of resources for the visibility item.
+        { # Links to resources related to the parent object.
+          "href": "A String", # URL of the link.
+          "type": "A String", # Media type of the link.
+          "rel": "A String", # Relation between the resource and the parent object.
+          "title": "A String", # Title of the link.
+        },
+      ],
+    }
update = method(self, **kwargs)
Updates the visibility of an existing activity.
 
Args:
  body: object, The request body. (required)
-  activityId: string, ID of the activity. (required)
+    The object takes the form of:
+ 
+{
+    "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
+    "visibility": "A String", # The visibility of the resource. Possible values are:
+        # - default: not hidden by the user
+        # - hidden: hidden
+    "links": [ # List of resources for the visibility item.
+      { # Links to resources related to the parent object.
+        "href": "A String", # URL of the link.
+        "type": "A String", # Media type of the link.
+        "rel": "A String", # Relation between the resource and the parent object.
+        "title": "A String", # Title of the link.
+      },
+    ],
+  }
+ 
+  activityId: string, ID of the activity. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
+      "visibility": "A String", # The visibility of the resource. Possible values are:
+          # - default: not hidden by the user
+          # - hidden: hidden
+      "links": [ # List of resources for the visibility item.
+        { # Links to resources related to the parent object.
+          "href": "A String", # URL of the link.
+          "type": "A String", # Media type of the link.
+          "rel": "A String", # Relation between the resource and the parent object.
+          "title": "A String", # Title of the link.
+        },
+      ],
+    }
Data descriptors defined here:
diff --git a/docs/dyn/orkut.v2.badges.html b/docs/dyn/orkut.v2.badges.html index b233f84..97f8884 100644 --- a/docs/dyn/orkut.v2.badges.html +++ b/docs/dyn/orkut.v2.badges.html @@ -18,12 +18,47 @@  
Args:
  badgeId: string, The ID of the badge that will be retrieved. (required)
-  userId: string, The ID of the user whose badges will be listed. Can be me to refer to caller. (required) +  userId: string, The ID of the user whose badges will be listed. Can be me to refer to caller. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "badgeSmallLogo": "A String", # The URL for the 24x24 badge logo.
+    "kind": "orkut#badge", # Identifies this resource as a badge. Value: "orkut#badge"
+    "description": "A String", # The description for the badge, suitable for display.
+    "sponsorLogo": "A String", # The URL for the 32x32 badge sponsor logo.
+    "sponsorName": "A String", # The name of the badge sponsor, suitable for display.
+    "badgeLargeLogo": "A String", # The URL for the 64x64 badge logo.
+    "caption": "A String", # The name of the badge, suitable for display.
+    "sponsorUrl": "A String", # The URL for the badge sponsor.
+    "id": "A String", # The unique ID for the badge.
+  }
list = method(self, **kwargs)
Retrieves the list of visible badges of a user.
 
Args:
-  userId: string, The id of the user whose badges will be listed. Can be me to refer to caller. (required)
+  userId: string, The id of the user whose badges will be listed. Can be me to refer to caller. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # List of badges retrieved.
+      {
+        "badgeSmallLogo": "A String", # The URL for the 24x24 badge logo.
+        "kind": "orkut#badge", # Identifies this resource as a badge. Value: "orkut#badge"
+        "description": "A String", # The description for the badge, suitable for display.
+        "sponsorLogo": "A String", # The URL for the 32x32 badge sponsor logo.
+        "sponsorName": "A String", # The name of the badge sponsor, suitable for display.
+        "badgeLargeLogo": "A String", # The URL for the 64x64 badge logo.
+        "caption": "A String", # The name of the badge, suitable for display.
+        "sponsorUrl": "A String", # The URL for the badge sponsor.
+        "id": "A String", # The unique ID for the badge.
+      },
+    ],
+    "kind": "orkut#badgeList", # Identifies this resource as a collection of badges. Value: "orkut#badgeList"
+  }
Data descriptors defined here:
diff --git a/docs/dyn/orkut.v2.comments.html b/docs/dyn/orkut.v2.comments.html index 717293a..e4c706e 100644 --- a/docs/dyn/orkut.v2.comments.html +++ b/docs/dyn/orkut.v2.comments.html @@ -23,13 +23,108 @@ Args:
 
Args:
  hl: string, Specifies the interface language (host language) of your user interface.
-  commentId: string, ID of the comment to get. (required) +  commentId: string, ID of the comment to get. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "inReplyTo": { # Link to the original activity where this comment was posted.
+      "type": "A String", # Type of the post on activity stream being commented. Always text/html.
+      "href": "A String", # Link to the post on activity stream being commented.
+      "ref": "A String", # Unique identifier of the post on activity stream being commented.
+      "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
+    },
+    "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
+    "links": [ # List of resources for the comment.
+      { # Links to resources related to the parent object.
+        "href": "A String", # URL of the link.
+        "type": "A String", # Media type of the link.
+        "rel": "A String", # Relation between the resource and the parent object.
+        "title": "A String", # Title of the link.
+      },
+    ],
+    "actor": { # The person who posted the comment.
+      "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+      "image": { # Image data about the actor.
+        "url": "A String", # A URL that points to a thumbnail photo of the author.
+      },
+      "displayName": "A String", # The name of the author, suitable for display.
+      "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+    },
+    "content": "A String", # The content of the comment in text/html
+    "published": "A String", # The time the comment was initially published, in RFC 3339 format.
+    "id": "A String", # The unique ID for the comment.
+  }
insert = method(self, **kwargs)
Inserts a new comment to an activity.
 
Args:
  body: object, The request body. (required)
-  activityId: string, The ID of the activity to contain the new comment. (required)
+    The object takes the form of:
+ 
+{
+  "inReplyTo": { # Link to the original activity where this comment was posted.
+    "type": "A String", # Type of the post on activity stream being commented. Always text/html.
+    "href": "A String", # Link to the post on activity stream being commented.
+    "ref": "A String", # Unique identifier of the post on activity stream being commented.
+    "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
+  },
+  "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
+  "links": [ # List of resources for the comment.
+    { # Links to resources related to the parent object.
+      "href": "A String", # URL of the link.
+      "type": "A String", # Media type of the link.
+      "rel": "A String", # Relation between the resource and the parent object.
+      "title": "A String", # Title of the link.
+    },
+  ],
+  "actor": { # The person who posted the comment.
+    "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+    "image": { # Image data about the actor.
+      "url": "A String", # A URL that points to a thumbnail photo of the author.
+    },
+    "displayName": "A String", # The name of the author, suitable for display.
+    "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+  },
+  "content": "A String", # The content of the comment in text/html
+  "published": "A String", # The time the comment was initially published, in RFC 3339 format.
+  "id": "A String", # The unique ID for the comment.
+}
+ 
+  activityId: string, The ID of the activity to contain the new comment. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "inReplyTo": { # Link to the original activity where this comment was posted.
+      "type": "A String", # Type of the post on activity stream being commented. Always text/html.
+      "href": "A String", # Link to the post on activity stream being commented.
+      "ref": "A String", # Unique identifier of the post on activity stream being commented.
+      "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
+    },
+    "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
+    "links": [ # List of resources for the comment.
+      { # Links to resources related to the parent object.
+        "href": "A String", # URL of the link.
+        "type": "A String", # Media type of the link.
+        "rel": "A String", # Relation between the resource and the parent object.
+        "title": "A String", # Title of the link.
+      },
+    ],
+    "actor": { # The person who posted the comment.
+      "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+      "image": { # Image data about the actor.
+        "url": "A String", # A URL that points to a thumbnail photo of the author.
+      },
+      "displayName": "A String", # The name of the author, suitable for display.
+      "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+    },
+    "content": "A String", # The content of the comment in text/html
+    "published": "A String", # The time the comment was initially published, in RFC 3339 format.
+    "id": "A String", # The unique ID for the comment.
+  }
list = method(self, **kwargs)
Retrieves a list of comments, possibly filtered.
 
@@ -41,7 +136,46 @@ Args:
  pageToken: string, A continuation token that allows pagination.
  maxResults: integer, The maximum number of activities to include in the response.
  activityId: string, The ID of the activity containing the comments. (required)
-  hl: string, Specifies the interface language (host language) of your user interface.
+  hl: string, Specifies the interface language (host language) of your user interface.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The value of pageToken query parameter in comments.list request to get the next page, if there are more to retrieve.
+    "items": [ # List of comments retrieved.
+      {
+        "inReplyTo": { # Link to the original activity where this comment was posted.
+          "type": "A String", # Type of the post on activity stream being commented. Always text/html.
+          "href": "A String", # Link to the post on activity stream being commented.
+          "ref": "A String", # Unique identifier of the post on activity stream being commented.
+          "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
+        },
+        "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
+        "links": [ # List of resources for the comment.
+          { # Links to resources related to the parent object.
+            "href": "A String", # URL of the link.
+            "type": "A String", # Media type of the link.
+            "rel": "A String", # Relation between the resource and the parent object.
+            "title": "A String", # Title of the link.
+          },
+        ],
+        "actor": { # The person who posted the comment.
+          "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+          "image": { # Image data about the actor.
+            "url": "A String", # A URL that points to a thumbnail photo of the author.
+          },
+          "displayName": "A String", # The name of the author, suitable for display.
+          "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+        },
+        "content": "A String", # The content of the comment in text/html
+        "published": "A String", # The time the comment was initially published, in RFC 3339 format.
+        "id": "A String", # The unique ID for the comment.
+      },
+    ],
+    "kind": "orkut#commentList", # Identifies this resource as a collection of comments. Value: "orkut#commentList"
+    "previousPageToken": "A String", # The value of pageToken query parameter in comments.list request to get the previous page, if there are more to retrieve.
+  }
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
diff --git a/docs/dyn/orkut.v2.counters.html b/docs/dyn/orkut.v2.counters.html index 7d9f0b8..6fac13c 100644 --- a/docs/dyn/orkut.v2.counters.html +++ b/docs/dyn/orkut.v2.counters.html @@ -17,7 +17,29 @@
list = method(self, **kwargs)
Retrieves the counters of an user.
 
Args:
-  userId: string, The ID of the user whose counters will be listed. Can be me to refer to caller. (required)
+  userId: string, The ID of the user whose counters will be listed. Can be me to refer to caller. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # List of counters retrieved.
+      {
+        "total": 42, # The number of resources on the counted collection.
+        "link": { # Links to resources related to the parent object. # Link to the collection being counted.
+          "href": "A String", # URL of the link.
+          "type": "A String", # Media type of the link.
+          "rel": "A String", # Relation between the resource and the parent object.
+          "title": "A String", # Title of the link.
+        },
+        "name": "A String", # The name of the counted collection. Currently supported collections are:
+            # - scraps - The scraps of the user.
+            # - photos - The photos of the user.
+            # - videos - The videos of the user.
+      },
+    ],
+    "kind": "orkut#counters", # Identifies this resource as a collection of counters. Value: "orkut#counters"
+  }
Data descriptors defined here:
diff --git a/docs/dyn/orkut.v2.scraps.html b/docs/dyn/orkut.v2.scraps.html index 15a00e7..117fe0f 100644 --- a/docs/dyn/orkut.v2.scraps.html +++ b/docs/dyn/orkut.v2.scraps.html @@ -17,7 +17,228 @@
insert = method(self, **kwargs)
Creates a new scrap.
 
Args:
-  body: object, The request body. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+  "kind": "orkut#activity", # The kind of activity. Always orkut#activity.
+  "links": [ # Links to resources related to this activity.
+    { # Links to resources related to the parent object.
+      "href": "A String", # URL of the link.
+      "type": "A String", # Media type of the link.
+      "rel": "A String", # Relation between the resource and the parent object.
+      "title": "A String", # Title of the link.
+    },
+  ],
+  "title": "A String", # Title of the activity.
+  "object": { # The activity's object.
+    "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
+    "items": [ # The list of additional items.
+      {
+        "displayName": "A String", # The title of the object.
+        "links": [ # Links to other resources related to this object.
+          { # Links to resources related to the parent object.
+            "href": "A String", # URL of the link.
+            "type": "A String", # Media type of the link.
+            "rel": "A String", # Relation between the resource and the parent object.
+            "title": "A String", # Title of the link.
+          },
+        ],
+        "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
+        "person": { # The person who is related with this activity, e.g. an Added User.
+          "name": { # An object that encapsulates the individual components of a person's name.
+            "givenName": "A String", # The given name (first name) of this person.
+            "familyName": "A String", # The family name (last name) of this person.
+          },
+          "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+          "gender": "A String", # The person's gender. Values include "male", "female", and "other".
+          "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+            "url": "A String", # The URL of the person's profile photo.
+          },
+          "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+          "id": "A String", # The person's opensocial ID.
+        },
+        "id": "A String", # The ID for the object.
+        "objectType": "A String", # The object type.
+      },
+    ],
+    "replies": { # Comments in reply to this activity.
+      "totalItems": "A String", # Total number of comments.
+      "items": [ # The list of comments.
+        {
+          "inReplyTo": { # Link to the original activity where this comment was posted.
+            "type": "A String", # Type of the post on activity stream being commented. Always text/html.
+            "href": "A String", # Link to the post on activity stream being commented.
+            "ref": "A String", # Unique identifier of the post on activity stream being commented.
+            "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
+          },
+          "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
+          "links": [ # List of resources for the comment.
+            { # Links to resources related to the parent object.
+              "href": "A String", # URL of the link.
+              "type": "A String", # Media type of the link.
+              "rel": "A String", # Relation between the resource and the parent object.
+              "title": "A String", # Title of the link.
+            },
+          ],
+          "actor": { # The person who posted the comment.
+            "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+            "image": { # Image data about the actor.
+              "url": "A String", # A URL that points to a thumbnail photo of the author.
+            },
+            "displayName": "A String", # The name of the author, suitable for display.
+            "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+          },
+          "content": "A String", # The content of the comment in text/html
+          "published": "A String", # The time the comment was initially published, in RFC 3339 format.
+          "id": "A String", # The unique ID for the comment.
+        },
+      ],
+      "url": "A String", # URL for the collection of comments in reply to this activity.
+    },
+    "objectType": "A String", # The type of the object affected by the activity. Clients can use this information to style the rendered activity object differently depending on the content.
+  },
+  "updated": "A String", # The time at which the activity was last updated.
+  "actor": { # The person who performed the activity.
+    "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+    "image": { # Image data about the actor.
+      "url": "A String", # A URL that points to a thumbnail photo of the author.
+    },
+    "displayName": "A String", # The name of the author, suitable for display.
+    "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+  },
+  "access": { # Identifies who has access to see this activity.
+    "items": [ # The list of ACL entries.
+      {
+        "type": "A String", # The type of entity to whom access is granted.
+        "id": "A String", # The ID of the entity. For entities of type "person" or "circle", this is the ID of the resource. For other types, this will be unset.
+      },
+    ],
+    "kind": "orkut#acl", # Identifies this resource as an access control list. Value: "orkut#acl"
+    "description": "A String", # Human readable description of the access granted.
+    "totalParticipants": 42, # The total count of participants of the parent resource.
+  },
+  "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
+      # - add - User added new content to profile or album, e.g. video, photo.
+      # - post - User publish content to the stream, e.g. status, scrap.
+      # - update - User commented on an activity.
+      # - make-friend - User added a new friend.
+      # - birthday - User has a birthday.
+  "published": "A String", # The time at which the activity was initially published.
+  "id": "A String", # The ID for the activity.
+}
+ 
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "orkut#activity", # The kind of activity. Always orkut#activity.
+    "links": [ # Links to resources related to this activity.
+      { # Links to resources related to the parent object.
+        "href": "A String", # URL of the link.
+        "type": "A String", # Media type of the link.
+        "rel": "A String", # Relation between the resource and the parent object.
+        "title": "A String", # Title of the link.
+      },
+    ],
+    "title": "A String", # Title of the activity.
+    "object": { # The activity's object.
+      "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
+      "items": [ # The list of additional items.
+        {
+          "displayName": "A String", # The title of the object.
+          "links": [ # Links to other resources related to this object.
+            { # Links to resources related to the parent object.
+              "href": "A String", # URL of the link.
+              "type": "A String", # Media type of the link.
+              "rel": "A String", # Relation between the resource and the parent object.
+              "title": "A String", # Title of the link.
+            },
+          ],
+          "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
+          "person": { # The person who is related with this activity, e.g. an Added User.
+            "name": { # An object that encapsulates the individual components of a person's name.
+              "givenName": "A String", # The given name (first name) of this person.
+              "familyName": "A String", # The family name (last name) of this person.
+            },
+            "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+            "gender": "A String", # The person's gender. Values include "male", "female", and "other".
+            "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
+              "url": "A String", # The URL of the person's profile photo.
+            },
+            "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+            "id": "A String", # The person's opensocial ID.
+          },
+          "id": "A String", # The ID for the object.
+          "objectType": "A String", # The object type.
+        },
+      ],
+      "replies": { # Comments in reply to this activity.
+        "totalItems": "A String", # Total number of comments.
+        "items": [ # The list of comments.
+          {
+            "inReplyTo": { # Link to the original activity where this comment was posted.
+              "type": "A String", # Type of the post on activity stream being commented. Always text/html.
+              "href": "A String", # Link to the post on activity stream being commented.
+              "ref": "A String", # Unique identifier of the post on activity stream being commented.
+              "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
+            },
+            "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
+            "links": [ # List of resources for the comment.
+              { # Links to resources related to the parent object.
+                "href": "A String", # URL of the link.
+                "type": "A String", # Media type of the link.
+                "rel": "A String", # Relation between the resource and the parent object.
+                "title": "A String", # Title of the link.
+              },
+            ],
+            "actor": { # The person who posted the comment.
+              "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+              "image": { # Image data about the actor.
+                "url": "A String", # A URL that points to a thumbnail photo of the author.
+              },
+              "displayName": "A String", # The name of the author, suitable for display.
+              "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+            },
+            "content": "A String", # The content of the comment in text/html
+            "published": "A String", # The time the comment was initially published, in RFC 3339 format.
+            "id": "A String", # The unique ID for the comment.
+          },
+        ],
+        "url": "A String", # URL for the collection of comments in reply to this activity.
+      },
+      "objectType": "A String", # The type of the object affected by the activity. Clients can use this information to style the rendered activity object differently depending on the content.
+    },
+    "updated": "A String", # The time at which the activity was last updated.
+    "actor": { # The person who performed the activity.
+      "url": "A String", # The URL of the author who posted the comment [not yet implemented]
+      "image": { # Image data about the actor.
+        "url": "A String", # A URL that points to a thumbnail photo of the author.
+      },
+      "displayName": "A String", # The name of the author, suitable for display.
+      "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
+    },
+    "access": { # Identifies who has access to see this activity.
+      "items": [ # The list of ACL entries.
+        {
+          "type": "A String", # The type of entity to whom access is granted.
+          "id": "A String", # The ID of the entity. For entities of type "person" or "circle", this is the ID of the resource. For other types, this will be unset.
+        },
+      ],
+      "kind": "orkut#acl", # Identifies this resource as an access control list. Value: "orkut#acl"
+      "description": "A String", # Human readable description of the access granted.
+      "totalParticipants": 42, # The total count of participants of the parent resource.
+    },
+    "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
+        # - add - User added new content to profile or album, e.g. video, photo.
+        # - post - User publish content to the stream, e.g. status, scrap.
+        # - update - User commented on an activity.
+        # - make-friend - User added a new friend.
+        # - birthday - User has a birthday.
+    "published": "A String", # The time at which the activity was initially published.
+    "id": "A String", # The ID for the activity.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/pagespeedonline.v1.pagespeedapi.html b/docs/dyn/pagespeedonline.v1.pagespeedapi.html index 2202a6c..8c85adf 100644 --- a/docs/dyn/pagespeedonline.v1.pagespeedapi.html +++ b/docs/dyn/pagespeedonline.v1.pagespeedapi.html @@ -23,7 +23,45 @@ Args:
    Allowed values
      desktop - Fetch and analyze the URL for desktop browsers
      mobile - Fetch and analyze the URL for mobile devices
-  url: string, The URL to fetch and analyze (required) +  url: string, The URL to fetch and analyze (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "pagespeedonline#result", # Kind of result.
+    "formattedResults": { # Localized Page Speed results. Contains a ruleResults entry for each Page Speed rule instantiated and run by the server.
+      "locale": "A String", # The locale of the formattedResults, e.g. "en_US".
+      "ruleResults": { # Dictionary of formatted rule results, with one entry for each Page Speed rule instantiated and run by the server.
+      },
+    },
+    "title": "A String", # Title of the page, as displayed in the browser's title bar.
+    "version": { # The version of the Page Speed SDK used to generate these results.
+      "major": 42, # The major version number of the Page Speed SDK used to generate these results.
+      "minor": 42, # The minor version number of the Page Speed SDK used to generate these results.
+    },
+    "score": 42, # The Page Speed Score (0-100), which indicates how much faster a page could be. A high score indicates little room for improvement, while a lower score indicates more room for improvement.
+    "responseCode": 42, # Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error.
+    "invalidRules": [ # List of rules that were specified in the request, but which the server did not know how to instantiate.
+      "A String",
+    ],
+    "pageStats": { # Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc.
+      "otherResponseBytes": "A String", # Number of response bytes for other resources on the page.
+      "flashResponseBytes": "A String", # Number of response bytes for flash resources on the page.
+      "totalRequestBytes": "A String", # Total size of all request bytes sent by the page.
+      "numberCssResources": 42, # Number of CSS resources referenced by the page.
+      "numberResources": 42, # Number of HTTP resources loaded by the page.
+      "cssResponseBytes": "A String", # Number of uncompressed response bytes for CSS resources on the page.
+      "javascriptResponseBytes": "A String", # Number of uncompressed response bytes for JS resources on the page.
+      "imageResponseBytes": "A String", # Number of response bytes for image resources on the page.
+      "numberHosts": 42, # Number of unique hosts referenced by the page.
+      "numberStaticResources": 42, # Number of static (i.e. cacheable) resources on the page.
+      "htmlResponseBytes": "A String", # Number of uncompressed response bytes for the main HTML document and all iframes on the page.
+      "numberJsResources": 42, # Number of JavaScript resources referenced by the page.
+      "textResponseBytes": "A String", # Number of uncompressed response bytes for text resources not covered by other statistics (i.e non-HTML, non-script, non-CSS resources) on the page.
+    },
+    "id": "A String", # Canonicalized and final URL for the document, after following page redirects (if any).
+  }
Data descriptors defined here:
diff --git a/docs/dyn/plus.v1.activities.html b/docs/dyn/plus.v1.activities.html index 8aa998e..0ab738d 100644 --- a/docs/dyn/plus.v1.activities.html +++ b/docs/dyn/plus.v1.activities.html @@ -20,7 +20,114 @@ Args:
  activityId: string, The ID of the activity to get. (required)
  alt: string, Specifies an alternative representation type.
    Allowed values
-      json - Use JSON format +      json - Use JSON format
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "placeName": "A String", # Name of the place where this activity occurred.
+    "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
+    "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
+    "provider": { # The service provider that initially published this activity.
+      "title": "A String", # Name of the service provider.
+    },
+    "title": "A String", # Title of this activity.
+    "url": "A String", # The link to this activity.
+    "object": { # The object of this activity.
+      "resharers": { # People who reshared this activity.
+        "totalItems": 42, # Total number of people who reshared this activity.
+        "selfLink": "A String", # The URL for the collection of resharers.
+      },
+      "attachments": [ # The media objects attached to this activity.
+        {
+          "displayName": "A String", # The title of the attachment (such as a photo caption or an article title).
+          "fullImage": { # The full image url for photo attachments.
+            "url": "A String", # URL of the link.
+            "width": 42, # The width, in pixels, of the linked resource.
+            "type": "A String", # Media type of the link.
+            "height": 42, # The height, in pixels, of the linked resource.
+          },
+          "url": "A String", # The link to the attachment, should be of type text/html.
+          "image": { # The preview image for photos or videos.
+            "url": "A String", # URL of the link.
+            "width": 42, # The width, in pixels, of the linked resource.
+            "type": "A String", # Media type of the link.
+            "height": 42, # The height, in pixels, of the linked resource.
+          },
+          "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article.
+          "embed": { # If the attachment is a video, the embeddable link.
+            "url": "A String", # URL of the link.
+            "type": "A String", # Media type of the link.
+          },
+          "id": "A String", # The ID of the media object's resource.
+          "objectType": "A String", # The type of media object. Possible values are:
+              # - "photo" - A photo.
+              # - "video" - A video.
+              # - "article" - An article, specified by a link.
+        },
+      ],
+      "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits.
+      "plusoners": { # People who +1'd this activity.
+        "totalItems": 42, # Total number of people who +1'd this activity.
+        "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
+      },
+      "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor.
+        "url": "A String", # A link to the original actor's Google profile.
+        "image": { # The image representation of the original actor.
+          "url": "A String", # A URL that points to a thumbnail photo of the original actor.
+        },
+        "displayName": "A String", # The original actor's name, suitable for display.
+        "id": "A String", # ID of the original actor.
+      },
+      "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property.
+      "url": "A String", # The URL that points to the linked resource.
+      "replies": { # Comments in reply to this activity.
+        "totalItems": 42, # Total number of comments on this activity.
+        "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
+      },
+      "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared.
+      "objectType": "A String", # The type of the object. Possible values are:
+          # - "note" - Textual content.
+          # - "activity" - A Google+ activity.
+    },
+    "placeId": "A String", # ID of the place where this activity occurred.
+    "actor": { # The person who performed this activity.
+      "url": "A String", # The link to the actor's Google profile.
+      "image": { # The image representation of the actor.
+        "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+      },
+      "displayName": "A String", # The name of the actor, suitable for display.
+      "id": "A String", # The ID of the actor's person resource.
+    },
+    "id": "A String", # The ID of this activity.
+    "access": { # Identifies who has access to see this activity.
+      "items": [ # The list of access entries.
+        {
+          "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
+              # - "person" - Access to an individual.
+              # - "circle" - Access to members of a circle.
+              # - "myCircles" - Access to members of all the person's circles.
+              # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
+              # - "public" - Access to anyone on the web.
+          "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
+        },
+      ],
+      "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
+      "description": "A String", # Description of the access granted, suitable for display.
+    },
+    "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
+        # - "post" - Publish content to the stream.
+        # - "checkin" - Check in to a location.
+        # - "share" - Reshare an activity.
+    "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
+    "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
+    "address": "A String", # Street address where this activity occurred.
+    "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
+    "placeholder": True or False, # True if this activity is a placeholder.
+    "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
+    "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
+  }
list = method(self, **kwargs)
List all of the activities in the specified collection for a particular user.
 
@@ -33,7 +140,125 @@ Args:
      public - All public activities created by the specified user.
  alt: string, Specifies an alternative representation type.
    Allowed values
-      json - Use JSON format
+      json - Use JSON format
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+    "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
+    "title": "A String", # The title of this collection of activities.
+    "items": [ # The activities in this page of results.
+      {
+        "placeName": "A String", # Name of the place where this activity occurred.
+        "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
+        "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
+        "provider": { # The service provider that initially published this activity.
+          "title": "A String", # Name of the service provider.
+        },
+        "title": "A String", # Title of this activity.
+        "url": "A String", # The link to this activity.
+        "object": { # The object of this activity.
+          "resharers": { # People who reshared this activity.
+            "totalItems": 42, # Total number of people who reshared this activity.
+            "selfLink": "A String", # The URL for the collection of resharers.
+          },
+          "attachments": [ # The media objects attached to this activity.
+            {
+              "displayName": "A String", # The title of the attachment (such as a photo caption or an article title).
+              "fullImage": { # The full image url for photo attachments.
+                "url": "A String", # URL of the link.
+                "width": 42, # The width, in pixels, of the linked resource.
+                "type": "A String", # Media type of the link.
+                "height": 42, # The height, in pixels, of the linked resource.
+              },
+              "url": "A String", # The link to the attachment, should be of type text/html.
+              "image": { # The preview image for photos or videos.
+                "url": "A String", # URL of the link.
+                "width": 42, # The width, in pixels, of the linked resource.
+                "type": "A String", # Media type of the link.
+                "height": 42, # The height, in pixels, of the linked resource.
+              },
+              "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article.
+              "embed": { # If the attachment is a video, the embeddable link.
+                "url": "A String", # URL of the link.
+                "type": "A String", # Media type of the link.
+              },
+              "id": "A String", # The ID of the media object's resource.
+              "objectType": "A String", # The type of media object. Possible values are:
+                  # - "photo" - A photo.
+                  # - "video" - A video.
+                  # - "article" - An article, specified by a link.
+            },
+          ],
+          "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits.
+          "plusoners": { # People who +1'd this activity.
+            "totalItems": 42, # Total number of people who +1'd this activity.
+            "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
+          },
+          "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor.
+            "url": "A String", # A link to the original actor's Google profile.
+            "image": { # The image representation of the original actor.
+              "url": "A String", # A URL that points to a thumbnail photo of the original actor.
+            },
+            "displayName": "A String", # The original actor's name, suitable for display.
+            "id": "A String", # ID of the original actor.
+          },
+          "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property.
+          "url": "A String", # The URL that points to the linked resource.
+          "replies": { # Comments in reply to this activity.
+            "totalItems": 42, # Total number of comments on this activity.
+            "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
+          },
+          "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared.
+          "objectType": "A String", # The type of the object. Possible values are:
+              # - "note" - Textual content.
+              # - "activity" - A Google+ activity.
+        },
+        "placeId": "A String", # ID of the place where this activity occurred.
+        "actor": { # The person who performed this activity.
+          "url": "A String", # The link to the actor's Google profile.
+          "image": { # The image representation of the actor.
+            "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+          },
+          "displayName": "A String", # The name of the actor, suitable for display.
+          "id": "A String", # The ID of the actor's person resource.
+        },
+        "id": "A String", # The ID of this activity.
+        "access": { # Identifies who has access to see this activity.
+          "items": [ # The list of access entries.
+            {
+              "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
+                  # - "person" - Access to an individual.
+                  # - "circle" - Access to members of a circle.
+                  # - "myCircles" - Access to members of all the person's circles.
+                  # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
+                  # - "public" - Access to anyone on the web.
+              "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
+            },
+          ],
+          "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
+          "description": "A String", # Description of the access granted, suitable for display.
+        },
+        "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
+            # - "post" - Publish content to the stream.
+            # - "checkin" - Check in to a location.
+            # - "share" - Reshare an activity.
+        "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
+        "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
+        "address": "A String", # Street address where this activity occurred.
+        "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
+        "placeholder": True or False, # True if this activity is a placeholder.
+        "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
+        "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
+      },
+    ],
+    "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
+    "nextLink": "A String", # Link to the next page of activities.
+    "id": "A String", # The ID of this collection of activities.
+    "selfLink": "A String", # Link to this activity resource.
+  }
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
@@ -52,10 +277,128 @@ Args:
    Allowed values
      best - Sort activities by relevance to the user, most relevant first.
      recent - Sort activities by published date, most recent first.
-  language: string, Specify the preferred language to search with. See Language Codes for available values.
+  language: string, Specify the preferred language to search with. See search language codes for available values.
  pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.
  maxResults: integer, The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
-  query: string, Full-text search query string. (required)
+  query: string, Full-text search query string. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+    "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
+    "title": "A String", # The title of this collection of activities.
+    "items": [ # The activities in this page of results.
+      {
+        "placeName": "A String", # Name of the place where this activity occurred.
+        "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
+        "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
+        "provider": { # The service provider that initially published this activity.
+          "title": "A String", # Name of the service provider.
+        },
+        "title": "A String", # Title of this activity.
+        "url": "A String", # The link to this activity.
+        "object": { # The object of this activity.
+          "resharers": { # People who reshared this activity.
+            "totalItems": 42, # Total number of people who reshared this activity.
+            "selfLink": "A String", # The URL for the collection of resharers.
+          },
+          "attachments": [ # The media objects attached to this activity.
+            {
+              "displayName": "A String", # The title of the attachment (such as a photo caption or an article title).
+              "fullImage": { # The full image url for photo attachments.
+                "url": "A String", # URL of the link.
+                "width": 42, # The width, in pixels, of the linked resource.
+                "type": "A String", # Media type of the link.
+                "height": 42, # The height, in pixels, of the linked resource.
+              },
+              "url": "A String", # The link to the attachment, should be of type text/html.
+              "image": { # The preview image for photos or videos.
+                "url": "A String", # URL of the link.
+                "width": 42, # The width, in pixels, of the linked resource.
+                "type": "A String", # Media type of the link.
+                "height": 42, # The height, in pixels, of the linked resource.
+              },
+              "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article.
+              "embed": { # If the attachment is a video, the embeddable link.
+                "url": "A String", # URL of the link.
+                "type": "A String", # Media type of the link.
+              },
+              "id": "A String", # The ID of the media object's resource.
+              "objectType": "A String", # The type of media object. Possible values are:
+                  # - "photo" - A photo.
+                  # - "video" - A video.
+                  # - "article" - An article, specified by a link.
+            },
+          ],
+          "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits.
+          "plusoners": { # People who +1'd this activity.
+            "totalItems": 42, # Total number of people who +1'd this activity.
+            "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
+          },
+          "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor.
+            "url": "A String", # A link to the original actor's Google profile.
+            "image": { # The image representation of the original actor.
+              "url": "A String", # A URL that points to a thumbnail photo of the original actor.
+            },
+            "displayName": "A String", # The original actor's name, suitable for display.
+            "id": "A String", # ID of the original actor.
+          },
+          "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property.
+          "url": "A String", # The URL that points to the linked resource.
+          "replies": { # Comments in reply to this activity.
+            "totalItems": 42, # Total number of comments on this activity.
+            "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
+          },
+          "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared.
+          "objectType": "A String", # The type of the object. Possible values are:
+              # - "note" - Textual content.
+              # - "activity" - A Google+ activity.
+        },
+        "placeId": "A String", # ID of the place where this activity occurred.
+        "actor": { # The person who performed this activity.
+          "url": "A String", # The link to the actor's Google profile.
+          "image": { # The image representation of the actor.
+            "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+          },
+          "displayName": "A String", # The name of the actor, suitable for display.
+          "id": "A String", # The ID of the actor's person resource.
+        },
+        "id": "A String", # The ID of this activity.
+        "access": { # Identifies who has access to see this activity.
+          "items": [ # The list of access entries.
+            {
+              "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
+                  # - "person" - Access to an individual.
+                  # - "circle" - Access to members of a circle.
+                  # - "myCircles" - Access to members of all the person's circles.
+                  # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
+                  # - "public" - Access to anyone on the web.
+              "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
+            },
+          ],
+          "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
+          "description": "A String", # Description of the access granted, suitable for display.
+        },
+        "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
+            # - "post" - Publish content to the stream.
+            # - "checkin" - Check in to a location.
+            # - "share" - Reshare an activity.
+        "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
+        "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
+        "address": "A String", # Street address where this activity occurred.
+        "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
+        "placeholder": True or False, # True if this activity is a placeholder.
+        "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
+        "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
+      },
+    ],
+    "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
+    "nextLink": "A String", # Link to the next page of activities.
+    "id": "A String", # The ID of this collection of activities.
+    "selfLink": "A String", # Link to this activity resource.
+  }
search_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
diff --git a/docs/dyn/plus.v1.comments.html b/docs/dyn/plus.v1.comments.html index 8031423..8142bea 100644 --- a/docs/dyn/plus.v1.comments.html +++ b/docs/dyn/plus.v1.comments.html @@ -17,7 +17,39 @@
get = method(self, **kwargs)
Get a comment.
 
Args:
-  commentId: string, The ID of the comment to get. (required)
+  commentId: string, The ID of the comment to get. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "inReplyTo": [ # The activity this comment replied to.
+      {
+        "url": "A String", # The url of the activity.
+        "id": "A String", # The id of the activity.
+      },
+    ],
+    "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
+    "object": { # The object of this comment.
+      "content": "A String", # The content of this comment.
+      "objectType": "comment", # The object type of this comment. Possible values are:
+          # - "comment" - A comment in reply to an activity.
+    },
+    "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
+    "actor": { # The person who posted this comment.
+      "url": "A String", # A link to the person resource for this actor.
+      "image": { # The image representation of this actor.
+        "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+      },
+      "displayName": "A String", # The name of this actor, suitable for display.
+      "id": "A String", # The ID of the actor.
+    },
+    "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
+        # - "post" - Publish content to the stream.
+    "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
+    "id": "A String", # The ID of this comment.
+    "selfLink": "A String", # Link to this comment resource.
+  }
list = method(self, **kwargs)
List all of the comments for an activity.
 
@@ -27,7 +59,49 @@ Args:
  activityId: string, The ID of the activity to get comments for. (required)
  alt: string, Specifies an alternative representation type.
    Allowed values
-      json - Use JSON format
+      json - Use JSON format
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+    "kind": "plus#commentFeed", # Identifies this resource as a collection of comments. Value: "plus#commentFeed".
+    "title": "A String", # The title of this collection of comments.
+    "items": [ # The comments in this page of results.
+      {
+        "inReplyTo": [ # The activity this comment replied to.
+          {
+            "url": "A String", # The url of the activity.
+            "id": "A String", # The id of the activity.
+          },
+        ],
+        "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
+        "object": { # The object of this comment.
+          "content": "A String", # The content of this comment.
+          "objectType": "comment", # The object type of this comment. Possible values are:
+              # - "comment" - A comment in reply to an activity.
+        },
+        "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
+        "actor": { # The person who posted this comment.
+          "url": "A String", # A link to the person resource for this actor.
+          "image": { # The image representation of this actor.
+            "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+          },
+          "displayName": "A String", # The name of this actor, suitable for display.
+          "id": "A String", # The ID of the actor.
+        },
+        "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
+            # - "post" - Publish content to the stream.
+        "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
+        "id": "A String", # The ID of this comment.
+        "selfLink": "A String", # Link to this comment resource.
+      },
+    ],
+    "updated": "A String", # The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp.
+    "nextLink": "A String", # Link to the next page of activities.
+    "id": "A String", # The ID of this collection of comments.
+  }
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
diff --git a/docs/dyn/plus.v1.people.html b/docs/dyn/plus.v1.people.html index 1c0d759..5604757 100644 --- a/docs/dyn/plus.v1.people.html +++ b/docs/dyn/plus.v1.people.html @@ -17,7 +17,97 @@
get = method(self, **kwargs)
Get a person's profile.
 
Args:
-  userId: string, The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. (required)
+  userId: string, The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "relationshipStatus": "A String", # The person's relationship status. Possible values are:
+        # - "single" - Person is single.
+        # - "in_a_relationship" - Person is in a relationship.
+        # - "engaged" - Person is engaged.
+        # - "married" - Person is married.
+        # - "its_complicated" - The relationship is complicated.
+        # - "open_relationship" - Person is in an open relationship.
+        # - "widowed" - Person is widowed.
+        # - "in_domestic_partnership" - Person is in a domestic partnership.
+        # - "in_civil_union" - Person is in a civil union.
+    "organizations": [ # A list of current or past organizations with which this person is associated.
+      {
+        "startDate": "A String", # The date the person joined this organization.
+        "endDate": "A String", # The date the person left this organization.
+        "description": "A String", # A short description of the person's role in this organization.
+        "title": "A String", # The person's job title or role within the organization.
+        "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
+        "location": "A String", # The location of this organization.
+        "department": "A String", # The department within the organization.
+        "type": "A String", # The type of organization. Possible values are:
+            # - "work" - Work.
+            # - "school" - School.
+        "name": "A String", # The name of the organization.
+      },
+    ],
+    "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
+    "displayName": "A String", # The name of this person, suitable for display.
+    "name": { # An object representation of the individual components of a person's name.
+      "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
+      "middleName": "A String", # The middle name of this person.
+      "familyName": "A String", # The family name (last name) of this person.
+      "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
+      "givenName": "A String", # The given name (first name) of this person.
+      "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
+    },
+    "url": "A String", # The URL of this person's profile.
+    "gender": "A String", # The person's gender. Possible values are:
+        # - "male" - Male gender.
+        # - "female" - Female gender.
+        # - "other" - Other.
+    "aboutMe": "A String", # A short biography for this person.
+    "tagline": "A String", # The brief description (tagline) of this person.
+    "placesLived": [ # A list of places where this person has lived.
+      {
+        "primary": True or False, # If "true", this place of residence is this person's primary residence.
+        "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
+      },
+    ],
+    "emails": [ # A list of email addresses for this person.
+      {
+        "type": "A String", # The type of address. Possible values are:
+            # - "home" - Home email address.
+            # - "work" - Work email address.
+            # - "other" - Other.
+        "primary": True or False, # If "true", indicates this email address is the person's primary one.
+        "value": "A String", # The email address.
+      },
+    ],
+    "nickname": "A String", # The nickname of this person.
+    "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+    "urls": [ # A list of URLs for this person.
+      {
+        "type": "A String", # The type of URL. Possible values are:
+            # - "home" - URL for home.
+            # - "work" - URL for work.
+            # - "blog" - URL for blog.
+            # - "profile" - URL for profile.
+            # - "other" - Other.
+        "primary": True or False, # If "true", this URL is the person's primary URL.
+        "value": "A String", # The URL value.
+      },
+    ],
+    "image": { # The representation of the person's profile photo.
+      "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+    },
+    "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
+    "id": "A String", # The ID of this person.
+    "languagesSpoken": [ # The languages spoken by this person.
+      "A String",
+    ],
+    "currentLocation": "A String", # The current location for this person.
+    "objectType": "A String", # Type of person within Google+. Possible values are:
+        # - "person" - represents an actual person.
+        # - "page" - represents a page.
+  }
listByActivity = method(self, **kwargs)
List all of the people in the specified collection for a particular activity.
 
@@ -28,7 +118,105 @@ Args:
  collection: string, The collection of people to list. (required)
    Allowed values
      plusoners - List all people who have +1'd this activity.
-      resharers - List all people who have reshared this activity.
+      resharers - List all people who have reshared this activity.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+    "items": [ # The people in this page of results. Each item will include the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
+      {
+        "relationshipStatus": "A String", # The person's relationship status. Possible values are:
+            # - "single" - Person is single.
+            # - "in_a_relationship" - Person is in a relationship.
+            # - "engaged" - Person is engaged.
+            # - "married" - Person is married.
+            # - "its_complicated" - The relationship is complicated.
+            # - "open_relationship" - Person is in an open relationship.
+            # - "widowed" - Person is widowed.
+            # - "in_domestic_partnership" - Person is in a domestic partnership.
+            # - "in_civil_union" - Person is in a civil union.
+        "organizations": [ # A list of current or past organizations with which this person is associated.
+          {
+            "startDate": "A String", # The date the person joined this organization.
+            "endDate": "A String", # The date the person left this organization.
+            "description": "A String", # A short description of the person's role in this organization.
+            "title": "A String", # The person's job title or role within the organization.
+            "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
+            "location": "A String", # The location of this organization.
+            "department": "A String", # The department within the organization.
+            "type": "A String", # The type of organization. Possible values are:
+                # - "work" - Work.
+                # - "school" - School.
+            "name": "A String", # The name of the organization.
+          },
+        ],
+        "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
+        "displayName": "A String", # The name of this person, suitable for display.
+        "name": { # An object representation of the individual components of a person's name.
+          "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
+          "middleName": "A String", # The middle name of this person.
+          "familyName": "A String", # The family name (last name) of this person.
+          "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
+          "givenName": "A String", # The given name (first name) of this person.
+          "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
+        },
+        "url": "A String", # The URL of this person's profile.
+        "gender": "A String", # The person's gender. Possible values are:
+            # - "male" - Male gender.
+            # - "female" - Female gender.
+            # - "other" - Other.
+        "aboutMe": "A String", # A short biography for this person.
+        "tagline": "A String", # The brief description (tagline) of this person.
+        "placesLived": [ # A list of places where this person has lived.
+          {
+            "primary": True or False, # If "true", this place of residence is this person's primary residence.
+            "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
+          },
+        ],
+        "emails": [ # A list of email addresses for this person.
+          {
+            "type": "A String", # The type of address. Possible values are:
+                # - "home" - Home email address.
+                # - "work" - Work email address.
+                # - "other" - Other.
+            "primary": True or False, # If "true", indicates this email address is the person's primary one.
+            "value": "A String", # The email address.
+          },
+        ],
+        "nickname": "A String", # The nickname of this person.
+        "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+        "urls": [ # A list of URLs for this person.
+          {
+            "type": "A String", # The type of URL. Possible values are:
+                # - "home" - URL for home.
+                # - "work" - URL for work.
+                # - "blog" - URL for blog.
+                # - "profile" - URL for profile.
+                # - "other" - Other.
+            "primary": True or False, # If "true", this URL is the person's primary URL.
+            "value": "A String", # The URL value.
+          },
+        ],
+        "image": { # The representation of the person's profile photo.
+          "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+        },
+        "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
+        "id": "A String", # The ID of this person.
+        "languagesSpoken": [ # The languages spoken by this person.
+          "A String",
+        ],
+        "currentLocation": "A String", # The current location for this person.
+        "objectType": "A String", # Type of person within Google+. Possible values are:
+            # - "person" - represents an actual person.
+            # - "page" - represents a page.
+      },
+    ],
+    "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+    "selfLink": "A String", # Link to this resource.
+    "title": "A String", # The title of this collection of people.
+  }
listByActivity_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
@@ -43,10 +231,108 @@ Returns:
search = method(self, **kwargs)
Search all public profiles.
 
Args:
-  language: string, Specify the preferred language to search with. See Language Codes for available values.
+  language: string, Specify the preferred language to search with. See search language codes for available values.
  pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.
  maxResults: integer, The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
-  query: string, Full-text search query string. (required)
+  query: string, Full-text search query string. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+    "items": [ # The people in this page of results. Each item will include the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
+      {
+        "relationshipStatus": "A String", # The person's relationship status. Possible values are:
+            # - "single" - Person is single.
+            # - "in_a_relationship" - Person is in a relationship.
+            # - "engaged" - Person is engaged.
+            # - "married" - Person is married.
+            # - "its_complicated" - The relationship is complicated.
+            # - "open_relationship" - Person is in an open relationship.
+            # - "widowed" - Person is widowed.
+            # - "in_domestic_partnership" - Person is in a domestic partnership.
+            # - "in_civil_union" - Person is in a civil union.
+        "organizations": [ # A list of current or past organizations with which this person is associated.
+          {
+            "startDate": "A String", # The date the person joined this organization.
+            "endDate": "A String", # The date the person left this organization.
+            "description": "A String", # A short description of the person's role in this organization.
+            "title": "A String", # The person's job title or role within the organization.
+            "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
+            "location": "A String", # The location of this organization.
+            "department": "A String", # The department within the organization.
+            "type": "A String", # The type of organization. Possible values are:
+                # - "work" - Work.
+                # - "school" - School.
+            "name": "A String", # The name of the organization.
+          },
+        ],
+        "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
+        "displayName": "A String", # The name of this person, suitable for display.
+        "name": { # An object representation of the individual components of a person's name.
+          "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
+          "middleName": "A String", # The middle name of this person.
+          "familyName": "A String", # The family name (last name) of this person.
+          "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
+          "givenName": "A String", # The given name (first name) of this person.
+          "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
+        },
+        "url": "A String", # The URL of this person's profile.
+        "gender": "A String", # The person's gender. Possible values are:
+            # - "male" - Male gender.
+            # - "female" - Female gender.
+            # - "other" - Other.
+        "aboutMe": "A String", # A short biography for this person.
+        "tagline": "A String", # The brief description (tagline) of this person.
+        "placesLived": [ # A list of places where this person has lived.
+          {
+            "primary": True or False, # If "true", this place of residence is this person's primary residence.
+            "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
+          },
+        ],
+        "emails": [ # A list of email addresses for this person.
+          {
+            "type": "A String", # The type of address. Possible values are:
+                # - "home" - Home email address.
+                # - "work" - Work email address.
+                # - "other" - Other.
+            "primary": True or False, # If "true", indicates this email address is the person's primary one.
+            "value": "A String", # The email address.
+          },
+        ],
+        "nickname": "A String", # The nickname of this person.
+        "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+        "urls": [ # A list of URLs for this person.
+          {
+            "type": "A String", # The type of URL. Possible values are:
+                # - "home" - URL for home.
+                # - "work" - URL for work.
+                # - "blog" - URL for blog.
+                # - "profile" - URL for profile.
+                # - "other" - Other.
+            "primary": True or False, # If "true", this URL is the person's primary URL.
+            "value": "A String", # The URL value.
+          },
+        ],
+        "image": { # The representation of the person's profile photo.
+          "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+        },
+        "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
+        "id": "A String", # The ID of this person.
+        "languagesSpoken": [ # The languages spoken by this person.
+          "A String",
+        ],
+        "currentLocation": "A String", # The current location for this person.
+        "objectType": "A String", # Type of person within Google+. Possible values are:
+            # - "person" - represents an actual person.
+            # - "page" - represents a page.
+      },
+    ],
+    "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+    "selfLink": "A String", # Link to this resource.
+    "title": "A String", # The title of this collection of people.
+  }
search_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
diff --git a/docs/dyn/prediction.v1.4.hostedmodels.html b/docs/dyn/prediction.v1.4.hostedmodels.html index bb4b2b4..00ad814 100644 --- a/docs/dyn/prediction.v1.4.hostedmodels.html +++ b/docs/dyn/prediction.v1.4.hostedmodels.html @@ -18,7 +18,34 @@  
Args:
  body: object, The request body. (required)
-  hostedModelName: string, The name of a hosted model. (required)
+    The object takes the form of:
+ 
+{
+    "input": { # Input to the model for a prediction
+      "csvInstance": [ # A list of input features, these can be strings or doubles.
+        "",
+      ],
+    },
+  }
+ 
+  hostedModelName: string, The name of a hosted model. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "prediction#output", # What kind of resource this is.
+    "outputLabel": "A String", # The most likely class label [Categorical models only].
+    "id": "A String", # The unique name for the predictive model.
+    "outputMulti": [ # A list of class labels with their estimated probabilities [Categorical models only].
+      {
+        "score": 3.140000, # The probability of the class label.
+        "label": "A String", # The class label.
+      },
+    ],
+    "outputValue": 3.140000, # The estimated regression value [Regression models only].
+    "selfLink": "A String", # A URL to re-request this resource.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/prediction.v1.4.trainedmodels.html b/docs/dyn/prediction.v1.4.trainedmodels.html index 77a55a0..3043289 100644 --- a/docs/dyn/prediction.v1.4.trainedmodels.html +++ b/docs/dyn/prediction.v1.4.trainedmodels.html @@ -22,24 +22,191 @@ Args:
get = method(self, **kwargs)
Check training status of your model.
 
Args:
-  id: string, The unique name for the predictive model. (required)
+  id: string, The unique name for the predictive model. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "prediction#training", # What kind of resource this is.
+      "storageDataLocation": "A String", # Google storage location of the training data file.
+      "dataAnalysis": { # Data Analysis.
+        "warnings": [
+          "A String",
+        ],
+      },
+      "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+      "modelInfo": { # Model metadata.
+        "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+        },
+        "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+        "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label [Categorical models only].
+        },
+        "meanSquaredError": 3.140000, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+        "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+        "numberInstances": "A String", # Number of valid data instances used in the trained model.
+        "classWeightedAccuracy": 3.140000, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+        "classificationAccuracy": 3.140000, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+      },
+      "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+      "id": "A String", # The unique name for the predictive model.
+      "selfLink": "A String", # A URL to re-request this resource.
+      "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+        { # Class label (string).
+        },
+      ],
+    }
insert = method(self, **kwargs)
Begin training your model.
 
Args:
-  body: object, The request body. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "kind": "prediction#training", # What kind of resource this is.
+    "storageDataLocation": "A String", # Google storage location of the training data file.
+    "dataAnalysis": { # Data Analysis.
+      "warnings": [
+        "A String",
+      ],
+    },
+    "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+    "modelInfo": { # Model metadata.
+      "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+      },
+      "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+      "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label [Categorical models only].
+      },
+      "meanSquaredError": 3.140000, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+      "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+      "numberInstances": "A String", # Number of valid data instances used in the trained model.
+      "classWeightedAccuracy": 3.140000, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+      "classificationAccuracy": 3.140000, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+    },
+    "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+    "id": "A String", # The unique name for the predictive model.
+    "selfLink": "A String", # A URL to re-request this resource.
+    "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+      { # Class label (string).
+      },
+    ],
+  }
+ 
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "prediction#training", # What kind of resource this is.
+      "storageDataLocation": "A String", # Google storage location of the training data file.
+      "dataAnalysis": { # Data Analysis.
+        "warnings": [
+          "A String",
+        ],
+      },
+      "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+      "modelInfo": { # Model metadata.
+        "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+        },
+        "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+        "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label [Categorical models only].
+        },
+        "meanSquaredError": 3.140000, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+        "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+        "numberInstances": "A String", # Number of valid data instances used in the trained model.
+        "classWeightedAccuracy": 3.140000, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+        "classificationAccuracy": 3.140000, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+      },
+      "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+      "id": "A String", # The unique name for the predictive model.
+      "selfLink": "A String", # A URL to re-request this resource.
+      "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+        { # Class label (string).
+        },
+      ],
+    }
predict = method(self, **kwargs)
Submit model id and request a prediction
 
Args:
  body: object, The request body. (required)
-  id: string, The unique name for the predictive model. (required)
+    The object takes the form of:
+ 
+{
+    "input": { # Input to the model for a prediction
+      "csvInstance": [ # A list of input features, these can be strings or doubles.
+        "",
+      ],
+    },
+  }
+ 
+  id: string, The unique name for the predictive model. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "prediction#output", # What kind of resource this is.
+    "outputLabel": "A String", # The most likely class label [Categorical models only].
+    "id": "A String", # The unique name for the predictive model.
+    "outputMulti": [ # A list of class labels with their estimated probabilities [Categorical models only].
+      {
+        "score": 3.140000, # The probability of the class label.
+        "label": "A String", # The class label.
+      },
+    ],
+    "outputValue": 3.140000, # The estimated regression value [Regression models only].
+    "selfLink": "A String", # A URL to re-request this resource.
+  }
update = method(self, **kwargs)
Add new data to a trained model.
 
Args:
  body: object, The request body. (required)
-  id: string, A parameter (required)
+    The object takes the form of:
+ 
+{
+    "csvInstance": [ # The input features for this instance
+      "",
+    ],
+    "label": "A String", # The true class label of this instance
+  }
+ 
+  id: string, The unique name for the predictive model. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "prediction#training", # What kind of resource this is.
+      "storageDataLocation": "A String", # Google storage location of the training data file.
+      "dataAnalysis": { # Data Analysis.
+        "warnings": [
+          "A String",
+        ],
+      },
+      "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
+      "modelInfo": { # Model metadata.
+        "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
+        },
+        "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
+        "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label [Categorical models only].
+        },
+        "meanSquaredError": 3.140000, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
+        "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
+        "numberInstances": "A String", # Number of valid data instances used in the trained model.
+        "classWeightedAccuracy": 3.140000, # Estimated accuracy of model taking utility weights into account [Categorical models only].
+        "classificationAccuracy": 3.140000, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
+      },
+      "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
+      "id": "A String", # The unique name for the predictive model.
+      "selfLink": "A String", # A URL to re-request this resource.
+      "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
+        { # Class label (string).
+        },
+      ],
+    }
Data descriptors defined here:
diff --git a/docs/dyn/shopping.v1.products.html b/docs/dyn/shopping.v1.products.html index fd874fb..57c3755 100644 --- a/docs/dyn/shopping.v1.products.html +++ b/docs/dyn/shopping.v1.products.html @@ -36,7 +36,190 @@ Args:
  categories_useGcsConfig: boolean, This parameter is currently ignored
  thumbnails: string, Thumbnail specification
  categories_include: string, Category specification
-  plusOne: string, +1 rendering specification. +  plusOne: string, +1 rendering specification.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "selfLink": "A String", # Self link of product.
+    "kind": "shopping#product", # The kind of item, always shopping#product.
+    "product": { # Product.
+      "queryMatched": True or False, # Whether this product matched the user query. Only set for the variant offers (if any) attached to a product offer.
+      "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
+      "images": [ # Images of product.
+        {
+          "link": "A String", # Link to product image.
+          "thumbnails": [ # Thumbnails of product image.
+            {
+              "content": "A String", # Content of thumbnail (only available for the first thumbnail of the top results if SAYT is enabled).
+              "width": 42, # Width of thumbnail (omitted if not specified in the request).
+              "link": "A String", # Link to thumbnail.
+              "height": 42, # Height of thumbnail (omitted if not specified in the request).
+            },
+          ],
+        },
+      ],
+      "inventories": [ # Inventories of product.
+        {
+          "distance": 3.140000, # Distance of product inventory.
+          "price": 3.140000, # Price of product inventory.
+          "storeId": "A String", # Store ID of product inventory.
+          "tax": 3.140000, # Tax of product inventory.
+          "shipping": 3.140000, # Shipping cost of product inventory.
+          "currency": "A String", # Currency of product inventory (an ISO 4217 alphabetic code).
+          "distanceUnit": "A String", # Distance unit of product inventory.
+          "availability": "A String", # Availability of product inventory.
+          "channel": "A String", # Channel of product inventory (one of: online, local).
+        },
+      ],
+      "author": { # Author of product.
+        "aggregatorId": "A String", # Aggregator id of product author.
+        "uri": "A String", # URI of product author.
+        "email": "A String", # Email address of product author.
+        "name": "A String", # Name of product author.
+        "accountId": "A String", # Account id of product author.
+      },
+      "condition": "A String", # Condition of product (one of: new, refurbished, used).
+      "providedId": "A String", # Merchant-provided id of product (available only with a cx source).
+      "description": "A String", # Description of product.
+      "gtins": [ # List of all the product's GTINs (in GTIN-14 format).
+        "A String",
+      ],
+      "brand": "A String", # Brand of product.
+      "modificationTime": "A String", # RFC 3339 formatted modification time and date of product.
+      "link": "A String", # Link to product.
+      "totalMatchingVariants": 42, # The number of variant offers returned that matched the query.
+      "variants": [ # A list of variant offers associated with this product.
+        {
+          "variant": # Object with schema name: ShoppingModelProductJsonV1 # The detailed offer data for a particular variant offer.
+        },
+      ],
+      "categories": [ # Categories of product according to the selected taxonomy, omitted if no taxonomy is selected.
+        "A String",
+      ],
+      "language": "A String", # BCP 47 language tag of language of product.
+      "country": "A String", # ISO 3166 code of target country of product.
+      "title": "A String", # Title of product.
+      "creationTime": "A String", # RFC 3339 formatted creation time and date of product.
+      "attributes": [ # Attributes of product (available only with a cx source).
+        {
+          "type": "A String", # Type of product attribute (one of: text, bool, int, float, dateRange, url).
+          "value": "", # Value of product attribute.
+          "displayName": "A String", # Display Name of prodct attribute.
+          "name": "A String", # Name of product attribute.
+          "unit": "A String", # Unit of product attribute.
+        },
+      ],
+      "plusOne": "A String", # Code to add to the page to render the +1 content.
+      "googleId": "A String", # Google id of product.
+    },
+    "requestId": "A String", # Unique identifier for this request.
+    "recommendations": [ # Recommendations for product.
+      {
+        "recommendationList": [ # List of recommendations.
+          {
+            "product": { # Recommended product.
+              "queryMatched": True or False, # Whether this product matched the user query. Only set for the variant offers (if any) attached to a product offer.
+              "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
+              "images": [ # Images of product.
+                {
+                  "link": "A String", # Link to product image.
+                  "thumbnails": [ # Thumbnails of product image.
+                    {
+                      "content": "A String", # Content of thumbnail (only available for the first thumbnail of the top results if SAYT is enabled).
+                      "width": 42, # Width of thumbnail (omitted if not specified in the request).
+                      "link": "A String", # Link to thumbnail.
+                      "height": 42, # Height of thumbnail (omitted if not specified in the request).
+                    },
+                  ],
+                },
+              ],
+              "inventories": [ # Inventories of product.
+                {
+                  "distance": 3.140000, # Distance of product inventory.
+                  "price": 3.140000, # Price of product inventory.
+                  "storeId": "A String", # Store ID of product inventory.
+                  "tax": 3.140000, # Tax of product inventory.
+                  "shipping": 3.140000, # Shipping cost of product inventory.
+                  "currency": "A String", # Currency of product inventory (an ISO 4217 alphabetic code).
+                  "distanceUnit": "A String", # Distance unit of product inventory.
+                  "availability": "A String", # Availability of product inventory.
+                  "channel": "A String", # Channel of product inventory (one of: online, local).
+                },
+              ],
+              "author": { # Author of product.
+                "aggregatorId": "A String", # Aggregator id of product author.
+                "uri": "A String", # URI of product author.
+                "email": "A String", # Email address of product author.
+                "name": "A String", # Name of product author.
+                "accountId": "A String", # Account id of product author.
+              },
+              "condition": "A String", # Condition of product (one of: new, refurbished, used).
+              "providedId": "A String", # Merchant-provided id of product (available only with a cx source).
+              "description": "A String", # Description of product.
+              "gtins": [ # List of all the product's GTINs (in GTIN-14 format).
+                "A String",
+              ],
+              "brand": "A String", # Brand of product.
+              "modificationTime": "A String", # RFC 3339 formatted modification time and date of product.
+              "link": "A String", # Link to product.
+              "totalMatchingVariants": 42, # The number of variant offers returned that matched the query.
+              "variants": [ # A list of variant offers associated with this product.
+                {
+                  "variant": # Object with schema name: ShoppingModelProductJsonV1 # The detailed offer data for a particular variant offer.
+                },
+              ],
+              "categories": [ # Categories of product according to the selected taxonomy, omitted if no taxonomy is selected.
+                "A String",
+              ],
+              "language": "A String", # BCP 47 language tag of language of product.
+              "country": "A String", # ISO 3166 code of target country of product.
+              "title": "A String", # Title of product.
+              "creationTime": "A String", # RFC 3339 formatted creation time and date of product.
+              "attributes": [ # Attributes of product (available only with a cx source).
+                {
+                  "type": "A String", # Type of product attribute (one of: text, bool, int, float, dateRange, url).
+                  "value": "", # Value of product attribute.
+                  "displayName": "A String", # Display Name of prodct attribute.
+                  "name": "A String", # Name of product attribute.
+                  "unit": "A String", # Unit of product attribute.
+                },
+              ],
+              "plusOne": "A String", # Code to add to the page to render the +1 content.
+              "googleId": "A String", # Google id of product.
+            },
+          },
+        ],
+        "type": "A String", # Type of recommendation list (one of: all, purchaseToPurchase, visitToVisit, visitToPurchase).
+      },
+    ],
+    "debug": { # Google internal.
+      "searchResponse": "A String", # Google internal.
+      "searchRequest": "A String", # Google internal.
+      "rdcResponse": "A String", # Google internal.
+      "backendTimes": [ # Google internal
+        {
+          "serverMillis": "A String", # Google internal
+          "hostName": "A String", # Google internal
+          "name": "A String", # Google internal
+          "elapsedMillis": "A String", # Google internal
+        },
+      ],
+      "elapsedMillis": "A String", # Google internal.
+    },
+    "id": "A String", # Id of product.
+    "categories": [ # List of categories for product.
+      {
+        "url": "A String", # URL of category.
+        "shortName": "A String", # Short name of category.
+        "parents": [ # Ids of the parents of the category.
+          "A String",
+        ],
+        "id": "A String", # Id of category.
+      },
+    ],
+  }
list = method(self, **kwargs)
Returns a list of products and content modules
 
@@ -92,7 +275,429 @@ Args:
  relatedQueries_useGcsConfig: boolean, This parameter is currently ignored
  promotions_useGcsConfig: boolean, Whether to return promotion information as configured in the GCS account
  plusOne: string, +1 rendering specification.
-  thumbnails: string, Image thumbnails specification
+  thumbnails: string, Image thumbnails specification
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "promotions": [ # List of promotions.
+      {
+        "product": { # Product of promotion (omitted if type is not product).
+          "queryMatched": True or False, # Whether this product matched the user query. Only set for the variant offers (if any) attached to a product offer.
+          "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
+          "images": [ # Images of product.
+            {
+              "link": "A String", # Link to product image.
+              "thumbnails": [ # Thumbnails of product image.
+                {
+                  "content": "A String", # Content of thumbnail (only available for the first thumbnail of the top results if SAYT is enabled).
+                  "width": 42, # Width of thumbnail (omitted if not specified in the request).
+                  "link": "A String", # Link to thumbnail.
+                  "height": 42, # Height of thumbnail (omitted if not specified in the request).
+                },
+              ],
+            },
+          ],
+          "inventories": [ # Inventories of product.
+            {
+              "distance": 3.140000, # Distance of product inventory.
+              "price": 3.140000, # Price of product inventory.
+              "storeId": "A String", # Store ID of product inventory.
+              "tax": 3.140000, # Tax of product inventory.
+              "shipping": 3.140000, # Shipping cost of product inventory.
+              "currency": "A String", # Currency of product inventory (an ISO 4217 alphabetic code).
+              "distanceUnit": "A String", # Distance unit of product inventory.
+              "availability": "A String", # Availability of product inventory.
+              "channel": "A String", # Channel of product inventory (one of: online, local).
+            },
+          ],
+          "author": { # Author of product.
+            "aggregatorId": "A String", # Aggregator id of product author.
+            "uri": "A String", # URI of product author.
+            "email": "A String", # Email address of product author.
+            "name": "A String", # Name of product author.
+            "accountId": "A String", # Account id of product author.
+          },
+          "condition": "A String", # Condition of product (one of: new, refurbished, used).
+          "providedId": "A String", # Merchant-provided id of product (available only with a cx source).
+          "description": "A String", # Description of product.
+          "gtins": [ # List of all the product's GTINs (in GTIN-14 format).
+            "A String",
+          ],
+          "brand": "A String", # Brand of product.
+          "modificationTime": "A String", # RFC 3339 formatted modification time and date of product.
+          "link": "A String", # Link to product.
+          "totalMatchingVariants": 42, # The number of variant offers returned that matched the query.
+          "variants": [ # A list of variant offers associated with this product.
+            {
+              "variant": # Object with schema name: ShoppingModelProductJsonV1 # The detailed offer data for a particular variant offer.
+            },
+          ],
+          "categories": [ # Categories of product according to the selected taxonomy, omitted if no taxonomy is selected.
+            "A String",
+          ],
+          "language": "A String", # BCP 47 language tag of language of product.
+          "country": "A String", # ISO 3166 code of target country of product.
+          "title": "A String", # Title of product.
+          "creationTime": "A String", # RFC 3339 formatted creation time and date of product.
+          "attributes": [ # Attributes of product (available only with a cx source).
+            {
+              "type": "A String", # Type of product attribute (one of: text, bool, int, float, dateRange, url).
+              "value": "", # Value of product attribute.
+              "displayName": "A String", # Display Name of prodct attribute.
+              "name": "A String", # Name of product attribute.
+              "unit": "A String", # Unit of product attribute.
+            },
+          ],
+          "plusOne": "A String", # Code to add to the page to render the +1 content.
+          "googleId": "A String", # Google id of product.
+        },
+        "description": "A String", # Description of promotion (omitted if type is not standard).
+        "imageLink": "A String", # Link to promotion image (omitted if type is not standard).
+        "destLink": "A String", # Link to promotion (omitted if type is not standard).
+        "customHtml": "A String", # Custom HTML of promotion (omitted if type is not custom).
+        "link": "A String", # Link to promotion without scheme. DEPRECATED. WILL BE REMOVED SOON. USE destLink.
+        "customFields": [ # List of custom fields of promotion.
+          {
+            "name": "A String", # Name of field.
+            "value": "A String", # Value of field.
+          },
+        ],
+        "type": "A String", # Type of promotion (one of: standard, product, custom).
+        "name": "A String", # Name of promotion (omitted if type is not standard).
+      },
+    ],
+    "selfLink": "A String", # Self link of feed.
+    "kind": "shopping#products", # The fixed string "shopping#products". The kind of feed returned.
+    "stores": [ # List of returned stores.
+      {
+        "storeCode": "A String", # Merchant-supplied store code.
+        "name": "A String", # Name of store.
+        "storeId": "A String", # Id of store.
+        "telephone": "A String", # Telephone number of store.
+        "location": "A String", # Location of store.
+        "address": "A String", # Address of store.
+      },
+    ],
+    "currentItemCount": 42, # Current item count.
+    "items": [ # List of returned products.
+      {
+        "selfLink": "A String", # Self link of product.
+        "kind": "shopping#product", # The kind of item, always shopping#product.
+        "product": { # Product.
+          "queryMatched": True or False, # Whether this product matched the user query. Only set for the variant offers (if any) attached to a product offer.
+          "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
+          "images": [ # Images of product.
+            {
+              "link": "A String", # Link to product image.
+              "thumbnails": [ # Thumbnails of product image.
+                {
+                  "content": "A String", # Content of thumbnail (only available for the first thumbnail of the top results if SAYT is enabled).
+                  "width": 42, # Width of thumbnail (omitted if not specified in the request).
+                  "link": "A String", # Link to thumbnail.
+                  "height": 42, # Height of thumbnail (omitted if not specified in the request).
+                },
+              ],
+            },
+          ],
+          "inventories": [ # Inventories of product.
+            {
+              "distance": 3.140000, # Distance of product inventory.
+              "price": 3.140000, # Price of product inventory.
+              "storeId": "A String", # Store ID of product inventory.
+              "tax": 3.140000, # Tax of product inventory.
+              "shipping": 3.140000, # Shipping cost of product inventory.
+              "currency": "A String", # Currency of product inventory (an ISO 4217 alphabetic code).
+              "distanceUnit": "A String", # Distance unit of product inventory.
+              "availability": "A String", # Availability of product inventory.
+              "channel": "A String", # Channel of product inventory (one of: online, local).
+            },
+          ],
+          "author": { # Author of product.
+            "aggregatorId": "A String", # Aggregator id of product author.
+            "uri": "A String", # URI of product author.
+            "email": "A String", # Email address of product author.
+            "name": "A String", # Name of product author.
+            "accountId": "A String", # Account id of product author.
+          },
+          "condition": "A String", # Condition of product (one of: new, refurbished, used).
+          "providedId": "A String", # Merchant-provided id of product (available only with a cx source).
+          "description": "A String", # Description of product.
+          "gtins": [ # List of all the product's GTINs (in GTIN-14 format).
+            "A String",
+          ],
+          "brand": "A String", # Brand of product.
+          "modificationTime": "A String", # RFC 3339 formatted modification time and date of product.
+          "link": "A String", # Link to product.
+          "totalMatchingVariants": 42, # The number of variant offers returned that matched the query.
+          "variants": [ # A list of variant offers associated with this product.
+            {
+              "variant": # Object with schema name: ShoppingModelProductJsonV1 # The detailed offer data for a particular variant offer.
+            },
+          ],
+          "categories": [ # Categories of product according to the selected taxonomy, omitted if no taxonomy is selected.
+            "A String",
+          ],
+          "language": "A String", # BCP 47 language tag of language of product.
+          "country": "A String", # ISO 3166 code of target country of product.
+          "title": "A String", # Title of product.
+          "creationTime": "A String", # RFC 3339 formatted creation time and date of product.
+          "attributes": [ # Attributes of product (available only with a cx source).
+            {
+              "type": "A String", # Type of product attribute (one of: text, bool, int, float, dateRange, url).
+              "value": "", # Value of product attribute.
+              "displayName": "A String", # Display Name of prodct attribute.
+              "name": "A String", # Name of product attribute.
+              "unit": "A String", # Unit of product attribute.
+            },
+          ],
+          "plusOne": "A String", # Code to add to the page to render the +1 content.
+          "googleId": "A String", # Google id of product.
+        },
+        "requestId": "A String", # Unique identifier for this request.
+        "recommendations": [ # Recommendations for product.
+          {
+            "recommendationList": [ # List of recommendations.
+              {
+                "product": { # Recommended product.
+                  "queryMatched": True or False, # Whether this product matched the user query. Only set for the variant offers (if any) attached to a product offer.
+                  "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
+                  "images": [ # Images of product.
+                    {
+                      "link": "A String", # Link to product image.
+                      "thumbnails": [ # Thumbnails of product image.
+                        {
+                          "content": "A String", # Content of thumbnail (only available for the first thumbnail of the top results if SAYT is enabled).
+                          "width": 42, # Width of thumbnail (omitted if not specified in the request).
+                          "link": "A String", # Link to thumbnail.
+                          "height": 42, # Height of thumbnail (omitted if not specified in the request).
+                        },
+                      ],
+                    },
+                  ],
+                  "inventories": [ # Inventories of product.
+                    {
+                      "distance": 3.140000, # Distance of product inventory.
+                      "price": 3.140000, # Price of product inventory.
+                      "storeId": "A String", # Store ID of product inventory.
+                      "tax": 3.140000, # Tax of product inventory.
+                      "shipping": 3.140000, # Shipping cost of product inventory.
+                      "currency": "A String", # Currency of product inventory (an ISO 4217 alphabetic code).
+                      "distanceUnit": "A String", # Distance unit of product inventory.
+                      "availability": "A String", # Availability of product inventory.
+                      "channel": "A String", # Channel of product inventory (one of: online, local).
+                    },
+                  ],
+                  "author": { # Author of product.
+                    "aggregatorId": "A String", # Aggregator id of product author.
+                    "uri": "A String", # URI of product author.
+                    "email": "A String", # Email address of product author.
+                    "name": "A String", # Name of product author.
+                    "accountId": "A String", # Account id of product author.
+                  },
+                  "condition": "A String", # Condition of product (one of: new, refurbished, used).
+                  "providedId": "A String", # Merchant-provided id of product (available only with a cx source).
+                  "description": "A String", # Description of product.
+                  "gtins": [ # List of all the product's GTINs (in GTIN-14 format).
+                    "A String",
+                  ],
+                  "brand": "A String", # Brand of product.
+                  "modificationTime": "A String", # RFC 3339 formatted modification time and date of product.
+                  "link": "A String", # Link to product.
+                  "totalMatchingVariants": 42, # The number of variant offers returned that matched the query.
+                  "variants": [ # A list of variant offers associated with this product.
+                    {
+                      "variant": # Object with schema name: ShoppingModelProductJsonV1 # The detailed offer data for a particular variant offer.
+                    },
+                  ],
+                  "categories": [ # Categories of product according to the selected taxonomy, omitted if no taxonomy is selected.
+                    "A String",
+                  ],
+                  "language": "A String", # BCP 47 language tag of language of product.
+                  "country": "A String", # ISO 3166 code of target country of product.
+                  "title": "A String", # Title of product.
+                  "creationTime": "A String", # RFC 3339 formatted creation time and date of product.
+                  "attributes": [ # Attributes of product (available only with a cx source).
+                    {
+                      "type": "A String", # Type of product attribute (one of: text, bool, int, float, dateRange, url).
+                      "value": "", # Value of product attribute.
+                      "displayName": "A String", # Display Name of prodct attribute.
+                      "name": "A String", # Name of product attribute.
+                      "unit": "A String", # Unit of product attribute.
+                    },
+                  ],
+                  "plusOne": "A String", # Code to add to the page to render the +1 content.
+                  "googleId": "A String", # Google id of product.
+                },
+              },
+            ],
+            "type": "A String", # Type of recommendation list (one of: all, purchaseToPurchase, visitToVisit, visitToPurchase).
+          },
+        ],
+        "debug": { # Google internal.
+          "searchResponse": "A String", # Google internal.
+          "searchRequest": "A String", # Google internal.
+          "rdcResponse": "A String", # Google internal.
+          "backendTimes": [ # Google internal
+            {
+              "serverMillis": "A String", # Google internal
+              "hostName": "A String", # Google internal
+              "name": "A String", # Google internal
+              "elapsedMillis": "A String", # Google internal
+            },
+          ],
+          "elapsedMillis": "A String", # Google internal.
+        },
+        "id": "A String", # Id of product.
+        "categories": [ # List of categories for product.
+          {
+            "url": "A String", # URL of category.
+            "shortName": "A String", # Short name of category.
+            "parents": [ # Ids of the parents of the category.
+              "A String",
+            ],
+            "id": "A String", # Id of category.
+          },
+        ],
+      },
+    ],
+    "facets": [ # List of facets.
+      {
+        "count": 42, # Number of products matching the query that have a value for the facet's property or attribute.
+        "displayName": "A String", # Display name of facet.
+        "name": "A String", # Name of the facet's attribute (omitted for property facets).
+        "buckets": [ # List of Buckets within facet.
+          {
+            "count": 42, # Number of products matching the query that have a value for the facet's property or attribute that matches the bucket.
+            "minExclusive": True or False, # Whether the lower bound of the bucket is exclusive (omitted for value buckets or if the range has no lower bound).
+            "min": "", # Lower bound of the bucket (omitted for value buckets or if the range has no lower bound).
+            "max": "", # Upper bound of the bucket (omitted for value buckets or if the range has no upper bound).
+            "value": "", # Value of the bucket (omitted for range buckets).
+            "maxExclusive": True or False, # Whether the upper bound of the bucket is exclusive (omitted for value buckets or if the range has no upper bound).
+          },
+        ],
+        "property": "A String", # Property of facet (omitted for attribute facets).
+        "type": "A String", # Type of facet's attribute (omitted for property facets, one of: text, bool, int, float).
+        "unit": "A String", # Unit of the facet's property or attribute (omitted if the facet's property or attribute has no unit).
+      },
+    ],
+    "itemsPerPage": 42, # Number of items per page of results.
+    "redirects": [ # Redirects.
+      "A String",
+    ],
+    "totalItems": 42, # Total number of search results.
+    "nextLink": "A String", # Next link of feed.
+    "shelfSpaceAds": [
+      {
+        "product": {
+          "queryMatched": True or False, # Whether this product matched the user query. Only set for the variant offers (if any) attached to a product offer.
+          "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
+          "images": [ # Images of product.
+            {
+              "link": "A String", # Link to product image.
+              "thumbnails": [ # Thumbnails of product image.
+                {
+                  "content": "A String", # Content of thumbnail (only available for the first thumbnail of the top results if SAYT is enabled).
+                  "width": 42, # Width of thumbnail (omitted if not specified in the request).
+                  "link": "A String", # Link to thumbnail.
+                  "height": 42, # Height of thumbnail (omitted if not specified in the request).
+                },
+              ],
+            },
+          ],
+          "inventories": [ # Inventories of product.
+            {
+              "distance": 3.140000, # Distance of product inventory.
+              "price": 3.140000, # Price of product inventory.
+              "storeId": "A String", # Store ID of product inventory.
+              "tax": 3.140000, # Tax of product inventory.
+              "shipping": 3.140000, # Shipping cost of product inventory.
+              "currency": "A String", # Currency of product inventory (an ISO 4217 alphabetic code).
+              "distanceUnit": "A String", # Distance unit of product inventory.
+              "availability": "A String", # Availability of product inventory.
+              "channel": "A String", # Channel of product inventory (one of: online, local).
+            },
+          ],
+          "author": { # Author of product.
+            "aggregatorId": "A String", # Aggregator id of product author.
+            "uri": "A String", # URI of product author.
+            "email": "A String", # Email address of product author.
+            "name": "A String", # Name of product author.
+            "accountId": "A String", # Account id of product author.
+          },
+          "condition": "A String", # Condition of product (one of: new, refurbished, used).
+          "providedId": "A String", # Merchant-provided id of product (available only with a cx source).
+          "description": "A String", # Description of product.
+          "gtins": [ # List of all the product's GTINs (in GTIN-14 format).
+            "A String",
+          ],
+          "brand": "A String", # Brand of product.
+          "modificationTime": "A String", # RFC 3339 formatted modification time and date of product.
+          "link": "A String", # Link to product.
+          "totalMatchingVariants": 42, # The number of variant offers returned that matched the query.
+          "variants": [ # A list of variant offers associated with this product.
+            {
+              "variant": # Object with schema name: ShoppingModelProductJsonV1 # The detailed offer data for a particular variant offer.
+            },
+          ],
+          "categories": [ # Categories of product according to the selected taxonomy, omitted if no taxonomy is selected.
+            "A String",
+          ],
+          "language": "A String", # BCP 47 language tag of language of product.
+          "country": "A String", # ISO 3166 code of target country of product.
+          "title": "A String", # Title of product.
+          "creationTime": "A String", # RFC 3339 formatted creation time and date of product.
+          "attributes": [ # Attributes of product (available only with a cx source).
+            {
+              "type": "A String", # Type of product attribute (one of: text, bool, int, float, dateRange, url).
+              "value": "", # Value of product attribute.
+              "displayName": "A String", # Display Name of prodct attribute.
+              "name": "A String", # Name of product attribute.
+              "unit": "A String", # Unit of product attribute.
+            },
+          ],
+          "plusOne": "A String", # Code to add to the page to render the +1 content.
+          "googleId": "A String", # Google id of product.
+        },
+      },
+    ],
+    "startIndex": 42, # 1-based index of the first item in the search results.
+    "etag": "A String", # Etag of feed.
+    "requestId": "A String", # Unique identifier for this request.
+    "relatedQueries": [ # Related queries.
+      "A String",
+    ],
+    "debug": { # Google internal.
+      "searchResponse": "A String", # Google internal.
+      "searchRequest": "A String", # Google internal.
+      "rdcResponse": "A String", # Google internal.
+      "backendTimes": [ # Google internal
+        {
+          "serverMillis": "A String", # Google internal
+          "hostName": "A String", # Google internal
+          "name": "A String", # Google internal
+          "elapsedMillis": "A String", # Google internal
+        },
+      ],
+      "elapsedMillis": "A String", # Google internal.
+    },
+    "spelling": { # Spelling.
+      "suggestion": "A String", # Suggestion for spelling.
+    },
+    "previousLink": "A String", # Previous link of feed.
+    "id": "tag:google.com,2010:shopping/products", # Id of feed.
+    "categories": [ # List of categories.
+      {
+        "url": "A String", # URL of category.
+        "shortName": "A String", # Short name of category.
+        "parents": [ # Ids of the parents of the category.
+          "A String",
+        ],
+        "id": "A String", # Id of category.
+      },
+    ],
+  }
Data descriptors defined here:
diff --git a/docs/dyn/siteVerification.v1.webResource.html b/docs/dyn/siteVerification.v1.webResource.html index 7944dc2..1f702be 100644 --- a/docs/dyn/siteVerification.v1.webResource.html +++ b/docs/dyn/siteVerification.v1.webResource.html @@ -22,36 +22,157 @@ Args:
get = method(self, **kwargs)
Get the most current data for a website or domain.
 
Args:
-  id: string, The id of a verified site or domain. (required)
+  id: string, The id of a verified site or domain. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "owners": [ # The email addresses of all verified owners.
+        "A String",
+      ],
+      "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
+      "site": { # The address and type of a site that is verified or will be verified.
+        "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
+        "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
+      },
+    }
getToken = method(self, **kwargs)
Get a verification token for placing on a website or domain.
 
Args:
  verificationMethod: string, The method to use for verifying a site or domain.
  identifier: string, The URL or domain to verify.
-  type: string, Type of resource to verify. Can be 'site' (URL) or 'inet_domain' (domain name).
+  type: string, Type of resource to verify. Can be 'site' (URL) or 'inet_domain' (domain name).
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "token": "A String", # The verification token. The token must be placed appropriately in order for verification to succeed.
+    "method": "A String", # The verification method to use in conjunction with this token. For FILE, the token should be placed in the top-level directory of the site, stored inside a file of the same name. For META, the token should be placed in the HEAD tag of the default page that is loaded for the site. For DNS, the token should be placed in a TXT record of the domain.
+  }
insert = method(self, **kwargs)
Attempt verification of a website or domain.
 
Args:
  body: object, The request body. (required)
-  verificationMethod: string, The method to use for verifying a site or domain. (required)
+    The object takes the form of:
+ 
+{
+    "owners": [ # The email addresses of all verified owners.
+      "A String",
+    ],
+    "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
+    "site": { # The address and type of a site that is verified or will be verified.
+      "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
+      "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
+    },
+  }
+ 
+  verificationMethod: string, The method to use for verifying a site or domain. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "owners": [ # The email addresses of all verified owners.
+        "A String",
+      ],
+      "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
+      "site": { # The address and type of a site that is verified or will be verified.
+        "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
+        "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
+      },
+    }
list = method(self, **kwargs)
Get the list of your verified websites and domains.
 
-Args:
+Args:
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # The list of sites that are owned by the authenticated user.
+      {
+          "owners": [ # The email addresses of all verified owners.
+            "A String",
+          ],
+          "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
+          "site": { # The address and type of a site that is verified or will be verified.
+            "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
+            "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
+          },
+        },
+    ],
+  }
patch = method(self, **kwargs)
Modify the list of owners for your website or domain. This method supports patch semantics.
 
Args:
  body: object, The request body. (required)
-  id: string, The id of a verified site or domain. (required)
+    The object takes the form of:
+ 
+{
+    "owners": [ # The email addresses of all verified owners.
+      "A String",
+    ],
+    "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
+    "site": { # The address and type of a site that is verified or will be verified.
+      "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
+      "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
+    },
+  }
+ 
+  id: string, The id of a verified site or domain. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "owners": [ # The email addresses of all verified owners.
+        "A String",
+      ],
+      "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
+      "site": { # The address and type of a site that is verified or will be verified.
+        "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
+        "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
+      },
+    }
update = method(self, **kwargs)
Modify the list of owners for your website or domain.
 
Args:
  body: object, The request body. (required)
-  id: string, The id of a verified site or domain. (required)
+    The object takes the form of:
+ 
+{
+    "owners": [ # The email addresses of all verified owners.
+      "A String",
+    ],
+    "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
+    "site": { # The address and type of a site that is verified or will be verified.
+      "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
+      "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
+    },
+  }
+ 
+  id: string, The id of a verified site or domain. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "owners": [ # The email addresses of all verified owners.
+        "A String",
+      ],
+      "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
+      "site": { # The address and type of a site that is verified or will be verified.
+        "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
+        "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
+      },
+    }
Data descriptors defined here:
diff --git a/docs/dyn/taskqueue.v1beta1.taskqueues.html b/docs/dyn/taskqueue.v1beta1.taskqueues.html index 4b40bc1..acedcd7 100644 --- a/docs/dyn/taskqueue.v1beta1.taskqueues.html +++ b/docs/dyn/taskqueue.v1beta1.taskqueues.html @@ -19,7 +19,33 @@ Args:
  taskqueue: string, The id of the taskqueue to get the properties of. (required)
  project: string, The project under which the queue lies. (required)
-  getStats: boolean, Whether to get stats. Optional. +  getStats: boolean, Whether to get stats. Optional.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "taskqueues#taskqueue", # The kind of REST object returned, in this case taskqueue.
+    "stats": { # Statistics for the TaskQueue object in question.
+      "oldestTask": "A String", # The timestamp (in seconds since the epoch) of the oldest unfinished task.
+      "leasedLastMinute": "A String", # Number of tasks leased in the last minute.
+      "totalTasks": 42, # Number of tasks in the queue.
+      "leasedLastHour": "A String", # Number of tasks leased in the last hour.
+    },
+    "id": "A String", # Name of the taskqueue.
+    "maxLeases": 42, # The number of times we should lease out tasks before giving up on them. If unset we lease them out forever until a worker deletes the task.
+    "acl": { # ACLs that are applicable to this TaskQueue object.
+      "consumerEmails": [ # Email addresses of users who can "consume" tasks from the TaskQueue. This means they can Dequeue and Delete tasks from the queue.
+        "A String",
+      ],
+      "producerEmails": [ # Email addresses of users who can "produce" tasks into the TaskQueue. This means they can Insert tasks into the queue.
+        "A String",
+      ],
+      "adminEmails": [ # Email addresses of users who are "admins" of the TaskQueue. This means they can control the queue, eg set ACLs for the queue.
+        "A String",
+      ],
+    },
+  }
Data descriptors defined here:
diff --git a/docs/dyn/taskqueue.v1beta1.tasks.html b/docs/dyn/taskqueue.v1beta1.tasks.html index fcd7a8b..3aea7f4 100644 --- a/docs/dyn/taskqueue.v1beta1.tasks.html +++ b/docs/dyn/taskqueue.v1beta1.tasks.html @@ -26,7 +26,19 @@ Args:
Args:
  task: string, The task to get properties of. (required)
  taskqueue: string, The taskqueue in which the task belongs. (required)
-  project: string, The project under which the queue lies. (required) +  project: string, The project under which the queue lies. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
+    "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
+    "id": "A String", # Name of the task.
+    "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
+    "queueName": "A String", # Name of the queue that the task is in.
+    "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
+  }
lease = method(self, **kwargs)
Lease 1 or more tasks from a TaskQueue.
 
@@ -35,13 +47,47 @@ Args:
  leaseSecs: integer, The lease in seconds. (required)
  taskqueue: string, The taskqueue to lease a task from. (required)
  project: string, The project under which the queue lies. (required)
-  numTasks: integer, The number of tasks to lease. (required)
+  numTasks: integer, The number of tasks to lease. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # The actual list of tasks returned as a result of the lease operation.
+      {
+        "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
+        "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
+        "id": "A String", # Name of the task.
+        "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
+        "queueName": "A String", # Name of the queue that the task is in.
+        "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
+      },
+    ],
+    "kind": "taskqueue#tasks", # The kind of object returned, a list of tasks.
+  }
list = method(self, **kwargs)
List Tasks in a TaskQueue
 
Args:
  taskqueue: string, The id of the taskqueue to list tasks from. (required)
-  project: string, The project under which the queue lies. (required)
+  project: string, The project under which the queue lies. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # The actual list of tasks currently active in the TaskQueue.
+      {
+        "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
+        "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
+        "id": "A String", # Name of the task.
+        "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
+        "queueName": "A String", # Name of the queue that the task is in.
+        "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
+      },
+    ],
+    "kind": "taskqueues#tasks", # The kind of object returned, a list of tasks.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/tasks.v1.tasklists.html b/docs/dyn/tasks.v1.tasklists.html index bd170a0..fdb92a6 100644 --- a/docs/dyn/tasks.v1.tasklists.html +++ b/docs/dyn/tasks.v1.tasklists.html @@ -22,18 +22,68 @@ Args:
get = method(self, **kwargs)
Returns the authenticated user's specified task list.
 
Args:
-  tasklist: string, Task list identifier. (required)
+  tasklist: string, Task list identifier. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+      "etag": "A String", # ETag of the resource.
+      "id": "A String", # Task list identifier.
+      "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+      "title": "A String", # Title of the task list.
+    }
insert = method(self, **kwargs)
Creates a new task list and adds it to the authenticated user's task lists.
 
Args:
-  body: object, The request body. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+    "etag": "A String", # ETag of the resource.
+    "id": "A String", # Task list identifier.
+    "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+    "title": "A String", # Title of the task list.
+  }
+ 
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+      "etag": "A String", # ETag of the resource.
+      "id": "A String", # Task list identifier.
+      "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+      "title": "A String", # Title of the task list.
+    }
list = method(self, **kwargs)
Returns all the authenticated user's task lists.
 
Args:
  pageToken: string, Token specifying the result page to return. Optional.
-  maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.
+  maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # Token that can be used to request the next page of this result.
+    "items": [ # Collection of task lists.
+      {
+          "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+          "etag": "A String", # ETag of the resource.
+          "id": "A String", # Task list identifier.
+          "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+          "title": "A String", # Title of the task list.
+        },
+    ],
+    "kind": "tasks#taskLists", # Type of the resource. This is always "tasks#taskLists".
+    "etag": "A String", # ETag of the resource.
+  }
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
@@ -49,13 +99,55 @@ Returns:
 
Args:
  body: object, The request body. (required)
-  tasklist: string, Task list identifier. (required)
+    The object takes the form of:
+ 
+{
+    "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+    "etag": "A String", # ETag of the resource.
+    "id": "A String", # Task list identifier.
+    "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+    "title": "A String", # Title of the task list.
+  }
+ 
+  tasklist: string, Task list identifier. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+      "etag": "A String", # ETag of the resource.
+      "id": "A String", # Task list identifier.
+      "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+      "title": "A String", # Title of the task list.
+    }
update = method(self, **kwargs)
Updates the authenticated user's specified task list.
 
Args:
  body: object, The request body. (required)
-  tasklist: string, Task list identifier. (required)
+    The object takes the form of:
+ 
+{
+    "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+    "etag": "A String", # ETag of the resource.
+    "id": "A String", # Task list identifier.
+    "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+    "title": "A String", # Title of the task list.
+  }
+ 
+  tasklist: string, Task list identifier. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
+      "etag": "A String", # ETag of the resource.
+      "id": "A String", # Task list identifier.
+      "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
+      "title": "A String", # Title of the task list.
+    }
Data descriptors defined here:
diff --git a/docs/dyn/tasks.v1.tasks.html b/docs/dyn/tasks.v1.tasks.html index 4ff1912..b8a46e4 100644 --- a/docs/dyn/tasks.v1.tasks.html +++ b/docs/dyn/tasks.v1.tasks.html @@ -30,15 +30,95 @@ Args:
 
Args:
  tasklist: string, Task list identifier. (required)
-  task: string, Task identifier. (required) +  task: string, Task identifier. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "status": "A String", # Status of the task. This is either "needsAction" or "completed".
+      "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
+      "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
+      "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+      "links": [ # Collection of links. This collection is read-only.
+        {
+          "type": "A String", # Type of the link, e.g. "email".
+          "link": "A String", # The URL.
+          "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
+        },
+      ],
+      "title": "A String", # Title of the task.
+      "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
+      "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
+      "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
+      "etag": "A String", # ETag of the resource.
+      "notes": "A String", # Notes describing the task. Optional.
+      "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
+      "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
+      "id": "A String", # Task identifier.
+      "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
+    }
insert = method(self, **kwargs)
Creates a new task on the specified task list.
 
Args:
  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "status": "A String", # Status of the task. This is either "needsAction" or "completed".
+    "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
+    "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
+    "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+    "links": [ # Collection of links. This collection is read-only.
+      {
+        "type": "A String", # Type of the link, e.g. "email".
+        "link": "A String", # The URL.
+        "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
+      },
+    ],
+    "title": "A String", # Title of the task.
+    "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
+    "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
+    "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
+    "etag": "A String", # ETag of the resource.
+    "notes": "A String", # Notes describing the task. Optional.
+    "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
+    "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
+    "id": "A String", # Task identifier.
+    "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
+  }
+ 
  tasklist: string, Task list identifier. (required)
  parent: string, Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional.
-  previous: string, Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.
+  previous: string, Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "status": "A String", # Status of the task. This is either "needsAction" or "completed".
+      "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
+      "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
+      "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+      "links": [ # Collection of links. This collection is read-only.
+        {
+          "type": "A String", # Type of the link, e.g. "email".
+          "link": "A String", # The URL.
+          "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
+        },
+      ],
+      "title": "A String", # Title of the task.
+      "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
+      "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
+      "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
+      "etag": "A String", # ETag of the resource.
+      "notes": "A String", # Notes describing the task. Optional.
+      "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
+      "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
+      "id": "A String", # Task identifier.
+      "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
+    }
list = method(self, **kwargs)
Returns all tasks in the specified task list.
 
@@ -53,7 +133,41 @@ Args:
  completedMax: string, Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.
  showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.
  showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True.
-  dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
+  dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # Token used to access the next page of this result.
+    "items": [ # Collection of tasks.
+      {
+          "status": "A String", # Status of the task. This is either "needsAction" or "completed".
+          "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
+          "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
+          "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+          "links": [ # Collection of links. This collection is read-only.
+            {
+              "type": "A String", # Type of the link, e.g. "email".
+              "link": "A String", # The URL.
+              "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
+            },
+          ],
+          "title": "A String", # Title of the task.
+          "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
+          "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
+          "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
+          "etag": "A String", # ETag of the resource.
+          "notes": "A String", # Notes describing the task. Optional.
+          "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
+          "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
+          "id": "A String", # Task identifier.
+          "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
+        },
+    ],
+    "kind": "tasks#tasks", # Type of the resource. This is always "tasks#tasks".
+    "etag": "A String", # ETag of the resource.
+  }
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
@@ -72,21 +186,154 @@ Args:
  tasklist: string, Task list identifier. (required)
  parent: string, New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional.
  task: string, Task identifier. (required)
-  previous: string, New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.
+  previous: string, New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "status": "A String", # Status of the task. This is either "needsAction" or "completed".
+      "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
+      "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
+      "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+      "links": [ # Collection of links. This collection is read-only.
+        {
+          "type": "A String", # Type of the link, e.g. "email".
+          "link": "A String", # The URL.
+          "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
+        },
+      ],
+      "title": "A String", # Title of the task.
+      "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
+      "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
+      "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
+      "etag": "A String", # ETag of the resource.
+      "notes": "A String", # Notes describing the task. Optional.
+      "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
+      "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
+      "id": "A String", # Task identifier.
+      "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
+    }
patch = method(self, **kwargs)
Updates the specified task. This method supports patch semantics.
 
Args:
  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "status": "A String", # Status of the task. This is either "needsAction" or "completed".
+    "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
+    "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
+    "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+    "links": [ # Collection of links. This collection is read-only.
+      {
+        "type": "A String", # Type of the link, e.g. "email".
+        "link": "A String", # The URL.
+        "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
+      },
+    ],
+    "title": "A String", # Title of the task.
+    "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
+    "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
+    "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
+    "etag": "A String", # ETag of the resource.
+    "notes": "A String", # Notes describing the task. Optional.
+    "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
+    "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
+    "id": "A String", # Task identifier.
+    "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
+  }
+ 
  tasklist: string, Task list identifier. (required)
-  task: string, Task identifier. (required)
+  task: string, Task identifier. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "status": "A String", # Status of the task. This is either "needsAction" or "completed".
+      "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
+      "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
+      "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+      "links": [ # Collection of links. This collection is read-only.
+        {
+          "type": "A String", # Type of the link, e.g. "email".
+          "link": "A String", # The URL.
+          "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
+        },
+      ],
+      "title": "A String", # Title of the task.
+      "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
+      "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
+      "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
+      "etag": "A String", # ETag of the resource.
+      "notes": "A String", # Notes describing the task. Optional.
+      "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
+      "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
+      "id": "A String", # Task identifier.
+      "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
+    }
update = method(self, **kwargs)
Updates the specified task.
 
Args:
  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "status": "A String", # Status of the task. This is either "needsAction" or "completed".
+    "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
+    "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
+    "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+    "links": [ # Collection of links. This collection is read-only.
+      {
+        "type": "A String", # Type of the link, e.g. "email".
+        "link": "A String", # The URL.
+        "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
+      },
+    ],
+    "title": "A String", # Title of the task.
+    "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
+    "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
+    "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
+    "etag": "A String", # ETag of the resource.
+    "notes": "A String", # Notes describing the task. Optional.
+    "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
+    "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
+    "id": "A String", # Task identifier.
+    "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
+  }
+ 
  tasklist: string, Task list identifier. (required)
-  task: string, Task identifier. (required)
+  task: string, Task identifier. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "status": "A String", # Status of the task. This is either "needsAction" or "completed".
+      "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
+      "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
+      "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
+      "links": [ # Collection of links. This collection is read-only.
+        {
+          "type": "A String", # Type of the link, e.g. "email".
+          "link": "A String", # The URL.
+          "description": "A String", # The description. In HTML speak: Everything between <a> and </a>.
+        },
+      ],
+      "title": "A String", # Title of the task.
+      "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
+      "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
+      "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
+      "etag": "A String", # ETag of the resource.
+      "notes": "A String", # Notes describing the task. Optional.
+      "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
+      "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
+      "id": "A String", # Task identifier.
+      "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
+    }
Data descriptors defined here:
diff --git a/docs/dyn/translate.v2.detections.html b/docs/dyn/translate.v2.detections.html index 59f5f59..cbaca56 100644 --- a/docs/dyn/translate.v2.detections.html +++ b/docs/dyn/translate.v2.detections.html @@ -17,7 +17,22 @@
list = method(self, **kwargs)
Detect the language of text.
 
Args:
-  q: string, The text to detect (required) (repeated)
+  q: string, The text to detect (required) (repeated)
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "detections": [ # A detections contains detection results of several text
+      [ # An array of languages which we detect for the given text The most likely language list first.
+        {
+          "isReliable": True or False, # A boolean to indicate is the language detection result reliable.
+          "confidence": 3.140000, # The confidence of the detection resul of this language.
+          "language": "A String", # The language we detect
+        },
+      ],
+    ],
+  }
Data descriptors defined here:
diff --git a/docs/dyn/translate.v2.languages.html b/docs/dyn/translate.v2.languages.html index 3ecb5cd..4178c45 100644 --- a/docs/dyn/translate.v2.languages.html +++ b/docs/dyn/translate.v2.languages.html @@ -17,7 +17,19 @@
list = method(self, **kwargs)
List the source/target languages supported by the API
 
Args:
-  target: string, the language and collation in which the localized results should be returned
+  target: string, the language and collation in which the localized results should be returned
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "languages": [ # List of source/target languages supported by the translation API. If target parameter is unspecified, the list is sorted by the ASCII code point order of the language code. If target parameter is specified, the list is sorted by the collation order of the language name in the target language.
+      {
+        "name": "A String", # The localized name of the language if target parameter is given.
+        "language": "A String", # The language code.
+      },
+    ],
+  }
Data descriptors defined here:
diff --git a/docs/dyn/translate.v2.translations.html b/docs/dyn/translate.v2.translations.html index 5f3c574..8992683 100644 --- a/docs/dyn/translate.v2.translations.html +++ b/docs/dyn/translate.v2.translations.html @@ -24,7 +24,19 @@ Args:
      html - Specifies the input is in HTML
      text - Specifies the input is in plain textual format
  q: string, The text to translate (required) (repeated)
-  source: string, The source language of the text +  source: string, The source language of the text
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "translations": [ # Translations contains list of translation results of given text
+      {
+        "detectedSourceLanguage": "A String", # Detected source language if source parameter is unspecified.
+        "translatedText": "A String", # The translation.
+      },
+    ],
+  }
Data descriptors defined here:
diff --git a/docs/dyn/transparencyreport.v1.traffic.html b/docs/dyn/transparencyreport.v1.traffic.html index 984b61b..dfd017c 100644 --- a/docs/dyn/transparencyreport.v1.traffic.html +++ b/docs/dyn/transparencyreport.v1.traffic.html @@ -20,7 +20,23 @@ Args:
  begin: string, Time to begin the list of traffic after (exclusive).
  end: string, Time to end the list of traffic at (inclusive).
  region: string, Region to list traffic for.
-  product: string, Product to list traffic for. +  product: string, Product to list traffic for.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # The children on this item, uses a "loop" command to process the list.
+      {
+        "region": "A String", # Region this traffic was in.
+        "kind": "transparencyreport#traffic", # The kind of item this is.
+        "traffic": 3.140000, # Amount of this traffic.
+        "product": "A String", # Product this traffic was for.
+        "timestampSeconds": "A String", # Timestamp in seconds since the epoch (UTC).
+      },
+    ],
+    "kind": "transparencyreport#trafficFeed", # The kind of item this is.
+  }
Data descriptors defined here:
diff --git a/docs/dyn/urlshortener.v1.url.html b/docs/dyn/urlshortener.v1.url.html index 47ec765..48cbe55 100644 --- a/docs/dyn/urlshortener.v1.url.html +++ b/docs/dyn/urlshortener.v1.url.html @@ -22,12 +22,470 @@ Args:
      ANALYTICS_CLICKS - Returns only click counts.
      ANALYTICS_TOP_STRINGS - Returns only top string counts.
      FULL - Returns the creation timestamp and all available analytics.
-  shortUrl: string, The short URL, including the protocol. (required) +  shortUrl: string, The short URL, including the protocol. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "status": "A String", # Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for example.
+      "kind": "urlshortener#url", # The fixed string "urlshortener#url".
+      "created": "A String", # Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00".
+      "analytics": { # A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable.
+        "week": { # Click analytics over the last week.
+          "shortUrlClicks": "A String", # Number of clicks on this short URL.
+          "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+        },
+        "allTime": { # Click analytics over all time.
+          "shortUrlClicks": "A String", # Number of clicks on this short URL.
+          "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+        },
+        "twoHours": { # Click analytics over the last two hours.
+          "shortUrlClicks": "A String", # Number of clicks on this short URL.
+          "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+        },
+        "day": { # Click analytics over the last day.
+          "shortUrlClicks": "A String", # Number of clicks on this short URL.
+          "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+        },
+        "month": { # Click analytics over the last month.
+          "shortUrlClicks": "A String", # Number of clicks on this short URL.
+          "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+        },
+      },
+      "longUrl": "A String", # Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED".
+      "id": "A String", # Short URL, e.g. "http://goo.gl/l6MS".
+    }
insert = method(self, **kwargs)
Creates a new short URL.
 
Args:
-  body: object, The request body. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "status": "A String", # Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for example.
+    "kind": "urlshortener#url", # The fixed string "urlshortener#url".
+    "created": "A String", # Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00".
+    "analytics": { # A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable.
+      "week": { # Click analytics over the last week.
+        "shortUrlClicks": "A String", # Number of clicks on this short URL.
+        "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+      },
+      "allTime": { # Click analytics over all time.
+        "shortUrlClicks": "A String", # Number of clicks on this short URL.
+        "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+      },
+      "twoHours": { # Click analytics over the last two hours.
+        "shortUrlClicks": "A String", # Number of clicks on this short URL.
+        "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+      },
+      "day": { # Click analytics over the last day.
+        "shortUrlClicks": "A String", # Number of clicks on this short URL.
+        "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+      },
+      "month": { # Click analytics over the last month.
+        "shortUrlClicks": "A String", # Number of clicks on this short URL.
+        "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+          {
+            "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+            "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+          },
+        ],
+        "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+      },
+    },
+    "longUrl": "A String", # Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED".
+    "id": "A String", # Short URL, e.g. "http://goo.gl/l6MS".
+  }
+ 
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "status": "A String", # Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for example.
+      "kind": "urlshortener#url", # The fixed string "urlshortener#url".
+      "created": "A String", # Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00".
+      "analytics": { # A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable.
+        "week": { # Click analytics over the last week.
+          "shortUrlClicks": "A String", # Number of clicks on this short URL.
+          "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+        },
+        "allTime": { # Click analytics over all time.
+          "shortUrlClicks": "A String", # Number of clicks on this short URL.
+          "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+        },
+        "twoHours": { # Click analytics over the last two hours.
+          "shortUrlClicks": "A String", # Number of clicks on this short URL.
+          "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+        },
+        "day": { # Click analytics over the last day.
+          "shortUrlClicks": "A String", # Number of clicks on this short URL.
+          "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+        },
+        "month": { # Click analytics over the last month.
+          "shortUrlClicks": "A String", # Number of clicks on this short URL.
+          "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+            {
+              "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+              "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+            },
+          ],
+          "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+        },
+      },
+      "longUrl": "A String", # Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED".
+      "id": "A String", # Short URL, e.g. "http://goo.gl/l6MS".
+    }
list = method(self, **kwargs)
Retrieves a list of URLs shortened by a user.
 
@@ -36,7 +494,168 @@ Args:
  projection: string, Additional information to return.
    Allowed values
      ANALYTICS_CLICKS - Returns short URL click counts.
-      FULL - Returns short URL click counts.
+      FULL - Returns short URL click counts.
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # A token to provide to get the next page of results.
+    "items": [ # A list of URL resources.
+      {
+          "status": "A String", # Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for example.
+          "kind": "urlshortener#url", # The fixed string "urlshortener#url".
+          "created": "A String", # Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00".
+          "analytics": { # A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable.
+            "week": { # Click analytics over the last week.
+              "shortUrlClicks": "A String", # Number of clicks on this short URL.
+              "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+            },
+            "allTime": { # Click analytics over all time.
+              "shortUrlClicks": "A String", # Number of clicks on this short URL.
+              "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+            },
+            "twoHours": { # Click analytics over the last two hours.
+              "shortUrlClicks": "A String", # Number of clicks on this short URL.
+              "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+            },
+            "day": { # Click analytics over the last day.
+              "shortUrlClicks": "A String", # Number of clicks on this short URL.
+              "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+            },
+            "month": { # Click analytics over the last month.
+              "shortUrlClicks": "A String", # Number of clicks on this short URL.
+              "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
+                {
+                  "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
+                  "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
+                },
+              ],
+              "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
+            },
+          },
+          "longUrl": "A String", # Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED".
+          "id": "A String", # Short URL, e.g. "http://goo.gl/l6MS".
+        },
+    ],
+    "kind": "urlshortener#urlHistory", # The fixed string "urlshortener#urlHistory".
+    "itemsPerPage": 42, # Number of items returned with each full "page" of results. Note that the last page could have fewer items than the "itemsPerPage" value.
+    "totalItems": 42, # Total number of short URLs associated with this user (may be approximate).
+  }
Data descriptors defined here:
diff --git a/docs/dyn/webfonts.v1.webfonts.html b/docs/dyn/webfonts.v1.webfonts.html index ac5985f..5df6ea9 100644 --- a/docs/dyn/webfonts.v1.webfonts.html +++ b/docs/dyn/webfonts.v1.webfonts.html @@ -23,7 +23,22 @@ Args:
      date - Sort by date added
      popularity - Sort by popularity
      style - Sort by number of styles
-      trending - Sort by trending +      trending - Sort by trending
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # The list of fonts currently served by the Google Fonts API.
+      {
+        "kind": "webfonts#webfont",
+        "variants": "", # The available variants for the font.
+        "subsets": "", # The scripts supported by the font.
+        "family": "", # The name of the font.
+      },
+    ],
+    "kind": "webfonts#webfontList", # The object kind.
+  }
Data descriptors defined here:
diff --git a/docs/oauth2client.appengine.html b/docs/oauth2client.appengine.html index 1607892..2265100 100644 --- a/docs/oauth2client.appengine.html +++ b/docs/oauth2client.appengine.html @@ -8,7 +8,7 @@  
 
oauth2client.appengineindex
/usr/local/google/home/jcgregorio/projects/apiclient/oauth2client/appengine.py +>index
/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/appengine.py

Utilities for Google App Engine
 
Utilities for making it easier to use OAuth 2.0 on Google App Engine.

@@ -21,14 +21,16 @@ Utilities for making it easier to use OAuth&n        
google.appengine.api.app_identity.app_identity
base64
-google.appengine.ext.db
-		httplib2
-google.appengine.api.memcache
+oauth2client.clientsecrets
+		google.appengine.ext.db
+httplib2
+logging
+		google.appengine.api.memcache
pickle
-		simplejson
-time
+simplejson
+		time
google.appengine.api.users
-		google.appengine.ext.webapp
+google.appengine.ext.webapp

@@ -41,6 +43,17 @@ Utilities for making it easier to use OAuth&n
OAuth2Decorator +
+
+
OAuth2DecoratorFromClientSecrets +
+
+
+
+
exceptions.Exception(exceptions.BaseException) +
+
+
InvalidClientSecretsError
google.appengine.ext.db.Model(__builtin__.object) @@ -95,9 +108,7 @@ the following link:
 
This credential does not require a flow to instantiate because it represents
a two legged flow, and therefore has all of the required information to
-generate and refresh its own access tokens.
- 
-AssertionFlowCredentials objects may be safely pickled and unpickled.
 
+generate and refresh its own access tokens.
 
Methods defined here:
-
empty(self, value)
-
get_value_for_datastore(self, model_instance)
# For writing to datastore.
make_value_from_datastore(self, value)
# For reading from datastore.
@@ -585,6 +594,19 @@ the arguments to this class and what they&nbs Returns:
  Default value as provided by __init__(default). +
empty(self, value)
Determine if value is empty in the context of this property.
+ 
+For most kinds, this is equivalent to "not value", but for kinds like
+bool, the test is more subtle, so subclasses can override this method
+if necessary.
+ 
+Args:
+  value: Value to validate against this Property.
+ 
+Returns:
+  True if this value is considered empty in the context of this Property
+  type, otherwise False.
+
Data descriptors inherited from google.appengine.ext.db.Property:
__dict__
@@ -682,6 +704,66 @@ Data descriptors inherited from Data and other attributes inherited from google.appengine.ext.db.Property:
creation_counter = 1
+
 
Method resolution order:
AppAssertionCredentials
@@ -525,8 +536,6 @@ oath2client.Credentials
 

+ + + + + + + +
 
+class InvalidClientSecretsError(exceptions.Exception)
   The client_secrets.json file is malformed or missing required fields.
 
 
Method resolution order:
+
InvalidClientSecretsError
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+

@@ -699,7 +781,7 @@ Example:
  decorator = OAuth2Decorator(
      client_id='837...ent.com',
      client_secret='Qh...wwI',
-      scope='https://www.googleapis.com/auth/buzz')
+      scope='https://www.googleapis.com/auth/plus')
 
 
  class MainHandler(webapp.RequestHandler):
@@ -711,16 +793,20 @@ Example:
      # in API calls
 
  Methods defined here:
-
__init__(self, client_id, client_secret, scope, auth_uri='https://accounts.google.com/o/oauth2/auth', token_uri='https://accounts.google.com/o/oauth2/token')
Constructor for OAuth2Decorator
+
__init__(self, client_id, client_secret, scope, auth_uri='https://accounts.google.com/o/oauth2/auth', token_uri='https://accounts.google.com/o/oauth2/token', message=None)
Constructor for OAuth2Decorator
 
Args:
  client_id: string, client identifier.
  client_secret: string client secret.
-  scope: string, scope of the credentials being requested.
+  scope: string or list of strings, scope(s) of the credentials being
+    requested.
  auth_uri: string, URI for authorization endpoint. For convenience
    defaults to Google's endpoints but any OAuth 2.0 provider can be used.
  token_uri: string, URI for token endpoint. For convenience
-    defaults to Google's endpoints but any OAuth 2.0 provider can be used.
+    defaults to Google's endpoints but any OAuth 2.0 provider can be used.
+  message: Message to display if there are problems with the OAuth 2.0
+    configuration. The message may contain HTML and will be presented on the
+    web interface for any method that uses the decorator.
authorize_url(self)
Returns the URL to start the OAuth dance.
 
@@ -771,6 +857,97 @@ Data descriptors defined here:
+ + + + +
 
+class OAuth2DecoratorFromClientSecrets(OAuth2Decorator)
   An OAuth2Decorator that builds from a clientsecrets file.
+ 
+Uses a clientsecrets file as the source for all the information when
+constructing an OAuth2Decorator.
+ 
+Example:
+ 
+  decorator = OAuth2DecoratorFromClientSecrets(
+    os.path.join(os.path.dirname(__file__), 'client_secrets.json')
+    scope='https://www.googleapis.com/auth/plus')
+ 
+ 
+  class MainHandler(webapp.RequestHandler):
+ 
+    @decorator.oauth_required
+    def get(self):
+      http = decorator.http()
+      # http is authorized with the user's Credentials and can be used
+      # in API calls
 
 
Method resolution order:
+
OAuth2DecoratorFromClientSecrets
+
OAuth2Decorator
+
__builtin__.object
+
+
+Methods defined here:
+
__init__(self, filename, scope, message=None)
Constructor
+ 
+Args:
+  filename: string, File name of client secrets.
+  scope: string, Space separated list of scopes.
+  message: string, A friendly string to display to the user if the
+    clientsecrets file is missing or invalid. The message may contain HTML and
+    will be presented on the web interface for any method that uses the
+    decorator.
+ +
+Methods inherited from OAuth2Decorator:
+
authorize_url(self)
Returns the URL to start the OAuth dance.
+ 
+Must only be called from with a webapp.RequestHandler subclassed method
+that had been decorated with either @oauth_required or @oauth_aware.
+ +
has_credentials(self)
True if for the logged in user there are valid access Credentials.
+ 
+Must only be called from with a webapp.RequestHandler subclassed method
+that had been decorated with either @oauth_required or @oauth_aware.
+ +
http(self)
Returns an authorized http instance.
+ 
+Must only be called from within an @oauth_required decorated method, or
+from within an @oauth_aware decorated method where has_credentials()
+returns True.
+ +
oauth_aware(self, method)
Decorator that sets up for OAuth 2.0 dance, but doesn't do it.
+ 
+Does all the setup for the OAuth dance, but doesn't initiate it.
+This decorator is useful if you want to create a page that knows
+whether or not the user has granted access to this application.
+From within a method decorated with @oauth_aware the has_credentials()
+and authorize_url() methods can be called.
+ 
+Args:
+  method: callable, to be decorated method of a webapp.RequestHandler
+    instance.
+ +
oauth_required(self, method)
Decorator that starts the OAuth 2.0 dance.
+ 
+Starts the OAuth dance for the logged in user if they haven't already
+granted access for this application.
+ 
+Args:
+  method: callable, to be decorated method of a webapp.RequestHandler
+    instance.
+ +
+Data descriptors inherited from OAuth2Decorator:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + @@ -917,12 +1094,12 @@ Args:
  property_name: string, name of the property that is a CredentialsProperty
  cache: memcache, a write-through cache to put in front of the datastore -
get(self)
Retrieve Credential from datastore.
+
locked_get(self)
Retrieve Credential from datastore.
 
Returns:
  oauth2client.Credentials
-
put(self, credentials)
Write a Credentials to the datastore.
+
locked_put(self, credentials)
Write a Credentials to the datastore.
 
Args:
  credentials: Credentials, the credentials to store.
@@ -933,14 +1110,14 @@ Methods inherited from oauth2client.c  
This lock is not reentrant.
-
locked_get(self)
Retrieve credential.
+
get(self)
Retrieve credential.
 
-The Storage lock must be held when this is called.
+The Storage lock must *not* be held when this is called.
 
Returns:
  oauth2client.client.Credentials
-
locked_put(self, credentials)
Write a credential.
+
put(self, credentials)
Write a credential.
 
The Storage lock must be held when this is called.
 
@@ -968,6 +1145,17 @@ Data descriptors inherited from oauth
 
class OAuth2Handler(google.appengine.ext.webapp.RequestHandler)
   
       
main()
+
oauth2decorator_from_clientsecrets(filename, scope, message=None)
Creates an OAuth2Decorator populated from a clientsecrets file.
+ 
+Args:
+  filename: string, File name of client secrets.
+  scope: string, Space separated list of scopes.
+  message: string, A friendly string to display to the user if the
+    clientsecrets file is missing or invalid. The message may contain HTML and
+    will be presented on the web interface for any method that uses the
+    decorator.
+ 
+Returns: An OAuth2Decorator

diff --git a/docs/oauth2client.client.html b/docs/oauth2client.client.html index 5a0f5d6..129d65c 100644 --- a/docs/oauth2client.client.html +++ b/docs/oauth2client.client.html @@ -19,16 +19,19 @@ Tools for interacting with OAuth 2.0 protected&nbs Modules -
       
oauth2client.clientsecrets
+
base64
+oauth2client.clientsecrets
copy
-datetime
-		httplib2
+		datetime
+httplib2
logging
-django.utils.simplejson
-		sys
+		os
+simplejson
+sys
+		time
urllib
urlparse
-

+

@@ -645,7 +653,7 @@ access token.
Methods defined here:
__getstate__(self)
Trim the state down to something that can be pickled.
-
__init__(self, access_token, client_id, client_secret, refresh_token, token_expiry, token_uri, user_agent)
Create an instance of OAuth2Credentials.
+
__init__(self, access_token, client_id, client_secret, refresh_token, token_expiry, token_uri, user_agent, id_token=None)
Create an instance of OAuth2Credentials.
 
This constructor is not usually called by the user, instead
OAuth2Credentials objects are instantiated by the OAuth2WebServerFlow.
@@ -658,9 +666,10 @@ Args:
  token_expiry: datetime, when the access_token expires.
  token_uri: string, URI of token endpoint.
  user_agent: string, The HTTP User-Agent to provide for this application.
+  id_token: object, The identity of the resource owner.
 
Notes:
-  store: callable, a callable that when passed a Credential
+  store: callable, A callable that when passed a Credential
    will store the credential back to where it came from.
    This is needed to store the latest access_token if it
    has expired and been refreshed.
@@ -801,6 +810,118 @@ Data descriptors inherited from Flow
__weakref__
list of weak references to the object (if defined)
+
 
@@ -47,10 +50,15 @@ Tools for interacting with OAuth 2.0 protected&nbs
AccessTokenCredentials
AssertionCredentials +
+
+
SignedJwtAssertionCredentials
+ +
Flow
@@ -70,6 +78,7 @@ Tools for interacting with OAuth 2.0 protected&nbs
AccessTokenRefreshError
FlowExchangeError
UnknownClientSecretsFlowError +
VerifyJwtTokenError
@@ -221,7 +230,7 @@ Data descriptors inherited from Error
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -282,7 +291,7 @@ Data descriptors inherited from Error
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -506,7 +515,7 @@ Data descriptors defined here:
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -583,7 +592,7 @@ Data descriptors inherited from Error
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -631,8 +640,7 @@ Data descriptors inherited from exceptio 		Credentials object for OAuth 2.0.
 
Credentials can be applied to an httplib2.Http object using the authorize()
-method, which then signs each request from that object with the OAuth 2.0
-access token.
+method, which then adds the OAuth 2.0 access token to each request.
 
OAuth2Credentials objects may be safely pickled and unpickled.
 
 

+ + + + + + + +
 
+class SignedJwtAssertionCredentials(AssertionCredentials)
   Credentials object used for OAuth 2.0 Signed JWT assertion grants.
+ 
+This credential does not require a flow to instantiate because it
+represents a two legged flow, and therefore has all of the required
+information to generate and refresh its own access tokens.
 
 
Method resolution order:
+
SignedJwtAssertionCredentials
+
AssertionCredentials
+
OAuth2Credentials
+
Credentials
+
__builtin__.object
+
+
+Methods defined here:
+
__init__(self, service_account_name, private_key, scope, private_key_password='notasecret', user_agent=None, token_uri='https://accounts.google.com/o/oauth2/token', **kwargs)
Constructor for SignedJwtAssertionCredentials.
+ 
+Args:
+  service_account_name: string, id for account, usually an email address.
+  private_key: string, private key in P12 format.
+  scope: string or list of strings, scope(s) of the credentials being
+    requested.
+  private_key_password: string, password for private_key.
+  user_agent: string, HTTP User-Agent to provide for this application.
+  token_uri: string, URI for token endpoint. For convenience
+    defaults to Google's endpoints but any OAuth 2.0 provider can be used.
+  kwargs: kwargs, Additional parameters to add to the JWT token, for
+    example prn=joe@xample.org.
+ +
+Class methods defined here:
+
from_json(cls, s) from __builtin__.type
+ +
+Data and other attributes defined here:
+
MAX_TOKEN_LIFETIME_SECS = 3600
+ +
+Methods inherited from OAuth2Credentials:
+
__getstate__(self)
Trim the state down to something that can be pickled.
+ +
__setstate__(self, state)
Reconstitute the state of the object from being pickled.
+ +
authorize(self, http)
Authorize an httplib2.Http instance with these credentials.
+ 
+Args:
+   http: An instance of httplib2.Http
+       or something that acts like it.
+ 
+Returns:
+   A modified instance of http that was passed in.
+ 
+Example:
+ 
+  h = httplib2.Http()
+  h = credentials.authorize(h)
+ 
+You can't create a new OAuth subclass of httplib2.Authenication
+because it never gets passed the absolute URI, which is needed for
+signing. So instead we have to overload 'request' with a closure
+that adds in the Authorization header and then calls the original
+version of 'request()'.
+ +
set_store(self, store)
Set the Storage for the credential.
+ 
+Args:
+  store: Storage, an implementation of Stroage object.
+    This is needed to store the latest access_token if it
+    has expired and been refreshed.  This implementation uses
+    locking to check for updates before updating the
+    access_token.
+ +
to_json(self)
+ +
+Data descriptors inherited from OAuth2Credentials:
+
access_token_expired
+
True if the credential is expired or invalid.
+ 
+If the token_expiry isn't set, we assume the token doesn't expire.
+
+
+Class methods inherited from Credentials:
+
new_from_json(cls, s) from __builtin__.type
Utility class method to instantiate a Credentials subclass from a JSON
+representation produced by to_json().
+ 
+Args:
+  s: string, JSON from to_json().
+ 
+Returns:
+  An instance of the subclass of Credentials that was serialized with
+  to_json().
+ +
+Data descriptors inherited from Credentials:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes inherited from Credentials:
+
NON_SERIALIZED_MEMBERS = ['store']
+

@@ -883,7 +1004,7 @@ Data descriptors inherited from Error
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -913,6 +1034,67 @@ Use of negative indices is not supported.
__unicode__(...)
+
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + + + +
 
+class VerifyJwtTokenError(Error)
   Could on retrieve certificates for validation.
 
 
Method resolution order:
+
VerifyJwtTokenError
+
Error
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors inherited from Error:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+
Data descriptors inherited from exceptions.BaseException:
__dict__
@@ -948,6 +1130,21 @@ Raises:
  UnknownClientSecretsFlowError if the file describes an unknown kind of Flow.
  clientsecrets.InvalidClientSecretsError if the clientsecrets file is
    invalid.
+
verify_id_token(id_token, audience, http=None, cert_uri='https://www.googleapis.com/oauth2/v1/certs')
Verifies a signed JWT id_token.
+ 
+Args:
+  id_token: string, A Signed JWT.
+  audience: string, The audience 'aud' that the token should be for.
+  http: httplib2.Http, instance to use to make the HTTP request. Callers
+    should supply an instance that has caching enabled.
+  cert_uri: string, URI of the certificates in JSON format to
+    verify the JWT against.
+ 
+Returns:
+  The deserialized JSON in the JWT.
+ 
+Raises:
+  oauth2client.crypt.AppIdentityError if the JWT fails to verify.

@@ -955,9 +1152,12 @@ Raises:
Data -
       EXPIRY_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
+		CACHED_HTTP = <httplib2.Http object>
+EXPIRY_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
+HAS_OPENSSL = True
+ID_TOKEN_VERIFICATON_CERTS = 'https://www.googleapis.com/oauth2/v1/certs'
__author__ = 'jcgregorio@google.com (Joe Gregorio)'
-logger = <logging.Logger object>

+logger = <logging.Logger instance>

-
 
diff --git a/docs/oauth2client.clientsecrets.html b/docs/oauth2client.clientsecrets.html index c4100ce..dd26da9 100644 --- a/docs/oauth2client.clientsecrets.html +++ b/docs/oauth2client.clientsecrets.html @@ -20,7 +20,7 @@ an OAuth 2.0 protected service.

Modules
       
django.utils.simplejson
+
simplejson

@@ -63,7 +63,7 @@ Data descriptors defined here:
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -124,7 +124,7 @@ Data descriptors inherited from
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
diff --git a/docs/oauth2client.file.html b/docs/oauth2client.file.html index 6ca5460..4a5bd55 100644 --- a/docs/oauth2client.file.html +++ b/docs/oauth2client.file.html @@ -20,7 +20,7 @@ credentials.

Modules -
       
django.utils.simplejson
+
simplejson
threading

diff --git a/docs/oauth2client.html b/docs/oauth2client.html index 7b52956..7bd25d1 100644 --- a/docs/oauth2client.html +++ b/docs/oauth2client.html @@ -20,9 +20,10 @@
appengine
client
clientsecrets
-django_orm
-		file
-multistore_file
-		tools
+crypt
+		django_orm
+file
+		multistore_file
+tools
\ No newline at end of file diff --git a/docs/oauth2client.multistore_file.html b/docs/oauth2client.multistore_file.html index 468d904..215bf76 100644 --- a/docs/oauth2client.multistore_file.html +++ b/docs/oauth2client.multistore_file.html @@ -47,7 +47,7 @@ The format of the stored data is like so fcntl

logging
os
-		django.utils.simplejson
+		simplejson
threading

@@ -91,7 +91,7 @@ Data descriptors defined here:
Methods inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -152,7 +152,7 @@ Data descriptors inherited from exceptions.Exception:
-
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Data and other attributes inherited from exceptions.Exception:
@@ -217,7 +217,7 @@ Returns:
        __author__ = 'jbeda@google.com (Joe Beda)'
-logger = <logging.Logger object>

+logger = <logging.Logger instance>