From 66212035140c8f3abfb6ed14a40db27dbef4d220 Mon Sep 17 00:00:00 2001 From: Joe Gregorio Date: Thu, 14 Jun 2012 09:10:14 -0400 Subject: [PATCH] imported patch docs --- docs/apiclient.discovery.html | 56 +- docs/apiclient.errors.html | 2 +- docs/apiclient.ext.html | 21 + docs/apiclient.html | 11 +- docs/apiclient.http.html | 181 +- docs/apiclient.mimeparse.html | 2 +- docs/apiclient.model.html | 2 +- docs/apiclient.schema.html | 2 +- docs/dyn/adexchangebuyer.v1.accounts.html | 16 + docs/dyn/adexchangebuyer.v1.creatives.html | 60 + docs/dyn/adexchangebuyer.v1.directDeals.html | 8 + docs/dyn/adsense.v1.1.accounts.adclients.html | 4 + ....v1.1.accounts.adunits.customchannels.html | 4 + docs/dyn/adsense.v1.1.accounts.adunits.html | 8 + ....v1.1.accounts.customchannels.adunits.html | 4 + .../adsense.v1.1.accounts.customchannels.html | 8 + docs/dyn/adsense.v1.1.accounts.html | 8 + docs/dyn/adsense.v1.1.accounts.reports.html | 12 +- .../adsense.v1.1.accounts.urlchannels.html | 4 + docs/dyn/adsense.v1.1.adclients.html | 4 + .../adsense.v1.1.adunits.customchannels.html | 4 + docs/dyn/adsense.v1.1.adunits.html | 8 + .../adsense.v1.1.customchannels.adunits.html | 4 + docs/dyn/adsense.v1.1.customchannels.html | 8 + docs/dyn/adsense.v1.1.reports.html | 12 +- docs/dyn/adsense.v1.1.urlchannels.html | 4 + docs/dyn/analytics.v3.data.ga.html | 6 +- .../dyn/analytics.v3.management.accounts.html | 4 + docs/dyn/analytics.v3.management.goals.html | 4 + .../dyn/analytics.v3.management.profiles.html | 4 + .../dyn/analytics.v3.management.segments.html | 4 + ...analytics.v3.management.webproperties.html | 4 + docs/dyn/androidpublisher.v1.html | 28 + docs/dyn/androidpublisher.v1.purchases.html | 58 + docs/dyn/audit.v1.activities.html | 20 +- docs/dyn/bigquery.v2.datasets.html | 24 + docs/dyn/bigquery.v2.jobs.html | 108 +- docs/dyn/bigquery.v2.projects.html | 4 + docs/dyn/bigquery.v2.tabledata.html | 4 + docs/dyn/bigquery.v2.tables.html | 45 +- docs/dyn/blogger.v2.blogs.html | 4 + docs/dyn/blogger.v2.comments.html | 10 +- docs/dyn/blogger.v2.pages.html | 8 + docs/dyn/blogger.v2.posts.html | 10 +- docs/dyn/blogger.v2.users.blogs.html | 4 + docs/dyn/blogger.v2.users.html | 4 + docs/dyn/books.v1.bookshelves.html | 12 +- docs/dyn/books.v1.bookshelves.volumes.html | 79 +- docs/dyn/books.v1.html | 2 - docs/dyn/books.v1.layers.annotationData.html | 115 +- docs/dyn/books.v1.layers.html | 34 +- .../books.v1.layers.volumeAnnotations.html | 162 + docs/dyn/books.v1.myconfig.html | 87 +- docs/dyn/books.v1.mylibrary.annotations.html | 27 +- docs/dyn/books.v1.mylibrary.bookshelves.html | 36 +- ...ooks.v1.mylibrary.bookshelves.volumes.html | 80 +- .../books.v1.mylibrary.readingpositions.html | 16 +- docs/dyn/books.v1.volumes.associated.html | 195 ++ docs/dyn/books.v1.volumes.html | 201 +- docs/dyn/calendar.v3.acl.html | 26 +- docs/dyn/calendar.v3.calendarList.html | 26 +- docs/dyn/calendar.v3.calendars.html | 28 +- docs/dyn/calendar.v3.colors.html | 4 + docs/dyn/calendar.v3.events.html | 84 +- docs/dyn/calendar.v3.freebusy.html | 4 + docs/dyn/calendar.v3.settings.html | 8 + docs/dyn/customsearch.v1.cse.html | 26 +- docs/dyn/discovery.v1.apis.html | 8 + docs/dyn/drive.v1.files.html | 389 +++ docs/dyn/drive.v1.html | 28 + docs/dyn/freebase.v1.html | 10 +- docs/dyn/freebase.v1.text.html | 4 + docs/dyn/gan.v1beta1.advertisers.html | 30 +- docs/dyn/gan.v1beta1.ccOffers.html | 13 +- docs/dyn/gan.v1beta1.events.html | 22 +- docs/dyn/gan.v1beta1.html | 2 + docs/dyn/gan.v1beta1.links.html | 244 ++ docs/dyn/gan.v1beta1.publishers.html | 14 +- docs/dyn/groupssettings.v1.groups.html | 12 + docs/dyn/latitude.v1.currentLocation.html | 17 +- docs/dyn/latitude.v1.location.html | 26 +- docs/dyn/moderator.v1.featured.series.html | 4 + docs/dyn/moderator.v1.my.series.html | 4 + docs/dyn/moderator.v1.myrecent.series.html | 4 + docs/dyn/moderator.v1.profiles.html | 12 + docs/dyn/moderator.v1.responses.html | 10 +- docs/dyn/moderator.v1.series.html | 20 + docs/dyn/moderator.v1.series.responses.html | 4 + docs/dyn/moderator.v1.series.submissions.html | 4 + docs/dyn/moderator.v1.submissions.html | 8 + docs/dyn/moderator.v1.tags.html | 14 +- docs/dyn/moderator.v1.topics.html | 16 + docs/dyn/moderator.v1.topics.submissions.html | 4 + docs/dyn/moderator.v1.votes.html | 20 + docs/dyn/oauth2.v2.html | 43 +- docs/dyn/oauth2.v2.userinfo.html | 28 +- docs/dyn/oauth2.v2.userinfo.v2.me.html | 28 +- docs/dyn/orkut.v2.acl.html | 6 +- docs/dyn/orkut.v2.activities.html | 12 +- docs/dyn/orkut.v2.activityVisibility.html | 12 + docs/dyn/orkut.v2.badges.html | 8 + docs/dyn/orkut.v2.comments.html | 20 +- docs/dyn/orkut.v2.communities.html | 10 +- docs/dyn/orkut.v2.communityFollow.html | 8 + docs/dyn/orkut.v2.communityMembers.html | 20 +- docs/dyn/orkut.v2.communityMessages.html | 14 +- docs/dyn/orkut.v2.communityPollComments.html | 10 +- docs/dyn/orkut.v2.communityPollVotes.html | 4 + docs/dyn/orkut.v2.communityPolls.html | 10 +- docs/dyn/orkut.v2.communityRelated.html | 4 + docs/dyn/orkut.v2.communityTopics.html | 18 +- docs/dyn/orkut.v2.counters.html | 4 + docs/dyn/orkut.v2.scraps.html | 4 + docs/dyn/pagespeedonline.v1.pagespeedapi.html | 4 + docs/dyn/plus.v1.activities.html | 21 +- docs/dyn/plus.v1.comments.html | 11 +- docs/dyn/plus.v1.people.html | 16 +- docs/dyn/prediction.v1.5.hostedmodels.html | 4 + docs/dyn/prediction.v1.5.trainedmodels.html | 28 + docs/dyn/shopping.v1.products.html | 62 +- docs/dyn/siteVerification.v1.webResource.html | 28 + docs/dyn/taskqueue.v1beta2.html | 30 + docs/dyn/taskqueue.v1beta2.taskqueues.html | 63 + docs/dyn/taskqueue.v1beta2.tasks.html | 233 ++ docs/dyn/tasks.v1.tasklists.html | 26 +- docs/dyn/tasks.v1.tasks.html | 54 +- docs/dyn/translate.v2.detections.html | 4 + docs/dyn/translate.v2.languages.html | 4 + docs/dyn/translate.v2.translations.html | 8 +- docs/dyn/urlshortener.v1.url.html | 12 + docs/dyn/webfonts.v1.webfonts.html | 4 + docs/epy/api-objects.txt | 60 +- docs/epy/apiclient-module.html | 8 +- docs/epy/apiclient-pysrc.html | 2 +- docs/epy/apiclient.discovery-module.html | 224 +- docs/epy/apiclient.discovery-pysrc.html | 1509 ++++----- docs/epy/apiclient.errors-module.html | 2 +- docs/epy/apiclient.errors-pysrc.html | 10 +- .../apiclient.errors.BatchError-class.html | 8 +- docs/epy/apiclient.errors.Error-class.html | 56 +- .../epy/apiclient.errors.HttpError-class.html | 6 +- ...iclient.errors.InvalidJsonError-class.html | 8 +- ...ent.errors.MediaUploadSizeError-class.html | 8 +- ...ent.errors.ResumableUploadError-class.html | 8 +- ...rrors.UnacceptableMimeTypeError-class.html | 8 +- ...ient.errors.UnexpectedBodyError-class.html | 6 +- ...nt.errors.UnexpectedMethodError-class.html | 6 +- ....errors.UnknownApiNameOrVersion-class.html | 8 +- ...piclient.errors.UnknownLinkType-class.html | 8 +- docs/epy/apiclient.ext-module.html | 2 +- docs/epy/apiclient.ext-pysrc.html | 2 +- docs/epy/apiclient.http-module.html | 17 +- docs/epy/apiclient.http-pysrc.html | 2828 +++++++++-------- ...apiclient.http.BatchHttpRequest-class.html | 2 +- docs/epy/apiclient.http.HttpMock-class.html | 2 +- ...apiclient.http.HttpMockSequence-class.html | 2 +- .../epy/apiclient.http.HttpRequest-class.html | 60 +- .../apiclient.http.HttpRequestMock-class.html | 2 +- .../apiclient.http.MediaFileUpload-class.html | 164 +- ...client.http.MediaInMemoryUpload-class.html | 8 +- ...piclient.http.MediaIoBaseUpload-class.html | 577 ++++ .../epy/apiclient.http.MediaUpload-class.html | 241 +- ...client.http.MediaUploadProgress-class.html | 37 +- ...iclient.http.RequestMockBuilder-class.html | 6 +- docs/epy/apiclient.mimeparse-module.html | 2 +- docs/epy/apiclient.mimeparse-pysrc.html | 2 +- docs/epy/apiclient.model-module.html | 2 +- docs/epy/apiclient.model-pysrc.html | 2 +- docs/epy/apiclient.model.BaseModel-class.html | 12 +- docs/epy/apiclient.model.JsonModel-class.html | 6 +- docs/epy/apiclient.model.Model-class.html | 12 +- ...lient.model.ProtocolBufferModel-class.html | 6 +- docs/epy/apiclient.model.RawModel-class.html | 8 +- docs/epy/apiclient.schema-module.html | 2 +- docs/epy/apiclient.schema-pysrc.html | 2 +- docs/epy/apiclient.schema.Schemas-class.html | 6 +- ...piclient.schema._SchemaToStruct-class.html | 6 +- docs/epy/class-tree.html | 97 +- ...fields.subclassing.SubfieldBase-class.html | 66 +- ...ppengine.ext.db.PropertiedClass-class.html | 2 +- docs/epy/help.html | 2 +- docs/epy/identifier-index.html | 739 +++-- docs/epy/mimetools.Message-class.html | 2 +- docs/epy/module-tree.html | 9 +- docs/epy/oauth2client-module.html | 3 +- docs/epy/oauth2client-pysrc.html | 2 +- docs/epy/oauth2client.anyjson-module.html | 2 +- docs/epy/oauth2client.anyjson-pysrc.html | 2 +- docs/epy/oauth2client.appengine-module.html | 2 +- docs/epy/oauth2client.appengine-pysrc.html | 85 +- ...pengine.AppAssertionCredentials-class.html | 2 +- ...ient.appengine.CredentialsModel-class.html | 6 +- ...t.appengine.CredentialsProperty-class.html | 20 +- ...h2client.appengine.FlowProperty-class.html | 22 +- ...ngine.InvalidClientSecretsError-class.html | 2 +- ...lient.appengine.OAuth2Decorator-class.html | 2 +- ...Auth2DecoratorFromClientSecrets-class.html | 2 +- ...2client.appengine.OAuth2Handler-class.html | 2 +- ...ient.appengine.StorageByKeyName-class.html | 2 +- docs/epy/oauth2client.client-module.html | 148 +- docs/epy/oauth2client.client-pysrc.html | 459 +-- ...t.client.AccessTokenCredentials-class.html | 2 +- ...ent.AccessTokenCredentialsError-class.html | 8 +- ....client.AccessTokenRefreshError-class.html | 8 +- ...ent.client.AssertionCredentials-class.html | 6 +- ...oauth2client.client.Credentials-class.html | 28 +- docs/epy/oauth2client.client.Error-class.html | 44 +- docs/epy/oauth2client.client.Flow-class.html | 2 +- ...client.client.FlowExchangeError-class.html | 8 +- ...oauth2client.client.MemoryCache-class.html | 2 +- ...client.client.OAuth2Credentials-class.html | 6 +- ...ient.client.OAuth2WebServerFlow-class.html | 2 +- ...t.SignedJwtAssertionCredentials-class.html | 2 +- .../oauth2client.client.Storage-class.html | 24 +- ...t.UnknownClientSecretsFlowError-class.html | 8 +- ...ient.client.VerifyJwtTokenError-class.html | 8 +- .../oauth2client.clientsecrets-module.html | 2 +- .../epy/oauth2client.clientsecrets-pysrc.html | 14 +- ...auth2client.clientsecrets.Error-class.html | 2 +- ...crets.InvalidClientSecretsError-class.html | 8 +- docs/epy/oauth2client.crypt-module.html | 2 +- docs/epy/oauth2client.crypt-pysrc.html | 2 +- ...h2client.crypt.AppIdentityError-class.html | 2 +- docs/epy/oauth2client.crypt.Signer-class.html | 2 +- .../oauth2client.crypt.Verifier-class.html | 2 +- docs/epy/oauth2client.django_orm-module.html | 2 +- docs/epy/oauth2client.django_orm-pysrc.html | 2 +- ...ent.django_orm.CredentialsField-class.html | 70 +- ...uth2client.django_orm.FlowField-class.html | 70 +- ...oauth2client.django_orm.Storage-class.html | 2 +- docs/epy/oauth2client.file-module.html | 2 +- docs/epy/oauth2client.file-pysrc.html | 32 +- docs/epy/oauth2client.file.Storage-class.html | 2 +- docs/epy/oauth2client.locked_file-module.html | 210 ++ docs/epy/oauth2client.locked_file-pysrc.html | 381 +++ ...ked_file.AlreadyLockedException-class.html | 202 ++ ...h2client.locked_file.LockedFile-class.html | 374 +++ ...client.locked_file._FcntlOpener-class.html | 301 ++ ...auth2client.locked_file._Opener-class.html | 402 +++ ...client.locked_file._PosixOpener-class.html | 321 ++ .../oauth2client.multistore_file-module.html | 2 +- .../oauth2client.multistore_file-pysrc.html | 659 ++-- ...th2client.multistore_file.Error-class.html | 6 +- ..._file.NewerCredentialStoreError-class.html | 12 +- ...ent.multistore_file._MultiStore-class.html | 6 +- ...store_file._MultiStore._Storage-class.html | 6 +- docs/epy/oauth2client.tools-module.html | 2 +- docs/epy/oauth2client.tools-pysrc.html | 104 +- ...ent.tools.ClientRedirectHandler-class.html | 6 +- ...ient.tools.ClientRedirectServer-class.html | 26 +- docs/epy/redirect.html | 2 +- docs/epy/toc-apiclient.discovery-module.html | 17 +- docs/epy/toc-apiclient.http-module.html | 6 +- docs/epy/toc-everything.html | 49 +- docs/epy/toc-oauth2client.client-module.html | 4 +- .../toc-oauth2client.locked_file-module.html | 44 + docs/epy/toc.html | 8 +- docs/oauth2client.anyjson.html | 2 +- docs/oauth2client.appengine.html | 6 +- docs/oauth2client.client.html | 55 +- docs/oauth2client.clientsecrets.html | 2 +- docs/oauth2client.crypt.html | 2 +- docs/oauth2client.django_orm.html | 2 +- docs/oauth2client.file.html | 2 +- docs/oauth2client.html | 7 +- docs/oauth2client.locked_file.html | 179 ++ docs/oauth2client.multistore_file.html | 13 +- docs/oauth2client.tools.html | 2 +- docs/uritemplate.html | 2 +- 269 files changed, 11088 insertions(+), 4239 deletions(-) create mode 100644 docs/apiclient.ext.html create mode 100644 docs/dyn/androidpublisher.v1.html create mode 100644 docs/dyn/androidpublisher.v1.purchases.html create mode 100644 docs/dyn/books.v1.layers.volumeAnnotations.html create mode 100644 docs/dyn/books.v1.volumes.associated.html create mode 100644 docs/dyn/drive.v1.files.html create mode 100644 docs/dyn/drive.v1.html create mode 100644 docs/dyn/gan.v1beta1.links.html create mode 100644 docs/dyn/taskqueue.v1beta2.html create mode 100644 docs/dyn/taskqueue.v1beta2.taskqueues.html create mode 100644 docs/dyn/taskqueue.v1beta2.tasks.html create mode 100644 docs/epy/apiclient.http.MediaIoBaseUpload-class.html create mode 100644 docs/epy/oauth2client.locked_file-module.html create mode 100644 docs/epy/oauth2client.locked_file-pysrc.html create mode 100644 docs/epy/oauth2client.locked_file.AlreadyLockedException-class.html create mode 100644 docs/epy/oauth2client.locked_file.LockedFile-class.html create mode 100644 docs/epy/oauth2client.locked_file._FcntlOpener-class.html create mode 100644 docs/epy/oauth2client.locked_file._Opener-class.html create mode 100644 docs/epy/oauth2client.locked_file._PosixOpener-class.html create mode 100644 docs/epy/toc-oauth2client.locked_file-module.html create mode 100644 docs/oauth2client.locked_file.html diff --git a/docs/apiclient.discovery.html b/docs/apiclient.discovery.html index aee0373..783849a 100644 --- a/docs/apiclient.discovery.html +++ b/docs/apiclient.discovery.html @@ -8,7 +8,7 @@  
 
apiclient.discoveryindex
/home/jcgregorio/projects/apiclient-release/apiclient/discovery.py +>index
/home/jcgregorio/projects/clean/apiclient/discovery.py

Client for discovery based APIs
 
A client library for Google's discovery based APIs.

@@ -40,51 +40,35 @@ A client library for Google's discovery based         
build(serviceName, version, http=None, discoveryServiceUrl='https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersion}/rest', developerKey=None, model=None, requestBuilder=<class 'apiclient.http.HttpRequest'>)
Construct a Resource for interacting with an API.
 
-Construct a Resource object for interacting with
-an API. The serviceName and version are the
-names from the Discovery service.
+Construct a Resource object for interacting with an API. The serviceName and
+version are the names from the Discovery service.
 
Args:
-  serviceName: string, name of the service
-  version: string, the version of the service
+  serviceName: string, name of the service.
+  version: string, the version of the service.
  http: httplib2.Http, An instance of httplib2.Http or something that acts
    like it that HTTP requests will be made through.
-  discoveryServiceUrl: string, a URI Template that points to
-    the location of the discovery service. It should have two
-    parameters {api} and {apiVersion} that when filled in
-    produce an absolute URI to the discovery document for
-    that service.
-  developerKey: string, key obtained
-    from https://code.google.com/apis/console
-  model: apiclient.Model, converts to and from the wire format
-  requestBuilder: apiclient.http.HttpRequest, encapsulator for
-    an HTTP request
+  discoveryServiceUrl: string, a URI Template that points to the location of
+    the discovery service. It should have two parameters {api} and
+    {apiVersion} that when filled in produce an absolute URI to the discovery
+    document for that service.
+  developerKey: string, key obtained from
+    https://code.google.com/apis/console.
+  model: apiclient.Model, converts to and from the wire format.
+  requestBuilder: apiclient.http.HttpRequest, encapsulator for an HTTP
+    request.
 
Returns:
-  A Resource object with methods for interacting with
-  the service.
-
build_from_document(service, base, future=None, http=None, developerKey=None, model=None, requestBuilder=<class 'apiclient.http.HttpRequest'>)
Create a Resource for interacting with an API.
+  A Resource object with methods for interacting with the service.
+
key2param(key)
Converts key names into parameter names.
 
-Same as `build()`, but constructs the Resource object
-from a discovery document that is it given, as opposed to
-retrieving one over HTTP.
+For example, converting "max-results" -> "max_results"
 
Args:
-  service: string, discovery document
-  base: string, base URI for all HTTP requests, usually the discovery URI
-  future: string, discovery document with future capabilities
-  auth_discovery: dict, information about the authentication the API supports
-  http: httplib2.Http, An instance of httplib2.Http or something that acts
-    like it that HTTP requests will be made through.
-  developerKey: string, Key for controlling API usage, generated
-    from the API Console.
-  model: Model class instance that serializes and
-    de-serializes requests and responses.
-  requestBuilder: Takes an http request and packages it up to be executed.
+  key: string, the method key name.
 
Returns:
-  A Resource object with methods for interacting with
-  the service.
+  A safe method name based on the key name.

@@ -92,7 +76,7 @@ Returns:
Data -
       __all__ = ['build', 'build_from_document']
+		__all__ = ['build', 'build_from_documentfix_method_name', 'key2param']
__author__ = 'jcgregorio@google.com (Joe Gregorio)'

diff --git a/docs/apiclient.errors.html b/docs/apiclient.errors.html index 12eee2a..ca65750 100644 --- a/docs/apiclient.errors.html +++ b/docs/apiclient.errors.html @@ -8,7 +8,7 @@
 
 
apiclient.errors		index
/home/jcgregorio/projects/apiclient-release/apiclient/errors.py
+>index
/home/jcgregorio/projects/clean/apiclient/errors.py

Errors for the library.
 
All exceptions defined by the library
diff --git a/docs/apiclient.ext.html b/docs/apiclient.ext.html new file mode 100644 index 0000000..dd6772b --- /dev/null +++ b/docs/apiclient.ext.html @@ -0,0 +1,21 @@ + + +Python: package apiclient.ext + + + + +
 
+ 
apiclient.ext		index
/home/jcgregorio/projects/clean/apiclient/ext/__init__.py
+

+

+ + + + + +
 
+Package Contents
       
+ \ No newline at end of file diff --git a/docs/apiclient.html b/docs/apiclient.html index 13a625c..214f6b2 100644 --- a/docs/apiclient.html +++ b/docs/apiclient.html @@ -8,7 +8,7 @@  
 
apiclient (version 1.0b9)index
/home/jcgregorio/projects/apiclient-release/apiclient/__init__.py +>index
/home/jcgregorio/projects/clean/apiclient/__init__.py

@@ -17,15 +17,12 @@ Package Contents -
       
anyjson
-contrib (package)
-discovery
-		errors
-ext (package)
+
discovery
+errors
+		ext (package)
http
mimeparse
model
-oauth
schema

diff --git a/docs/apiclient.http.html b/docs/apiclient.http.html index 5c5aa78..69a1cad 100644 --- a/docs/apiclient.http.html +++ b/docs/apiclient.http.html @@ -8,7 +8,7 @@
 
 
apiclient.http		index
/home/jcgregorio/projects/apiclient-release/apiclient/http.py
+>index
/home/jcgregorio/projects/clean/apiclient/http.py

Classes to encapsulate a single HTTP request.
 
The classes implement a command pattern, with every
@@ -54,6 +54,7 @@ actuall HTTP request.

MediaFileUpload
MediaInMemoryUpload +
MediaIoBaseUpload
MediaUploadProgress @@ -254,7 +255,11 @@ Example:
 
Returns:
  (status, body): (ResumableMediaStatus, object)
-     The body will be None until the resumable media is fully uploaded. +     The body will be None until the resumable media is fully uploaded.
+ 
+Raises:
+  apiclient.errors.HttpError if the response was not a 2xx.
+  httplib2.Error if a transport error has occured.
to_json(self)
Returns a JSON representation of the HttpRequest.
@@ -316,8 +321,8 @@ Construct a MediaFileUpload and&nb method. For example, if we had a service that allowed uploading images:
 
 
-  media = MediaFileUpload('smiley.png', mimetype='image/png', chunksize=1000,
-                  resumable=True)
+  media = MediaFileUpload('smiley.png', mimetype='image/png',
+    chunksize=1024*1024, resumable=True)
  service.objects().insert(
      bucket=buckets['items'][0]['id'],
      name='smiley.png',
@@ -330,7 +335,7 @@ method. For example, if we had a service 
Methods defined here:
-
__init__(self, filename, mimetype=None, chunksize=262144, resumable=False)
Constructor.
+
__init__(self, filename, mimetype=None, chunksize=524288, resumable=False)
Constructor.
 
Args:
  filename: string, Name of the file.
@@ -341,7 +346,10 @@ Args:
  resumable: bool, True if this is a resumable upload. False means upload
    in a single request.
-
chunksize(self)
+
chunksize(self)
Chunk size for resumable uploads.
+ 
+Returns:
+  Chunk size in bytes.
getbytes(self, begin, length)
Get bytes from the media.
 
@@ -353,11 +361,20 @@ Returns:
  A string of bytes read. May be shorted than length if EOF was reached
  first.
-
mimetype(self)
+
mimetype(self)
Mime type of the body.
+ 
+Returns:
+  Mime type.
-
resumable(self)
+
resumable(self)
Whether this upload is resumable.
+ 
+Returns:
+  True if resumable upload or False.
-
size(self)
+
size(self)
Size of upload.
+ 
+Returns:
+  Size of the body, or None of the size is unknown.
to_json(self)
Creating a JSON representation of an instance of Credentials.
 
@@ -408,7 +425,7 @@ method. For example, if we had a service 
Methods defined here:
-
__init__(self, body, mimetype='application/octet-stream', chunksize=262144, resumable=False)
Create a new MediaBytesUpload.
+
__init__(self, body, mimetype='application/octet-stream', chunksize=524288, resumable=False)
Create a new MediaBytesUpload.
 
Args:
  body: string, Bytes of body content.
@@ -447,7 +464,7 @@ Returns:
size(self)
Size of upload.
 
Returns:
-  Size of the body.
+  Size of the body, or None of the size is unknown.
to_json(self)
Create a JSON representation of a MediaInMemoryUpload.
 
@@ -471,6 +488,97 @@ Returns:
  An instance of the subclass of MediaUpload that was serialized with
  to_json().
+
+Data descriptors inherited from MediaUpload:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + + + + +Base class that defines the interface of MediaUpload subclasses.
+ 
+Note that subclasses of MediaUpload may allow you to control the chunksize
+when upload a media object. It is important to keep the size of the chunk as
+large as possible to keep the upload efficient. Other factors may influence
+the size of the chunk you use, particularly if you are working in an
+environment where individual HTTP requests may have a hardcoded time limit,
+such as under certain classes of requests under Google App Engine.
  -
 
+class MediaIoBaseUpload(MediaUpload)
   A MediaUpload for a io.Base objects.
+ 
+Note that the Python file object is compatible with io.Base and can be used
+with this class also.
+ 
+ 
+  fh = io.BytesIO('...Some data to upload...')
+  media = MediaIoBaseUpload(fh, mimetype='image/png',
+    chunksize=1024*1024, resumable=True)
+  service.objects().insert(
+      bucket='a_bucket_id',
+      name='smiley.png',
+      media_body=media).execute()
 
 
Method resolution order:
+
MediaIoBaseUpload
+
MediaUpload
+
__builtin__.object
+
+
+Methods defined here:
+
__init__(self, fh, mimetype, chunksize=524288, resumable=False)
Constructor.
+ 
+Args:
+  fh: io.Base or file object, The source of the bytes to upload.
+  mimetype: string, Mime-type of the file. If None then a mime-type will be
+    guessed from the file extension.
+  chunksize: int, File will be uploaded in chunks of this many bytes. Only
+    used if resumable=True.
+  resumable: bool, True if this is a resumable upload. False means upload
+    in a single request.
+ +
chunksize(self)
Chunk size for resumable uploads.
+ 
+Returns:
+  Chunk size in bytes.
+ +
getbytes(self, begin, length)
Get bytes from the media.
+ 
+Args:
+  begin: int, offset from beginning of file.
+  length: int, number of bytes to read, starting at begin.
+ 
+Returns:
+  A string of bytes read. May be shorted than length if EOF was reached
+  first.
+ +
mimetype(self)
Mime type of the body.
+ 
+Returns:
+  Mime type.
+ +
resumable(self)
Whether this upload is resumable.
+ 
+Returns:
+  True if resumable upload or False.
+ +
size(self)
Size of upload.
+ 
+Returns:
+  Size of the body, or None of the size is unknown.
+ +
to_json(self)
This upload type is not serializable.
+ +
+Class methods inherited from MediaUpload:
+
new_from_json(cls, s) from __builtin__.type
Utility class method to instantiate a MediaUpload subclass from a JSON
+representation produced by to_json().
+ 
+Args:
+  s: string, JSON from to_json().
+ 
+Returns:
+  An instance of the subclass of MediaUpload that was serialized with
+  to_json().
+
Data descriptors inherited from MediaUpload:
__dict__
@@ -488,18 +596,45 @@ Data descriptors inherited from MediaU
    Describes a media object to upload.
 
-Base class that defines the interface of MediaUpload subclasses.
 
  Methods defined here:
-
chunksize(self)
+
chunksize(self)
Chunk size for resumable uploads.
+ 
+Returns:
+  Chunk size in bytes.
-
getbytes(self, begin, end)
+
getbytes(self, begin, end)
Get bytes from the media.
+ 
+Args:
+  begin: int, offset from beginning of file.
+  length: int, number of bytes to read, starting at begin.
+ 
+Returns:
+  A string of bytes read. May be shorter than length if EOF was reached
+  first.
-
mimetype(self)
+
mimetype(self)
Mime type of the body.
+ 
+Returns:
+  Mime type.
-
resumable(self)
+
resumable(self)
Whether this upload is resumable.
+ 
+Returns:
+  True if resumable upload or False.
-
size(self)
+
size(self)
Size of upload.
+ 
+Returns:
+  Size of the body, or None of the size is unknown.
to_json(self)
Create a JSON representation of an instance of MediaUpload.
 
@@ -541,9 +676,14 @@ Data descriptors defined here:
 
Args:
  resumable_progress: int, bytes sent so far.
-  total_size: int, total bytes in complete upload.
+  total_size: int, total bytes in complete upload, or None if the total
+    upload size isn't known ahead of time. -
progress(self)
Percent of upload completed, as a float.
+
progress(self)
Percent of upload completed, as a float.
+ 
+Returns:
+  the percentage complete as a float, returning 0.0 if the total size of
+  the upload is unknown.
Data descriptors defined here:
@@ -658,7 +798,8 @@ will result in a different signature. Data
       __author__ = 'jcgregorio@google.com (Joe Gregorio)'

+DEFAULT_CHUNK_SIZE = 524288
+__author__ = 'jcgregorio@google.com (Joe Gregorio)'

 
diff --git a/docs/apiclient.mimeparse.html b/docs/apiclient.mimeparse.html index 8acff5d..ec76ce6 100644 --- a/docs/apiclient.mimeparse.html +++ b/docs/apiclient.mimeparse.html @@ -8,7 +8,7 @@ 		 
 
apiclient.mimeparse (version 0.1.3)		index
/home/jcgregorio/projects/apiclient-release/apiclient/mimeparse.py
+>index
/home/jcgregorio/projects/clean/apiclient/mimeparse.py

MIME-Type Parser
 
This module provides basic functions for handling mime-types. It can handle
diff --git a/docs/apiclient.model.html b/docs/apiclient.model.html index b1fe4e7..837f372 100644 --- a/docs/apiclient.model.html +++ b/docs/apiclient.model.html @@ -8,7 +8,7 @@  
 
apiclient.modelindex
/home/jcgregorio/projects/apiclient-release/apiclient/model.py +>index
/home/jcgregorio/projects/clean/apiclient/model.py

Model objects for requests and responses.
 
Each API may support one or more serializations, such
diff --git a/docs/apiclient.schema.html b/docs/apiclient.schema.html index b2b1c62..4594d76 100644 --- a/docs/apiclient.schema.html +++ b/docs/apiclient.schema.html @@ -8,7 +8,7 @@  
 
apiclient.schemaindex
/home/jcgregorio/projects/apiclient-release/apiclient/schema.py +>index
/home/jcgregorio/projects/clean/apiclient/schema.py

Schema processing for discovery based APIs
 
Schemas holds an APIs discovery schemas. It can return those schema as
diff --git a/docs/dyn/adexchangebuyer.v1.accounts.html b/docs/dyn/adexchangebuyer.v1.accounts.html index f20a6d6..9a967bd 100644 --- a/docs/dyn/adexchangebuyer.v1.accounts.html +++ b/docs/dyn/adexchangebuyer.v1.accounts.html @@ -17,6 +17,10 @@

get = method(self, **kwargs)
Gets one account by ID.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: integer, The account id (required)
 
Returns:
@@ -39,6 +43,10 @@ Returns:
list = method(self, **kwargs)
Retrieves the authenticated user's list of accounts.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -82,6 +90,10 @@ Args:
    "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: integer, The account id (required)
 
Returns:
@@ -121,6 +133,10 @@ Args:
    "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: integer, The account id (required)
 
Returns:
diff --git a/docs/dyn/adexchangebuyer.v1.creatives.html b/docs/dyn/adexchangebuyer.v1.creatives.html index dbeda6c..4247c9e 100644 --- a/docs/dyn/adexchangebuyer.v1.creatives.html +++ b/docs/dyn/adexchangebuyer.v1.creatives.html @@ -18,7 +18,11 @@  
Args:
  adgroupId: string, The adgroup this creative belongs to. (required)
+  trace: string, A parameter
+  pp: string, A parameter
+  strict: string, A parameter
  buyerCreativeId: string, The buyer-specific id for this creative. (required)
+  userip: string, A parameter
  accountId: integer, The id for the account that will serve this creative. (required)
 
Returns:
@@ -98,6 +102,10 @@ Args:
    "accountId": 42, # Account id.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -136,6 +144,58 @@ Returns:
      "accountId": 42, # Account id.
    }
+
list = method(self, **kwargs)
Retrieves a list of the authenticated user's active creatives.
+ 
+Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
+  maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
+  strict: string, A parameter
+  userip: string, A parameter
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "items": [ # A list of creatives.
+      {
+          "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
+            42,
+          ],
+          "advertiserName": "A String", # The name of the company being advertised in the creative.
+          "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
+          "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
+          "width": 42, # Ad width.
+          "attribute": [ # All attributes for the ads that may be shown from this snippet.
+            42,
+          ],
+          "kind": "adexchangebuyer#creative", # Resource type.
+          "height": 42, # Ad height.
+          "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
+            "A String",
+          ],
+          "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
+          "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
+          "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
+          "clickThroughUrl": [ # The set of destination urls for the snippet.
+            "A String",
+          ],
+          "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
+            42,
+          ],
+          "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
+            "A String",
+          ],
+          "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
+            42,
+          ],
+          "accountId": 42, # Account id.
+        },
+    ],
+    "kind": "adexchangebuyer#creativesList", # Resource type.
+  }
+
Data descriptors defined here:
__dict__
diff --git a/docs/dyn/adexchangebuyer.v1.directDeals.html b/docs/dyn/adexchangebuyer.v1.directDeals.html index d052816..f300677 100644 --- a/docs/dyn/adexchangebuyer.v1.directDeals.html +++ b/docs/dyn/adexchangebuyer.v1.directDeals.html @@ -17,6 +17,10 @@
get = method(self, **kwargs)
Gets one direct deal by ID.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: string, The direct deal id (required)
 
Returns:
@@ -37,6 +41,10 @@ Returns:
list = method(self, **kwargs)
Retrieves the authenticated user's list of direct deals.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/adsense.v1.1.accounts.adclients.html b/docs/dyn/adsense.v1.1.accounts.adclients.html index e8e3cf7..183b11f 100644 --- a/docs/dyn/adsense.v1.1.accounts.adclients.html +++ b/docs/dyn/adsense.v1.1.accounts.adclients.html @@ -17,8 +17,12 @@
list = method(self, **kwargs)
List all ad clients in the specified account.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
  accountId: string, Account for which to list ad clients. (required)
 
Returns:
diff --git a/docs/dyn/adsense.v1.1.accounts.adunits.customchannels.html b/docs/dyn/adsense.v1.1.accounts.adunits.customchannels.html index 7544c2c..1819d90 100644 --- a/docs/dyn/adsense.v1.1.accounts.adunits.customchannels.html +++ b/docs/dyn/adsense.v1.1.accounts.adunits.customchannels.html @@ -17,9 +17,13 @@
list = method(self, **kwargs)
List all custom channels which the specified ad unit belongs to.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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 which contains the ad unit. (required)
  maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
+  strict: string, A parameter
+  userip: string, A parameter
  adUnitId: string, Ad unit for which to list custom channels. (required)
  accountId: string, Account to which the ad client belongs. (required)
 
diff --git a/docs/dyn/adsense.v1.1.accounts.adunits.html b/docs/dyn/adsense.v1.1.accounts.adunits.html index c1ef81c..f5c7ea3 100644 --- a/docs/dyn/adsense.v1.1.accounts.adunits.html +++ b/docs/dyn/adsense.v1.1.accounts.adunits.html @@ -19,7 +19,11 @@
get = method(self, **kwargs)
Gets the specified ad unit in the specified ad client for the specified account.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  adClientId: string, Ad client for which to get the ad unit. (required)
+  strict: string, A parameter
+  userip: string, A parameter
  adUnitId: string, Ad unit to retrieve. (required)
  accountId: string, Account to which the ad client belongs. (required)
 
@@ -42,10 +46,14 @@ Returns:
list = method(self, **kwargs)
List all ad units in the specified ad client for the specified account.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
  accountId: string, Account to which the ad client belongs. (required)
 
Returns:
diff --git a/docs/dyn/adsense.v1.1.accounts.customchannels.adunits.html b/docs/dyn/adsense.v1.1.accounts.customchannels.adunits.html index ebd3ba6..c8b6f52 100644 --- a/docs/dyn/adsense.v1.1.accounts.customchannels.adunits.html +++ b/docs/dyn/adsense.v1.1.accounts.customchannels.adunits.html @@ -17,11 +17,15 @@
list = method(self, **kwargs)
List all ad units in the specified custom channel.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
  customChannelId: string, Custom channel for which to list ad units. (required)
  adClientId: string, Ad client which contains the custom channel. (required)
  maxResults: integer, The maximum number of ad units to include in the response, used for paging.
+  strict: string, A parameter
+  userip: string, A parameter
  accountId: string, Account to which the ad client belongs. (required)
 
Returns:
diff --git a/docs/dyn/adsense.v1.1.accounts.customchannels.html b/docs/dyn/adsense.v1.1.accounts.customchannels.html index e176555..3d206a7 100644 --- a/docs/dyn/adsense.v1.1.accounts.customchannels.html +++ b/docs/dyn/adsense.v1.1.accounts.customchannels.html @@ -19,8 +19,12 @@
get = method(self, **kwargs)
Get the specified custom channel from the specified ad client for the specified account.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  customChannelId: string, Custom channel to retrieve. (required)
  adClientId: string, Ad client which contains the custom channel. (required)
+  strict: string, A parameter
+  userip: string, A parameter
  accountId: string, Account to which the ad client belongs. (required)
 
Returns:
@@ -42,9 +46,13 @@ Returns:
list = method(self, **kwargs)
List all custom channels in the specified ad client for the specified account.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
  accountId: string, Account to which the ad client belongs. (required)
 
Returns:
diff --git a/docs/dyn/adsense.v1.1.accounts.html b/docs/dyn/adsense.v1.1.accounts.html index f18190f..8add277 100644 --- a/docs/dyn/adsense.v1.1.accounts.html +++ b/docs/dyn/adsense.v1.1.accounts.html @@ -23,7 +23,11 @@
get = method(self, **kwargs)
Get information about the selected AdSense account.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  tree: boolean, Whether the tree of sub accounts should be returned.
+  strict: string, A parameter
+  userip: string, A parameter
  accountId: string, Account to get information about. (required)
 
Returns:
@@ -41,8 +45,12 @@ Returns:
list = method(self, **kwargs)
List all accounts available to this AdSense account.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  pageToken: string, A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
  maxResults: integer, The maximum number of accounts to include in the response, used for paging.
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/adsense.v1.1.accounts.reports.html b/docs/dyn/adsense.v1.1.accounts.reports.html index dd7177e..fb46641 100644 --- a/docs/dyn/adsense.v1.1.accounts.reports.html +++ b/docs/dyn/adsense.v1.1.accounts.reports.html @@ -17,17 +17,21 @@
generate = method(self, **kwargs)
Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
 
Args:
-  sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
  startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
  endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
-  currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
  locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
  metric: string, Numeric columns to include in the report. (repeated)
+  currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
+  startIndex: integer, Index of the first row of report data to return.
+  accountId: string, Account upon which to report. (required)
+  pp: string, A parameter
+  strict: string, A parameter
+  sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
+  trace: string, A parameter
  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.
+  userip: string, A parameter
  dimension: string, Dimensions to base the report on. (repeated)
-  accountId: string, Account upon which to report. (required)
 
Returns:
  An object of the form
diff --git a/docs/dyn/adsense.v1.1.accounts.urlchannels.html b/docs/dyn/adsense.v1.1.accounts.urlchannels.html index 21e4972..5355e57 100644 --- a/docs/dyn/adsense.v1.1.accounts.urlchannels.html +++ b/docs/dyn/adsense.v1.1.accounts.urlchannels.html @@ -17,9 +17,13 @@
list = method(self, **kwargs)
List all URL channels in the specified ad client for the specified account.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
  accountId: string, Account to which the ad client belongs. (required)
 
Returns:
diff --git a/docs/dyn/adsense.v1.1.adclients.html b/docs/dyn/adsense.v1.1.adclients.html index 9ce30fc..7cb7ecc 100644 --- a/docs/dyn/adsense.v1.1.adclients.html +++ b/docs/dyn/adsense.v1.1.adclients.html @@ -17,8 +17,12 @@
list = method(self, **kwargs)
List all ad clients in this AdSense account.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/adsense.v1.1.adunits.customchannels.html b/docs/dyn/adsense.v1.1.adunits.customchannels.html index 92ab034..88b578d 100644 --- a/docs/dyn/adsense.v1.1.adunits.customchannels.html +++ b/docs/dyn/adsense.v1.1.adunits.customchannels.html @@ -17,9 +17,13 @@
list = method(self, **kwargs)
List all custom channels which the specified ad unit belongs to.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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 which contains the ad unit. (required)
  maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
+  strict: string, A parameter
+  userip: string, A parameter
  adUnitId: string, Ad unit for which to list custom channels. (required)
 
Returns:
diff --git a/docs/dyn/adsense.v1.1.adunits.html b/docs/dyn/adsense.v1.1.adunits.html index fe8c9a3..a4b5ee5 100644 --- a/docs/dyn/adsense.v1.1.adunits.html +++ b/docs/dyn/adsense.v1.1.adunits.html @@ -19,7 +19,11 @@
get = method(self, **kwargs)
Gets the specified ad unit in the specified ad client.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  adClientId: string, Ad client for which to get the ad unit. (required)
+  strict: string, A parameter
+  userip: string, A parameter
  adUnitId: string, Ad unit to retrieve. (required)
 
Returns:
@@ -41,10 +45,14 @@ Returns:
list = method(self, **kwargs)
List all ad units in the specified ad client for this AdSense account.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/adsense.v1.1.customchannels.adunits.html b/docs/dyn/adsense.v1.1.customchannels.adunits.html index 7f543af..02d0b4c 100644 --- a/docs/dyn/adsense.v1.1.customchannels.adunits.html +++ b/docs/dyn/adsense.v1.1.customchannels.adunits.html @@ -17,11 +17,15 @@
list = method(self, **kwargs)
List all ad units in the specified custom channel.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
  customChannelId: string, Custom channel for which to list ad units. (required)
  adClientId: string, Ad client which contains the custom channel. (required)
  maxResults: integer, The maximum number of ad units to include in the response, used for paging.
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/adsense.v1.1.customchannels.html b/docs/dyn/adsense.v1.1.customchannels.html index d32126f..e4a3480 100644 --- a/docs/dyn/adsense.v1.1.customchannels.html +++ b/docs/dyn/adsense.v1.1.customchannels.html @@ -19,8 +19,12 @@
get = method(self, **kwargs)
Get the specified custom channel from the specified ad client.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  customChannelId: string, Custom channel to retrieve. (required)
  adClientId: string, Ad client which contains the custom channel. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -41,9 +45,13 @@ Returns:
list = method(self, **kwargs)
List all custom channels in the specified ad client for this AdSense account.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/adsense.v1.1.reports.html b/docs/dyn/adsense.v1.1.reports.html index 36c7171..1d9daa2 100644 --- a/docs/dyn/adsense.v1.1.reports.html +++ b/docs/dyn/adsense.v1.1.reports.html @@ -17,17 +17,21 @@
generate = method(self, **kwargs)
Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
 
Args:
-  sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
  startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
  endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
-  currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
  locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
  metric: string, Numeric columns to include in the report. (repeated)
+  currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
+  startIndex: integer, Index of the first row of report data to return.
+  accountId: string, Accounts upon which to report. (repeated)
+  pp: string, A parameter
+  strict: string, A parameter
+  sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
+  trace: string, A parameter
  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.
+  userip: string, A parameter
  dimension: string, Dimensions to base the report on. (repeated)
-  accountId: string, Accounts upon which to report. (repeated)
 
Returns:
  An object of the form
diff --git a/docs/dyn/adsense.v1.1.urlchannels.html b/docs/dyn/adsense.v1.1.urlchannels.html index e8d6aa8..bb6d4a5 100644 --- a/docs/dyn/adsense.v1.1.urlchannels.html +++ b/docs/dyn/adsense.v1.1.urlchannels.html @@ -17,9 +17,13 @@
list = method(self, **kwargs)
List all URL channels in the specified ad client for this AdSense account.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/analytics.v3.data.ga.html b/docs/dyn/analytics.v3.data.ga.html index 2bb0a0b..4187700 100644 --- a/docs/dyn/analytics.v3.data.ga.html +++ b/docs/dyn/analytics.v3.data.ga.html @@ -18,12 +18,16 @@  
Args:
  sort: string, A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.
+  pp: string, A parameter
  end_date: string, End date for fetching Analytics data. All requests should specify an end date formatted as YYYY-MM-DD. (required)
  dimensions: string, A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
+  userip: string, A parameter
+  filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data.
  ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics profile ID. (required)
  metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified. (required)
+  strict: string, A parameter
  max_results: integer, The maximum number of entries to include in this feed.
-  filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data.
+  trace: string, A parameter
  segment: string, An Analytics advanced segment to be applied to data.
  start_date: string, Start date for fetching Analytics data. All requests should specify a start date formatted as YYYY-MM-DD. (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.
diff --git a/docs/dyn/analytics.v3.management.accounts.html b/docs/dyn/analytics.v3.management.accounts.html index 928bcce..f37bbae 100644 --- a/docs/dyn/analytics.v3.management.accounts.html +++ b/docs/dyn/analytics.v3.management.accounts.html @@ -17,7 +17,11 @@
list = method(self, **kwargs)
Lists all accounts to which the user has access.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  max_results: integer, The maximum number of accounts to include in this response.
+  userip: string, A parameter
  start_index: integer, An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
 
Returns:
diff --git a/docs/dyn/analytics.v3.management.goals.html b/docs/dyn/analytics.v3.management.goals.html index 2b330a2..a60fe44 100644 --- a/docs/dyn/analytics.v3.management.goals.html +++ b/docs/dyn/analytics.v3.management.goals.html @@ -17,8 +17,12 @@
list = method(self, **kwargs)
Lists goals to which the user has access.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  max_results: integer, The maximum number of goals to include in this response.
  webPropertyId: string, Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. (required)
+  userip: string, A parameter
  profileId: string, Profile ID to retrieve goals for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. (required)
  start_index: integer, An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
  accountId: string, Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. (required)
diff --git a/docs/dyn/analytics.v3.management.profiles.html b/docs/dyn/analytics.v3.management.profiles.html index 87f3ee5..4c83eb3 100644 --- a/docs/dyn/analytics.v3.management.profiles.html +++ b/docs/dyn/analytics.v3.management.profiles.html @@ -17,8 +17,12 @@
list = method(self, **kwargs)
Lists profiles to which the user has access.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  max_results: integer, The maximum number of profiles to include in this response.
  webPropertyId: string, Web property ID for the profiles to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. (required)
+  userip: string, A parameter
  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 profiles to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)
 
diff --git a/docs/dyn/analytics.v3.management.segments.html b/docs/dyn/analytics.v3.management.segments.html index a687df1..fe996bb 100644 --- a/docs/dyn/analytics.v3.management.segments.html +++ b/docs/dyn/analytics.v3.management.segments.html @@ -17,7 +17,11 @@
list = method(self, **kwargs)
Lists advanced segments to which the user has access.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  max_results: integer, The maximum number of advanced segments to include in this response.
+  userip: string, A parameter
  start_index: integer, An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
 
Returns:
diff --git a/docs/dyn/analytics.v3.management.webproperties.html b/docs/dyn/analytics.v3.management.webproperties.html index a8dfaab..42f3f64 100644 --- a/docs/dyn/analytics.v3.management.webproperties.html +++ b/docs/dyn/analytics.v3.management.webproperties.html @@ -17,7 +17,11 @@
list = method(self, **kwargs)
Lists web properties to which the user has access.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  max_results: integer, The maximum number of web properties to include in this response.
+  userip: string, A parameter
  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 to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. (required)
 
diff --git a/docs/dyn/androidpublisher.v1.html b/docs/dyn/androidpublisher.v1.html new file mode 100644 index 0000000..2775196 --- /dev/null +++ b/docs/dyn/androidpublisher.v1.html @@ -0,0 +1,28 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
purchases = methodResource(self)
A collection resource.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/androidpublisher.v1.purchases.html b/docs/dyn/androidpublisher.v1.purchases.html new file mode 100644 index 0000000..f65389b --- /dev/null +++ b/docs/dyn/androidpublisher.v1.purchases.html @@ -0,0 +1,58 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
cancel = method(self, **kwargs)
Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
+ 
+Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
+  strict: string, A parameter
+  token: string, The token provided to the user's device when the subscription was purchased. (required)
+  userip: string, A parameter
+  subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
+ +
get = method(self, **kwargs)
Checks whether a user's subscription purchase is valid and returns its expiry time.
+ 
+Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
+  strict: string, A parameter
+  token: string, The token provided to the user's device when the subscription was purchased. (required)
+  userip: string, A parameter
+  subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
+ 
+Returns:
+  An object of the form
+ 
+    { # A Purchase resource indicates the status of a user's subscription purchase.
+    "initiationTimestampMsec": "A String", # Time at which the subscription was granted, in milliseconds since Epoch.
+    "kind": "androidpublisher#subscriptionPurchase", # This kind represents a subscriptionPurchase object in the androidpublisher service.
+    "autoRenewing": True or False, # Whether the subscription will automatically be renewed when it reaches its current expiry time.
+    "validUntilTimestampMsec": "A String", # Time at which the subscription will expire, in milliseconds since Epoch.
+  }
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/audit.v1.activities.html b/docs/dyn/audit.v1.activities.html index 4b1916a..0f62a73 100644 --- a/docs/dyn/audit.v1.activities.html +++ b/docs/dyn/audit.v1.activities.html @@ -21,16 +21,20 @@ Args:
    Allowed values
      application_owner - Caller is an application owner.
      customer - Caller is a customer.
-  actorApplicationId: string, Application ID of the application which interacted on behalf of the user while performing the event.
-  actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
-  actorEmail: string, Email address of the user who performed the action.
-  maxResults: integer, Number of activity records to be shown in each page.
-  continuationToken: string, Next page URL.
-  eventName: string, Name of the event being queried.
-  endTime: string, Return events which occured at or before this time.
  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],...
+  actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
  applicationId: string, Application ID of the application on which the event was performed. (required)
+  eventName: string, Name of the event being queried.
+  pp: string, A parameter
+  trace: string, A parameter
+  actorApplicationId: string, Application ID of the application which interacted on behalf of the user while performing the event.
+  strict: string, A parameter
+  continuationToken: string, Next page URL.
+  maxResults: integer, Number of activity records to be shown in each page.
+  parameters: string, Event parameters in the form [parameter1 name]:[parameter1 value],[parameter2 name]:[parameter2 value],...
+  actorEmail: string, Email address of the user who performed the action.
+  userip: string, A parameter
+  endTime: string, Return events which occured at or before this time.
  customerId: string, Represents the customer who is the owner of target object on which action was performed. (required)
 
Returns:
diff --git a/docs/dyn/bigquery.v2.datasets.html b/docs/dyn/bigquery.v2.datasets.html index 5f961a4..20182f2 100644 --- a/docs/dyn/bigquery.v2.datasets.html +++ b/docs/dyn/bigquery.v2.datasets.html @@ -18,13 +18,21 @@  
Args:
  deleteContents: boolean, If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  projectId: string, Project ID of the dataset being deleted (required)
+  userip: string, A parameter
  datasetId: string, Dataset ID of dataset being deleted (required)

get = method(self, **kwargs)
Returns the dataset specified by datasetID.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the requested dataset (required)
+  strict: string, A parameter
+  userip: string, A parameter
  datasetId: string, Dataset ID of the requested dataset (required)
 
Returns:
@@ -92,7 +100,11 @@ Args:
    "selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the new dataset (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -128,9 +140,13 @@ Returns:
list = method(self, **kwargs)
Lists all the datasets in the specified project to which the caller has read access; however, a project owner can list (but not necessarily get) all datasets in his project.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  pageToken: string, Page token, returned by a previous call, to request the next page of results
  maxResults: integer, The maximum number of results to return
+  strict: string, A parameter
  projectId: string, Project ID of the datasets to be listed (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -196,7 +212,11 @@ Args:
    "selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the dataset being updated (required)
+  strict: string, A parameter
+  userip: string, A parameter
  datasetId: string, Dataset ID of the dataset being updated (required)
 
Returns:
@@ -264,7 +284,11 @@ Args:
    "selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the dataset being updated (required)
+  strict: string, A parameter
+  userip: string, A parameter
  datasetId: string, Dataset ID of the dataset being updated (required)
 
Returns:
diff --git a/docs/dyn/bigquery.v2.jobs.html b/docs/dyn/bigquery.v2.jobs.html index 8ab4b8e..fea8ea2 100644 --- a/docs/dyn/bigquery.v2.jobs.html +++ b/docs/dyn/bigquery.v2.jobs.html @@ -17,8 +17,12 @@
get = method(self, **kwargs)
Retrieves the specified job by ID.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the requested job (required)
  jobId: string, Job ID of the requested job (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -83,26 +87,30 @@ Returns:
        },
        "link": { # [Pick one] Configures a link job.
          "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
+          "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
          "destinationTable": { # [Required] The destination table of the link job.
            "projectId": "A String", # [Required] ID of the project billed for storage of the table.
            "tableId": "A String", # [Required] ID of the table.
            "datasetId": "A String", # [Required] ID of the dataset containing the table.
          },
-          "sourceUri": "A String", # [Required] URI of source table to link.
+          "sourceUri": [ # [Required] URI of source table to link.
+            "A String",
+          ],
        },
        "query": { # [Pick one] Configures a query job.
-          "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
-          "query": "A String", # [Required] BigQuery SQL query to execute.
-          "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
+          "defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
+            "projectId": "A String", # [Optional] The ID of the container project.
+            "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
+          },
          "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
            "projectId": "A String", # [Required] ID of the project billed for storage of the table.
            "tableId": "A String", # [Required] ID of the table.
            "datasetId": "A String", # [Required] ID of the dataset containing the table.
          },
-          "defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
-            "projectId": "A String", # [Optional] The ID of the container project.
-            "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
-          },
+          "priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.
+          "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
+          "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
+          "query": "A String", # [Required] BigQuery SQL query to execute.
        },
        "copy": { # [Pick one] Copies a table.
          "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
@@ -120,11 +128,13 @@ Returns:
        },
        "extract": { # [Pick one] Configures an extract job.
          "destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
+          "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
          "sourceTable": { # [Required] A reference to the table being exported.
            "projectId": "A String", # [Required] ID of the project billed for storage of the table.
            "tableId": "A String", # [Required] ID of the table.
            "datasetId": "A String", # [Required] ID of the dataset containing the table.
          },
+          "printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
        },
        "properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.
        },
@@ -137,10 +147,14 @@ Returns:
 
Args:
  timeoutMs: integer, How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the query job (required)
  maxResults: integer, Maximum number of results to read
  jobId: string, Job ID of the query job (required)
+  strict: string, A parameter
  startIndex: string, Zero-based index of the starting row
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -243,26 +257,30 @@ Args:
      },
      "link": { # [Pick one] Configures a link job.
        "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
+        "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
        "destinationTable": { # [Required] The destination table of the link job.
          "projectId": "A String", # [Required] ID of the project billed for storage of the table.
          "tableId": "A String", # [Required] ID of the table.
          "datasetId": "A String", # [Required] ID of the dataset containing the table.
        },
-        "sourceUri": "A String", # [Required] URI of source table to link.
+        "sourceUri": [ # [Required] URI of source table to link.
+          "A String",
+        ],
      },
      "query": { # [Pick one] Configures a query job.
-        "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
-        "query": "A String", # [Required] BigQuery SQL query to execute.
-        "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
+        "defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
+          "projectId": "A String", # [Optional] The ID of the container project.
+          "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
+        },
        "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
          "projectId": "A String", # [Required] ID of the project billed for storage of the table.
          "tableId": "A String", # [Required] ID of the table.
          "datasetId": "A String", # [Required] ID of the dataset containing the table.
        },
-        "defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
-          "projectId": "A String", # [Optional] The ID of the container project.
-          "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
-        },
+        "priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.
+        "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
+        "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
+        "query": "A String", # [Required] BigQuery SQL query to execute.
      },
      "copy": { # [Pick one] Copies a table.
        "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
@@ -280,11 +298,13 @@ Args:
      },
      "extract": { # [Pick one] Configures an extract job.
        "destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
+        "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
        "sourceTable": { # [Required] A reference to the table being exported.
          "projectId": "A String", # [Required] ID of the project billed for storage of the table.
          "tableId": "A String", # [Required] ID of the table.
          "datasetId": "A String", # [Required] ID of the dataset containing the table.
        },
+        "printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
      },
      "properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.
      },
@@ -294,7 +314,11 @@ Args:
  }
 
  media_body: string, The filename of the media request body.
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the project that will be billed for the job (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -359,26 +383,30 @@ Returns:
        },
        "link": { # [Pick one] Configures a link job.
          "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
+          "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
          "destinationTable": { # [Required] The destination table of the link job.
            "projectId": "A String", # [Required] ID of the project billed for storage of the table.
            "tableId": "A String", # [Required] ID of the table.
            "datasetId": "A String", # [Required] ID of the dataset containing the table.
          },
-          "sourceUri": "A String", # [Required] URI of source table to link.
+          "sourceUri": [ # [Required] URI of source table to link.
+            "A String",
+          ],
        },
        "query": { # [Pick one] Configures a query job.
-          "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
-          "query": "A String", # [Required] BigQuery SQL query to execute.
-          "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
+          "defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
+            "projectId": "A String", # [Optional] The ID of the container project.
+            "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
+          },
          "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
            "projectId": "A String", # [Required] ID of the project billed for storage of the table.
            "tableId": "A String", # [Required] ID of the table.
            "datasetId": "A String", # [Required] ID of the dataset containing the table.
          },
-          "defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
-            "projectId": "A String", # [Optional] The ID of the container project.
-            "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
-          },
+          "priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.
+          "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
+          "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
+          "query": "A String", # [Required] BigQuery SQL query to execute.
        },
        "copy": { # [Pick one] Copies a table.
          "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
@@ -396,11 +424,13 @@ Returns:
        },
        "extract": { # [Pick one] Configures an extract job.
          "destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
+          "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
          "sourceTable": { # [Required] A reference to the table being exported.
            "projectId": "A String", # [Required] ID of the project billed for storage of the table.
            "tableId": "A String", # [Required] ID of the table.
            "datasetId": "A String", # [Required] ID of the dataset containing the table.
          },
+          "printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
        },
        "properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.
        },
@@ -412,6 +442,7 @@ Returns:
list = method(self, **kwargs)
Lists all the Jobs in the specified project that were started by the user.
 
Args:
+  pp: string, A parameter
  projection: string, Restrict information returned to a set of selected fields
    Allowed values
      full - Includes all job data
@@ -425,6 +456,9 @@ Args:
  projectId: string, Project ID of the jobs to list (required)
  allUsers: boolean, Whether to display jobs owned by all users in the project. Default false
  maxResults: integer, Maximum number of results to return
+  strict: string, A parameter
+  userip: string, A parameter
+  trace: string, A parameter
 
Returns:
  An object of the form
@@ -495,26 +529,30 @@ Returns:
          },
          "link": { # [Pick one] Configures a link job.
            "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
+            "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
            "destinationTable": { # [Required] The destination table of the link job.
              "projectId": "A String", # [Required] ID of the project billed for storage of the table.
              "tableId": "A String", # [Required] ID of the table.
              "datasetId": "A String", # [Required] ID of the dataset containing the table.
            },
-            "sourceUri": "A String", # [Required] URI of source table to link.
+            "sourceUri": [ # [Required] URI of source table to link.
+              "A String",
+            ],
          },
          "query": { # [Pick one] Configures a query job.
-            "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
-            "query": "A String", # [Required] BigQuery SQL query to execute.
-            "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
+            "defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
+              "projectId": "A String", # [Optional] The ID of the container project.
+              "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
+            },
            "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
              "projectId": "A String", # [Required] ID of the project billed for storage of the table.
              "tableId": "A String", # [Required] ID of the table.
              "datasetId": "A String", # [Required] ID of the dataset containing the table.
            },
-            "defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
-              "projectId": "A String", # [Optional] The ID of the container project.
-              "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
-            },
+            "priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.
+            "writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
+            "createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
+            "query": "A String", # [Required] BigQuery SQL query to execute.
          },
          "copy": { # [Pick one] Copies a table.
            "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
@@ -532,11 +570,13 @@ Returns:
          },
          "extract": { # [Pick one] Configures an extract job.
            "destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
+            "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
            "sourceTable": { # [Required] A reference to the table being exported.
              "projectId": "A String", # [Required] ID of the project billed for storage of the table.
              "tableId": "A String", # [Required] ID of the table.
              "datasetId": "A String", # [Required] ID of the dataset containing the table.
            },
+            "printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
          },
          "properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.
          },
@@ -579,7 +619,11 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the project billed for the query (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/bigquery.v2.projects.html b/docs/dyn/bigquery.v2.projects.html index 476f194..0e2fe51 100644 --- a/docs/dyn/bigquery.v2.projects.html +++ b/docs/dyn/bigquery.v2.projects.html @@ -17,8 +17,12 @@
list = method(self, **kwargs)
Lists the projects to which you have at least read access.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  pageToken: string, Page token, returned by a previous call, to request the next page of results
  maxResults: integer, Maximum number of results to return
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/bigquery.v2.tabledata.html b/docs/dyn/bigquery.v2.tabledata.html index 3f05cf0..8f7243e 100644 --- a/docs/dyn/bigquery.v2.tabledata.html +++ b/docs/dyn/bigquery.v2.tabledata.html @@ -17,10 +17,14 @@
list = method(self, **kwargs)
Retrieves table data from a specified set of rows.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the table to read (required)
  maxResults: integer, Maximum number of results to return
+  strict: string, A parameter
  startIndex: string, Zero-based index of the starting row to read
  tableId: string, Table ID of the table to read (required)
+  userip: string, A parameter
  datasetId: string, Dataset ID of the table to read (required)
 
Returns:
diff --git a/docs/dyn/bigquery.v2.tables.html b/docs/dyn/bigquery.v2.tables.html index 28165d6..7e69e1a 100644 --- a/docs/dyn/bigquery.v2.tables.html +++ b/docs/dyn/bigquery.v2.tables.html @@ -17,15 +17,23 @@
delete = method(self, **kwargs)
Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the table to delete (required)
+  strict: string, A parameter
  tableId: string, Table ID of the table to delete (required)
+  userip: string, A parameter
  datasetId: string, Dataset ID of the table to delete (required)
get = method(self, **kwargs)
Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the requested table (required)
+  strict: string, A parameter
  tableId: string, Table ID of the requested table (required)
+  userip: string, A parameter
  datasetId: string, Dataset ID of the requested table (required)
 
Returns:
@@ -33,6 +41,7 @@ Returns:
 
    {
      "kind": "bigquery#table", # [Output-only] The type of the resource.
+      "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
      "description": "A String", # [Optional] A user-friendly description of this table.
      "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
      "tableReference": { # [Required] Reference describing the ID of this table.
@@ -44,7 +53,7 @@ Returns:
      "numBytes": "A String", # [Output-only] The size of the table in bytes.
      "etag": "A String", # [Output-only] A hash of this resource.
      "friendlyName": "A String", # [Optional] A descriptive name for this table.
-      "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
+      "expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
      "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
      "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
      "schema": { # [Optional] Describes the schema of this table.
@@ -69,6 +78,7 @@ Args:
 
{
    "kind": "bigquery#table", # [Output-only] The type of the resource.
+    "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
    "description": "A String", # [Optional] A user-friendly description of this table.
    "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
    "tableReference": { # [Required] Reference describing the ID of this table.
@@ -80,7 +90,7 @@ Args:
    "numBytes": "A String", # [Output-only] The size of the table in bytes.
    "etag": "A String", # [Output-only] A hash of this resource.
    "friendlyName": "A String", # [Optional] A descriptive name for this table.
-    "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
+    "expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
    "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
    "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
    "schema": { # [Optional] Describes the schema of this table.
@@ -97,7 +107,11 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the new table (required)
+  strict: string, A parameter
+  userip: string, A parameter
  datasetId: string, Dataset ID of the new table (required)
 
Returns:
@@ -105,6 +119,7 @@ Returns:
 
    {
      "kind": "bigquery#table", # [Output-only] The type of the resource.
+      "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
      "description": "A String", # [Optional] A user-friendly description of this table.
      "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
      "tableReference": { # [Required] Reference describing the ID of this table.
@@ -116,7 +131,7 @@ Returns:
      "numBytes": "A String", # [Output-only] The size of the table in bytes.
      "etag": "A String", # [Output-only] A hash of this resource.
      "friendlyName": "A String", # [Optional] A descriptive name for this table.
-      "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
+      "expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
      "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
      "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
      "schema": { # [Optional] Describes the schema of this table.
@@ -136,9 +151,13 @@ Returns:
list = method(self, **kwargs)
Lists all tables in the specified dataset.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  pageToken: string, Page token, returned by a previous call, to request the next page of results
  maxResults: integer, Maximum number of results to return
+  strict: string, A parameter
  projectId: string, Project ID of the tables to list (required)
+  userip: string, A parameter
  datasetId: string, Dataset ID of the tables to list (required)
 
Returns:
@@ -181,6 +200,7 @@ Args:
 
{
    "kind": "bigquery#table", # [Output-only] The type of the resource.
+    "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
    "description": "A String", # [Optional] A user-friendly description of this table.
    "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
    "tableReference": { # [Required] Reference describing the ID of this table.
@@ -192,7 +212,7 @@ Args:
    "numBytes": "A String", # [Output-only] The size of the table in bytes.
    "etag": "A String", # [Output-only] A hash of this resource.
    "friendlyName": "A String", # [Optional] A descriptive name for this table.
-    "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
+    "expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
    "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
    "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
    "schema": { # [Optional] Describes the schema of this table.
@@ -209,8 +229,12 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the table to update (required)
+  strict: string, A parameter
  tableId: string, Table ID of the table to update (required)
+  userip: string, A parameter
  datasetId: string, Dataset ID of the table to update (required)
 
Returns:
@@ -218,6 +242,7 @@ Returns:
 
    {
      "kind": "bigquery#table", # [Output-only] The type of the resource.
+      "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
      "description": "A String", # [Optional] A user-friendly description of this table.
      "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
      "tableReference": { # [Required] Reference describing the ID of this table.
@@ -229,7 +254,7 @@ Returns:
      "numBytes": "A String", # [Output-only] The size of the table in bytes.
      "etag": "A String", # [Output-only] A hash of this resource.
      "friendlyName": "A String", # [Optional] A descriptive name for this table.
-      "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
+      "expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
      "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
      "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
      "schema": { # [Optional] Describes the schema of this table.
@@ -254,6 +279,7 @@ Args:
 
{
    "kind": "bigquery#table", # [Output-only] The type of the resource.
+    "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
    "description": "A String", # [Optional] A user-friendly description of this table.
    "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
    "tableReference": { # [Required] Reference describing the ID of this table.
@@ -265,7 +291,7 @@ Args:
    "numBytes": "A String", # [Output-only] The size of the table in bytes.
    "etag": "A String", # [Output-only] A hash of this resource.
    "friendlyName": "A String", # [Optional] A descriptive name for this table.
-    "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
+    "expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
    "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
    "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
    "schema": { # [Optional] Describes the schema of this table.
@@ -282,8 +308,12 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  projectId: string, Project ID of the table to update (required)
+  strict: string, A parameter
  tableId: string, Table ID of the table to update (required)
+  userip: string, A parameter
  datasetId: string, Dataset ID of the table to update (required)
 
Returns:
@@ -291,6 +321,7 @@ Returns:
 
    {
      "kind": "bigquery#table", # [Output-only] The type of the resource.
+      "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
      "description": "A String", # [Optional] A user-friendly description of this table.
      "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
      "tableReference": { # [Required] Reference describing the ID of this table.
@@ -302,7 +333,7 @@ Returns:
      "numBytes": "A String", # [Output-only] The size of the table in bytes.
      "etag": "A String", # [Output-only] A hash of this resource.
      "friendlyName": "A String", # [Optional] A descriptive name for this table.
-      "lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
+      "expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
      "id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
      "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
      "schema": { # [Optional] Describes the schema of this table.
diff --git a/docs/dyn/blogger.v2.blogs.html b/docs/dyn/blogger.v2.blogs.html index d227c91..081179c 100644 --- a/docs/dyn/blogger.v2.blogs.html +++ b/docs/dyn/blogger.v2.blogs.html @@ -17,6 +17,10 @@
get = method(self, **kwargs)
Gets one blog by id.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  blogId: string, The ID of the blog to get. (required)
 
Returns:
diff --git a/docs/dyn/blogger.v2.comments.html b/docs/dyn/blogger.v2.comments.html index aa710e1..8da4aea 100644 --- a/docs/dyn/blogger.v2.comments.html +++ b/docs/dyn/blogger.v2.comments.html @@ -17,6 +17,10 @@
get = method(self, **kwargs)
Gets one comment by id.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  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)
@@ -53,10 +57,14 @@ Returns:
list = method(self, **kwargs)
Retrieves the comments for a blog, possibly filtered.
 
Args:
-  startDate: string, Earliest date of comment to fetch.
+  startDate: string, Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
+  pp: string, A parameter
  fetchBodies: boolean, Whether the body content of the comments is included.
+  trace: string, A parameter
  pageToken: string, Continuation token if request is paged.
  maxResults: integer, Maximum number of comments to include in the result.
+  strict: string, A parameter
+  userip: string, A parameter
  postId: string, ID of the post to fetch posts from. (required)
  blogId: string, ID of the blog to fetch comments from. (required)
 
diff --git a/docs/dyn/blogger.v2.pages.html b/docs/dyn/blogger.v2.pages.html index 1d84614..d246f67 100644 --- a/docs/dyn/blogger.v2.pages.html +++ b/docs/dyn/blogger.v2.pages.html @@ -17,7 +17,11 @@
get = method(self, **kwargs)
Gets one blog page by id.
 
Args:
+  pp: string, A parameter
  pageId: string, The ID of the page to get. (required)
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  blogId: string, ID of the blog containing the page. (required)
 
Returns:
@@ -48,6 +52,10 @@ Returns:
list = method(self, **kwargs)
Retrieves pages for a blog, possibly filtered.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  fetchBodies: boolean, Whether to retrieve the Page bodies.
  blogId: string, ID of the blog to fetch pages from. (required)
 
diff --git a/docs/dyn/blogger.v2.posts.html b/docs/dyn/blogger.v2.posts.html index 7d05ffe..a750205 100644 --- a/docs/dyn/blogger.v2.posts.html +++ b/docs/dyn/blogger.v2.posts.html @@ -17,6 +17,10 @@
get = method(self, **kwargs)
Get a post by id.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  postId: string, The ID of the post (required)
  blogId: string, ID of the blog to fetch the post from. (required)
 
@@ -55,9 +59,13 @@ Returns:
list = method(self, **kwargs)
Retrieves a list of posts, possibly filtered.
 
Args:
-  startDate: string, Earliest post date to fetch.
+  startDate: string, Earliest post date to fetch, a date-time with RFC 3339 formatting.
+  pp: string, A parameter
+  trace: string, A parameter
  pageToken: string, Continuation token if the request is paged.
  maxResults: integer, Maximum number of posts to fetch.
+  strict: string, A parameter
+  userip: string, A parameter
  fetchBodies: boolean, Whether the body content of posts is included.
  blogId: string, ID of the blog to fetch posts from. (required)
 
diff --git a/docs/dyn/blogger.v2.users.blogs.html b/docs/dyn/blogger.v2.users.blogs.html index 88034f2..b8a4f8d 100644 --- a/docs/dyn/blogger.v2.users.blogs.html +++ b/docs/dyn/blogger.v2.users.blogs.html @@ -17,7 +17,11 @@
list = method(self, **kwargs)
Retrieves a list of blogs, possibly filtered.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  userId: string, ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/blogger.v2.users.html b/docs/dyn/blogger.v2.users.html index 2258009..cd4c362 100644 --- a/docs/dyn/blogger.v2.users.html +++ b/docs/dyn/blogger.v2.users.html @@ -19,7 +19,11 @@
get = method(self, **kwargs)
Gets one user by id.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  userId: string, The ID of the user to get. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/books.v1.bookshelves.html b/docs/dyn/books.v1.bookshelves.html index 82889db..6efe9aa 100644 --- a/docs/dyn/books.v1.bookshelves.html +++ b/docs/dyn/books.v1.bookshelves.html @@ -17,10 +17,13 @@
get = method(self, **kwargs)
Retrieves metadata for a specific bookshelf for the specified user.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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)
+  userId: string, ID of user for whom to retrieve bookshelves. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -41,9 +44,12 @@ Returns:
list = method(self, **kwargs)
Retrieves a list of public bookshelves for the specified user.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/books.v1.bookshelves.volumes.html b/docs/dyn/books.v1.bookshelves.volumes.html index 75c0449..55e214f 100644 --- a/docs/dyn/books.v1.bookshelves.volumes.html +++ b/docs/dyn/books.v1.bookshelves.volumes.html @@ -17,12 +17,15 @@
list = method(self, **kwargs)
Retrieves volumes in a specific bookshelf for the specified user.
 
Args:
-  shelf: string, ID of bookshelf to retrieve volumes. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
+  shelf: string, ID of bookshelf to retrieve volumes. (required)
  showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.
  maxResults: integer, Maximum number of results to return
+  strict: string, A parameter
  startIndex: integer, Index of the first element to return (starts at 0)
-  country: string, ISO-3166-1 code to override the IP-based location.
+  userip: string, A parameter
  userId: string, ID of user for whom to retrieve bookshelf volumes. (required)
 
Returns:
@@ -52,6 +55,7 @@ Returns:
            "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.)
+          "viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
          "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.)
            "isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
@@ -86,18 +90,8 @@ Returns:
        },
        "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)
+          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "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.
@@ -116,27 +110,24 @@ Returns:
            "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.
          },
+          "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.
+          },
+          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
        },
        "volumeInfo": { # General volume information.
+          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
-          "pageCount": 42, # Total number of pages.
-          "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).
-          },
-          "title": "A String", # Volume title. (In LITE projection.)
-          "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.
-            },
-          ],
-          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (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.)
-          "publishedDate": "A String", # Date of publication. (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)
@@ -145,21 +136,33 @@ Returns:
            "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. (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",
          ],
-          "publisher": "A String", # Publisher of this volume. (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.
-          "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.
-          "showReviewsLink": "A String", # URL to show reviews for this volume
-          "writeReviewLink": "A String", # URL to write a review for this volume
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
-          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
-          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "id": "A String", # Unique identifier for a volume. (In LITE projection.)
        "selfLink": "A String", # URL to this resource. (In LITE projection.)
diff --git a/docs/dyn/books.v1.html b/docs/dyn/books.v1.html index e019c9c..7d2c87f 100644 --- a/docs/dyn/books.v1.html +++ b/docs/dyn/books.v1.html @@ -22,8 +22,6 @@
mylibrary = methodResource(self)
A collection resource.
-
volumeAnnotations = methodResource(self)
A collection resource.
-
volumes = methodResource(self)
A collection resource.
diff --git a/docs/dyn/books.v1.layers.annotationData.html b/docs/dyn/books.v1.layers.annotationData.html index d95bb1a..dd0b02b 100644 --- a/docs/dyn/books.v1.layers.annotationData.html +++ b/docs/dyn/books.v1.layers.annotationData.html @@ -17,12 +17,18 @@
get = method(self, **kwargs)
Gets the annotation data.
 
Args:
+  annotationDataId: string, The ID of the annotation data to retrieve. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
  locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
  layerId: string, The ID for the layer to get the annotations. (required)
  volumeId: string, The volume to retrieve annotations for. (required)
-  annotationDataId: string, The ID of the annotation data to retrieve. (required)
-  country: string, ISO-3166-1 code to override the IP-based location.
+  strict: string, A parameter
+  contentVersion: string, The content version for the volume you are trying to retrieve. (required)
+  h: integer, The requested pixel height for any images. If height is provided width must also be provided.
+  userip: string, A parameter
+  w: integer, The requested pixel width for any images. If width is provided height must also be provided.
 
Returns:
  An object of the form
@@ -34,7 +40,41 @@ Returns:
    "volumeId": "A String", # The volume id for this data. *
    "encoded_data": "A String", # Base64 encoded data for this annotation data.
    "layerId": "A String", # The Layer id for this data. *
-    "data": "A String", # JSON enoded data for this annotation data.
+    "data": { # JSON encoded data for this annotation data.
+      "geo": {
+        "countryCode": "A String", # The country code of the location.
+        "zoom": 42, # The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels
+        "longitude": 3.14, # The longitude of the location.
+        "mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN
+        "latitude": 3.14, # The latitude of the location.
+        "boundary": [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.
+          [
+            {
+              "latitude": 42,
+              "longitude": 42,
+            },
+          ],
+        ],
+        "resolution": "A String", # The resolution of the location. Ex: POI_LEVEL
+        "viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle.
+          "lo": {
+            "latitude": 3.14,
+            "longitude": 3.14,
+          },
+          "hi": {
+            "latitude": 3.14,
+            "longitude": 3.14,
+          },
+        },
+        "cachePolicy": "A String", # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER
+      },
+      "common": {
+        "lang": "A String", # The language of the information url and description.
+        "previewImageUrl": "A String", # The URL for the preview image information.
+        "snippet": "A String", # The description for this location.
+        "snippetUrl": "A String", # The URL for information for this location. Ex: wikipedia link.
+      },
+    },
    "id": "A String", # Unique id for this annotation data.
    "selfLink": "A String", # URL for this resource. *
  }
@@ -42,22 +82,28 @@ Returns:
list = method(self, **kwargs)
Gets the annotation data for a volume and layer.
 
Args:
-  pageToken: string, The value of the nextToken from the previous page.
-  updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
  locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
-  layerId: string, The ID for the layer to get the annotation data. (required)
-  volumeId: string, The volume to retrieve annotation data for. (required)
-  maxResults: integer, Maximum number of results to return
+  pp: string, A parameter
+  trace: string, A parameter
+  pageToken: string, The value of the nextToken from the previous page.
+  updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
  source: string, String to identify the originator of this request.
  contentVersion: string, The content version for the requested volume. (required)
-  country: string, ISO-3166-1 code to override the IP-based location.
-  updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
+  layerId: string, The ID for the layer to get the annotation data. (required)
+  strict: string, A parameter
+  updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
+  volumeId: string, The volume to retrieve annotation data for. (required)
+  maxResults: integer, Maximum number of results to return
+  annotationDataId: string, The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. (repeated)
+  h: integer, The requested pixel height for any images. If height is provided width must also be provided.
+  w: integer, The requested pixel width for any images. If width is provided height must also be provided.
+  userip: string, A parameter
 
Returns:
  An object of the form
 
    {
-    "totalItems": 42, # The total number of volume annotations found.
+    "nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
    "items": [ # A list of Annotation Data.
      {
        "annotationType": "A String", # The type of annotation this data is for.
@@ -66,14 +112,59 @@ Returns:
        "volumeId": "A String", # The volume id for this data. *
        "encoded_data": "A String", # Base64 encoded data for this annotation data.
        "layerId": "A String", # The Layer id for this data. *
-        "data": "A String", # JSON enoded data for this annotation data.
+        "data": { # JSON encoded data for this annotation data.
+          "geo": {
+            "countryCode": "A String", # The country code of the location.
+            "zoom": 42, # The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels
+            "longitude": 3.14, # The longitude of the location.
+            "mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN
+            "latitude": 3.14, # The latitude of the location.
+            "boundary": [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.
+              [
+                {
+                  "latitude": 42,
+                  "longitude": 42,
+                },
+              ],
+            ],
+            "resolution": "A String", # The resolution of the location. Ex: POI_LEVEL
+            "viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle.
+              "lo": {
+                "latitude": 3.14,
+                "longitude": 3.14,
+              },
+              "hi": {
+                "latitude": 3.14,
+                "longitude": 3.14,
+              },
+            },
+            "cachePolicy": "A String", # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER
+          },
+          "common": {
+            "lang": "A String", # The language of the information url and description.
+            "previewImageUrl": "A String", # The URL for the preview image information.
+            "snippet": "A String", # The description for this location.
+            "snippetUrl": "A String", # The URL for information for this location. Ex: wikipedia link.
+          },
+        },
        "id": "A String", # Unique id for this annotation data.
        "selfLink": "A String", # URL for this resource. *
      },
    ],
    "kind": "books#annotationsdata", # Resource type
+    "totalItems": 42, # The total number of volume annotations found.
  }
+
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
+ 
+Args:
+  previous_request: The request for the previous page.
+  previous_response: The response from the request for the previous page.
+ 
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
Data descriptors defined here:
__dict__
diff --git a/docs/dyn/books.v1.layers.html b/docs/dyn/books.v1.layers.html index 051123d..940bcdb 100644 --- a/docs/dyn/books.v1.layers.html +++ b/docs/dyn/books.v1.layers.html @@ -19,8 +19,13 @@
get = method(self, **kwargs)
Gets the layer summary for a volume.
 
Args:
-  country: string, ISO-3166-1 code to override the IP-based location.
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
+  volumeId: string, The volume to retrieve layers for. (required)
+  strict: string, A parameter
+  contentVersion: string, The content version for the requested volume.
+  userip: string, A parameter
  summaryId: string, The ID for the layer to get the summary for. (required)
 
Returns:
@@ -32,24 +37,29 @@ Returns:
    "dataCount": 42, # The number of data items for this layer.
    "annotationsLink": "A String", # The link to get the annotations for this layer.
    "updated": "A String", # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
-    "annotationsDataLink": "A String", # Link to get data for this annotation.
-    "annotationTypes": [ # The list of annotation types contained for this layer. *
+    "volumeId": "A String", # The volume id this resource is for.
+    "id": "A String", # Unique id of this layer summary.
+    "annotationTypes": [ # The list of annotation types contained for this layer.
      "A String",
    ],
+    "contentVersion": "A String", # The content version this resource is for.
    "layerId": "A String", # The layer id for this summary.
-    "id": "A String", # Unique id of this layer summary.
+    "annotationsDataLink": "A String", # Link to get data for this annotation.
    "selfLink": "A String", # URL to this resource.
  }
list = method(self, **kwargs)
List the layer summaries for a volume.
 
Args:
-  source: string, String to identify the originator of this request.
-  country: string, ISO-3166-1 code to override the IP-based location.
+  pp: string, A parameter
+  trace: string, A parameter
+  pageToken: string, The value of the nextToken from the previous page.
  volumeId: string, The volume to retrieve layers for. (required)
  maxResults: integer, Maximum number of results to return
-  pageToken: string, The value of the nextToken from the previous page.
+  source: string, String to identify the originator of this request.
  contentVersion: string, The content version for the requested volume.
+  userip: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
@@ -63,18 +73,22 @@ Returns:
        "dataCount": 42, # The number of data items for this layer.
        "annotationsLink": "A String", # The link to get the annotations for this layer.
        "updated": "A String", # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
-        "annotationsDataLink": "A String", # Link to get data for this annotation.
-        "annotationTypes": [ # The list of annotation types contained for this layer. *
+        "volumeId": "A String", # The volume id this resource is for.
+        "id": "A String", # Unique id of this layer summary.
+        "annotationTypes": [ # The list of annotation types contained for this layer.
          "A String",
        ],
+        "contentVersion": "A String", # The content version this resource is for.
        "layerId": "A String", # The layer id for this summary.
-        "id": "A String", # Unique id of this layer summary.
+        "annotationsDataLink": "A String", # Link to get data for this annotation.
        "selfLink": "A String", # URL to this resource.
      },
    ],
    "kind": "books#layersummaries", # Resource type.
  }
+
volumeAnnotations = methodResource(self)
A collection resource.
+
Data descriptors defined here:
__dict__
diff --git a/docs/dyn/books.v1.layers.volumeAnnotations.html b/docs/dyn/books.v1.layers.volumeAnnotations.html new file mode 100644 index 0000000..4f1450b --- /dev/null +++ b/docs/dyn/books.v1.layers.volumeAnnotations.html @@ -0,0 +1,162 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
get = method(self, **kwargs)
Gets the volume annotation.
+ 
+Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  source: string, String to identify the originator of this request.
+  locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
+  annotationId: string, The ID of the volume annotation to retrieve. (required)
+  volumeId: string, The volume to retrieve annotations for. (required)
+  strict: string, A parameter
+  layerId: string, The ID for the layer to get the annotations. (required)
+  userip: string, A parameter
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "annotationType": "A String", # The type of annotation this is.
+    "kind": "books#volumeannotation", # Resource Type
+    "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
+    "deleted": True or False, # Indicates that this annotation is deleted.
+    "contentRanges": { # The content ranges to identify the selected text.
+      "contentVersion": "A String", # Content version applicable to ranges below.
+      "gbTextRange": { # Range in GB text format for this annotation for version above.
+        "startPosition": "A String", # The starting position for the range.
+        "endPosition": "A String", # The ending position for the range.
+        "startOffset": "A String", # The offset from the starting position.
+        "endOffset": "A String", # The offset from the ending position.
+      },
+      "cfiRange": { # Range in CFI format for this annotation for version above.
+        "startPosition": "A String", # The starting position for the range.
+        "endPosition": "A String", # The ending position for the range.
+        "startOffset": "A String", # The offset from the starting position.
+        "endOffset": "A String", # The offset from the ending position.
+      },
+      "gbImageRange": { # Range in GB image format for this annotation for version above.
+        "startPosition": "A String", # The starting position for the range.
+        "endPosition": "A String", # The ending position for the range.
+        "startOffset": "A String", # The offset from the starting position.
+        "endOffset": "A String", # The offset from the ending position.
+      },
+    },
+    "selectedText": "A String", # Excerpt from the volume.
+    "volumeId": "A String", # The Volume this annotation is for.
+    "annotationDataId": "A String", # The annotation data id for this volume annotation.
+    "annotationDataLink": "A String", # Link to get data for this annotation.
+    "pageIds": [ # Pages the annotation spans.
+      "A String",
+    ],
+    "layerId": "A String", # The Layer this annotation is for.
+    "data": "A String", # Data for this annotation.
+    "id": "A String", # Unique id of this volume annotation.
+    "selfLink": "A String", # URL to this resource.
+  }
+ +
list = method(self, **kwargs)
Gets the volume annotations for a volume and layer.
+ 
+Args:
+  endPosition: string, The end position to end retrieving data from.
+  locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
+  startOffset: string, The start offset to start retrieving data from.
+  pp: string, A parameter
+  trace: string, A parameter
+  pageToken: string, The value of the nextToken from the previous page.
+  updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
+  endOffset: string, The end offset to end retrieving data from.
+  showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
+  contentVersion: string, The content version for the requested volume. (required)
+  layerId: string, The ID for the layer to get the annotations. (required)
+  strict: string, A parameter
+  updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
+  volumeId: string, The volume to retrieve annotations for. (required)
+  maxResults: integer, Maximum number of results to return
+  startPosition: string, The start position to start retrieving data from.
+  source: string, String to identify the originator of this request.
+  userip: string, A parameter
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
+    "items": [ # A list of volume annotations.
+      {
+        "annotationType": "A String", # The type of annotation this is.
+        "kind": "books#volumeannotation", # Resource Type
+        "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
+        "deleted": True or False, # Indicates that this annotation is deleted.
+        "contentRanges": { # The content ranges to identify the selected text.
+          "contentVersion": "A String", # Content version applicable to ranges below.
+          "gbTextRange": { # Range in GB text format for this annotation for version above.
+            "startPosition": "A String", # The starting position for the range.
+            "endPosition": "A String", # The ending position for the range.
+            "startOffset": "A String", # The offset from the starting position.
+            "endOffset": "A String", # The offset from the ending position.
+          },
+          "cfiRange": { # Range in CFI format for this annotation for version above.
+            "startPosition": "A String", # The starting position for the range.
+            "endPosition": "A String", # The ending position for the range.
+            "startOffset": "A String", # The offset from the starting position.
+            "endOffset": "A String", # The offset from the ending position.
+          },
+          "gbImageRange": { # Range in GB image format for this annotation for version above.
+            "startPosition": "A String", # The starting position for the range.
+            "endPosition": "A String", # The ending position for the range.
+            "startOffset": "A String", # The offset from the starting position.
+            "endOffset": "A String", # The offset from the ending position.
+          },
+        },
+        "selectedText": "A String", # Excerpt from the volume.
+        "volumeId": "A String", # The Volume this annotation is for.
+        "annotationDataId": "A String", # The annotation data id for this volume annotation.
+        "annotationDataLink": "A String", # Link to get data for this annotation.
+        "pageIds": [ # Pages the annotation spans.
+          "A String",
+        ],
+        "layerId": "A String", # The Layer this annotation is for.
+        "data": "A String", # Data for this annotation.
+        "id": "A String", # Unique id of this volume annotation.
+        "selfLink": "A String", # URL to this resource.
+      },
+    ],
+    "kind": "books#volumeannotations", # Resource type
+    "totalItems": 42, # The total number of volume annotations found.
+  }
+ +
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
+ 
+Args:
+  previous_request: The request for the previous page.
+  previous_response: The response from the request for the previous page.
+ 
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/books.v1.myconfig.html b/docs/dyn/books.v1.myconfig.html index d460bef..0ccd5c4 100644 --- a/docs/dyn/books.v1.myconfig.html +++ b/docs/dyn/books.v1.myconfig.html @@ -17,11 +17,14 @@

releaseDownloadAccess = method(self, **kwargs)
Release downloaded content access restriction.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
  locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
-  country: string, ISO-3166-1 code to override the IP-based location.
  cpksver: string, The device/version ID from which to release the restriction. (required)
+  strict: string, A parameter
  volumeIds: string, The volume(s) to release restrictions for. (required) (repeated)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -50,11 +53,14 @@ Returns:
 
Args:
  nonce: string, The client nonce value. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request. (required)
  locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
-  country: string, ISO-3166-1 code to override the IP-based location.
  cpksver: string, The device/version ID from which to request the restrictions. (required)
  volumeId: string, The volume to request concurrent/download restrictions for. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -94,12 +100,15 @@ Returns:
 
Args:
  nonce: string, The client nonce value. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request. (required)
  locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
-  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.
  cpksver: string, The device/version ID from which to release the restriction. (required)
+  strict: string, A parameter
  volumeIds: string, The volume(s) to request download restrictions for. (repeated)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -128,6 +137,7 @@ Returns:
            "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.)
+          "viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
          "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.)
            "isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
@@ -162,18 +172,8 @@ Returns:
        },
        "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)
+          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "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.
@@ -192,27 +192,24 @@ Returns:
            "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.
          },
+          "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.
+          },
+          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
        },
        "volumeInfo": { # General volume information.
+          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
-          "pageCount": 42, # Total number of pages.
-          "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).
-          },
-          "title": "A String", # Volume title. (In LITE projection.)
-          "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.
-            },
-          ],
-          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (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.)
-          "publishedDate": "A String", # Date of publication. (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)
@@ -221,21 +218,33 @@ Returns:
            "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. (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",
          ],
-          "publisher": "A String", # Publisher of this volume. (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.
-          "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.
-          "showReviewsLink": "A String", # URL to show reviews for this volume
-          "writeReviewLink": "A String", # URL to write a review for this volume
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
-          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
-          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "id": "A String", # Unique identifier for a volume. (In LITE projection.)
        "selfLink": "A String", # URL to this resource. (In LITE projection.)
diff --git a/docs/dyn/books.v1.mylibrary.annotations.html b/docs/dyn/books.v1.mylibrary.annotations.html index 70d0c79..43668b2 100644 --- a/docs/dyn/books.v1.mylibrary.annotations.html +++ b/docs/dyn/books.v1.mylibrary.annotations.html @@ -17,16 +17,22 @@
delete = method(self, **kwargs)
Deletes an annotation.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
-  country: string, ISO-3166-1 code to override the IP-based location.
-  annotationId: string, The ID for the annotation to delete. (required)
+  annotationId: string, The ID for the annotation to delete. (required)
+  strict: string, A parameter
+  userip: string, A parameter
get = method(self, **kwargs)
Gets an annotation by its ID.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
-  country: string, ISO-3166-1 code to override the IP-based location.
  annotationId: string, The ID for the annotation to retrieve. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -159,8 +165,11 @@ Args:
    "selfLink": "A String", # URL to this resource.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
-  country: string, ISO-3166-1 code to override the IP-based location.
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -230,6 +239,8 @@ Returns:
 
Args:
  pageToken: string, The value of the nextToken from the previous page.
+  pp: string, A parameter
+  trace: string, A parameter
  updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
  layerId: string, The layer ID to limit annotation by.
  volumeId: string, The volume to restrict annotations to.
@@ -238,8 +249,9 @@ Args:
  pageIds: string, The page ID(s) for the volume that is being queried. (repeated)
  contentVersion: string, The content version for the requested volume.
  source: string, String to identify the originator of this request.
-  country: string, ISO-3166-1 code to override the IP-based location.
  updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
+  userip: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
@@ -389,9 +401,12 @@ Args:
    "selfLink": "A String", # URL to this resource.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
-  country: string, ISO-3166-1 code to override the IP-based location.
  annotationId: string, The ID for the annotation to update. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/books.v1.mylibrary.bookshelves.html b/docs/dyn/books.v1.mylibrary.bookshelves.html index bbb8e5a..c7c6710 100644 --- a/docs/dyn/books.v1.mylibrary.bookshelves.html +++ b/docs/dyn/books.v1.mylibrary.bookshelves.html @@ -17,24 +17,33 @@
addVolume = method(self, **kwargs)
Adds a volume to a bookshelf.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
-  country: string, ISO-3166-1 code to override the IP-based location.
+  shelf: string, ID of bookshelf to which to add a volume. (required)
  volumeId: string, ID of volume to add. (required)
-  shelf: string, ID of bookshelf to which to add a volume. (required)
+  strict: string, A parameter
+  userip: string, A parameter
clearVolumes = method(self, **kwargs)
Clears all volumes from a bookshelf.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
  shelf: string, ID of bookshelf from which to remove a volume. (required)
-  country: string, ISO-3166-1 code to override the IP-based location.
+  strict: string, A parameter
+  userip: string, A parameter
get = method(self, **kwargs)
Retrieves metadata for a specific bookshelf belonging to the authenticated user.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -55,8 +64,11 @@ Returns:
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.
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -83,18 +95,24 @@ Returns:
 
Args:
  volumePosition: integer, Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.) (required)
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
-  country: string, ISO-3166-1 code to override the IP-based location.
+  shelf: string, ID of bookshelf with the volume. (required)
  volumeId: string, ID of volume to move. (required)
-  shelf: string, ID of bookshelf with the volume. (required)
+  strict: string, A parameter
+  userip: string, A parameter
removeVolume = method(self, **kwargs)
Removes a volume from a bookshelf.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
-  country: string, ISO-3166-1 code to override the IP-based location.
+  shelf: string, ID of bookshelf from which to remove a volume. (required)
  volumeId: string, ID of volume to remove. (required)
-  shelf: string, ID of bookshelf from which to remove a volume. (required)
+  strict: string, A parameter
+  userip: string, A parameter
volumes = methodResource(self)
A collection resource.
diff --git a/docs/dyn/books.v1.mylibrary.bookshelves.volumes.html b/docs/dyn/books.v1.mylibrary.bookshelves.volumes.html index 4b22a12..12e492b 100644 --- a/docs/dyn/books.v1.mylibrary.bookshelves.volumes.html +++ b/docs/dyn/books.v1.mylibrary.bookshelves.volumes.html @@ -17,6 +17,8 @@
list = method(self, **kwargs)
Gets volume information for volumes on a bookshelf.
 
Args:
+  q: string, Full-text search query string in this bookshelf.
+  pp: string, A parameter
  projection: string, Restrict information returned to a set of selected fields.
    Allowed values
      full - Includes all volume data.
@@ -24,10 +26,12 @@ Args:
  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)
+  maxResults: integer, Maximum number of results to return
+  strict: string, A parameter
+  userip: string, A parameter
  shelf: string, The bookshelf ID or name retrieve volumes for. (required)
+  trace: string, A parameter
 
Returns:
  An object of the form
@@ -56,6 +60,7 @@ Returns:
            "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.)
+          "viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
          "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.)
            "isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
@@ -90,18 +95,8 @@ Returns:
        },
        "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)
+          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "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.
@@ -120,27 +115,24 @@ Returns:
            "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.
          },
+          "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.
+          },
+          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
        },
        "volumeInfo": { # General volume information.
+          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
-          "pageCount": 42, # Total number of pages.
-          "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).
-          },
-          "title": "A String", # Volume title. (In LITE projection.)
-          "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.
-            },
-          ],
-          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (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.)
-          "publishedDate": "A String", # Date of publication. (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)
@@ -149,21 +141,33 @@ Returns:
            "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. (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",
          ],
-          "publisher": "A String", # Publisher of this volume. (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.
-          "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.
-          "showReviewsLink": "A String", # URL to show reviews for this volume
-          "writeReviewLink": "A String", # URL to write a review for this volume
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
-          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
-          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "id": "A String", # Unique identifier for a volume. (In LITE projection.)
        "selfLink": "A String", # URL to this resource. (In LITE projection.)
diff --git a/docs/dyn/books.v1.mylibrary.readingpositions.html b/docs/dyn/books.v1.mylibrary.readingpositions.html index ff0fa78..db60790 100644 --- a/docs/dyn/books.v1.mylibrary.readingpositions.html +++ b/docs/dyn/books.v1.mylibrary.readingpositions.html @@ -17,10 +17,13 @@
get = method(self, **kwargs)
Retrieves my reading position information for a volume.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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 for which to retrieve a reading position. (required)
+  strict: string, A parameter
  contentVersion: string, Volume content version for which this reading position is requested.
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -38,12 +41,15 @@ Returns:
setPosition = method(self, **kwargs)
Sets my reading position information for a volume.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  source: string, String to identify the originator of this request.
-  volumeId: string, ID of volume for which to update the reading position. (required)
-  contentVersion: string, Volume content version for which this reading position applies.
-  country: string, ISO-3166-1 code to override the IP-based location.
-  position: string, Position string for the new volume reading position. (required)
  timestamp: string, RFC 3339 UTC format timestamp associated with this reading position. (required)
+  volumeId: string, ID of volume for which to update the reading position. (required)
+  strict: string, A parameter
+  contentVersion: string, Volume content version for which this reading position applies.
+  userip: string, A parameter
+  position: string, Position string for the new volume reading position. (required)
  action: string, Action that caused this reading position to be set.
    Allowed values
      bookmark - User chose bookmark within volume.
diff --git a/docs/dyn/books.v1.volumes.associated.html b/docs/dyn/books.v1.volumes.associated.html new file mode 100644 index 0000000..9b7e53d --- /dev/null +++ b/docs/dyn/books.v1.volumes.associated.html @@ -0,0 +1,195 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
list = method(self, **kwargs)
Return a list of associated books.
+ 
+Args:
+  filter: string, Filter search results.
+    Allowed values
+      ebooks - All Google eBooks.
+      free-ebooks - Google eBook with full volume text viewability.
+      full - Public can view entire volume text.
+      paid-ebooks - Google eBook with a price.
+      partial - Public able to see parts of text.
+  pp: string, A parameter
+  projection: string, Restrict information returned to a set of selected fields.
+    Allowed values
+      full - Includes all volume data.
+      lite - Includes a subset of fields in volumeInfo and accessInfo.
+  source: string, String to identify the originator of this request.
+  volumeId: string, ID of the source volume. (required)
+  maxResults: integer, Maximum number of results to return.
+  strict: string, A parameter
+  startIndex: integer, Index of the first result to return (starts at 0)
+  userip: string, A parameter
+  trace: string, A parameter
+  association: string, Association type.
+    Allowed values
+      complementary - Books that are complementary for additional reading.
+ 
+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.).
+          "webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
+          "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.)
+          "viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
+          "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.)
+            "isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (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.)
+            "isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (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.)
+        },
+        "searchInfo": { # Search result information related to this volume.
+          "textSnippet": "A String", # A text snippet containing the search query.
+        },
+        "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.14, # 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.14, # 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)
+          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
+          "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).
+          "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.
+          },
+          "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.
+          },
+          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
+        },
+        "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. (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.14, # 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:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/books.v1.volumes.html b/docs/dyn/books.v1.volumes.html index 5eff518..a01904c 100644 --- a/docs/dyn/books.v1.volumes.html +++ b/docs/dyn/books.v1.volumes.html @@ -14,16 +14,22 @@ Methods defined here:

__init__(self)
+
associated = methodResource(self)
A collection resource.
+
get = method(self, **kwargs)
Gets volume information for a single volume.
 
Args:
+  pp: string, A parameter
  projection: string, Restrict information returned to a set of selected fields.
    Allowed values
      full - Includes all volume data.
      lite - Includes a subset of fields in volumeInfo and accessInfo.
+  trace: string, A parameter
  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)
+  strict: string, A parameter
+  userip: string, A parameter
  partner: string, Brand results for partner ID.
 
Returns:
@@ -50,6 +56,7 @@ Returns:
        "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.)
+      "viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
      "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.)
        "isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
@@ -84,18 +91,8 @@ Returns:
    },
    "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)
+      "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
      "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.
@@ -114,27 +111,24 @@ Returns:
        "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.
      },
+      "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.
+      },
+      "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
    },
    "volumeInfo": { # General volume information.
+      "publisher": "A String", # Publisher of this volume. (In LITE projection.)
      "subtitle": "A String", # Volume subtitle. (In LITE projection.)
-      "pageCount": 42, # Total number of pages.
-      "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).
-      },
-      "title": "A String", # Volume title. (In LITE projection.)
-      "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.
-        },
-      ],
-      "canonicalVolumeLink": "A String", # Canonical URL for a volume. (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.)
-      "publishedDate": "A String", # Date of publication. (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)
@@ -143,21 +137,33 @@ Returns:
        "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. (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",
      ],
-      "publisher": "A String", # Publisher of this volume. (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.
-      "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.
-      "showReviewsLink": "A String", # URL to show reviews for this volume
-      "writeReviewLink": "A String", # URL to write a review for this volume
      "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
-      "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
-      "ratingsCount": 42, # The number of review ratings for this volume.
    },
    "id": "A String", # Unique identifier for a volume. (In LITE projection.)
    "selfLink": "A String", # URL to this resource. (In LITE projection.)
@@ -170,6 +176,32 @@ Args:
    Allowed values
      newest - Most recently published.
      relevance - Relevance to search terms.
+  projection: string, Restrict information returned to a set of selected fields.
+    Allowed values
+      full - Includes all volume data.
+      lite - Includes a subset of fields in volumeInfo and accessInfo.
+  showPreorders: boolean, Set to true to show books available for preorder. Defaults to false.
+  download: string, Restrict to volumes by download availability.
+    Allowed values
+      epub - All volumes with epub.
+  startIndex: integer, Index of the first result to return (starts at 0)
+  partner: string, Restrict and brand results for partner ID.
+  q: string, Full-text search query string. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  source: string, String to identify the originator of this request.
+  strict: string, A parameter
+  maxResults: integer, Maximum number of results to return.
+  libraryRestrict: string, Restrict search to this user's library.
+    Allowed values
+      my-library - Restrict to the user's library, any shelf.
+      no-restrict - Do not restrict based on user's library.
+  langRestrict: string, Restrict results to books with this language code.
+  printType: string, Restrict to books or magazines.
+    Allowed values
+      all - All volume content types.
+      books - Just books.
+      magazines - Just magazines.
  filter: string, Filter search results.
    Allowed values
      ebooks - All Google eBooks.
@@ -177,30 +209,7 @@ Args:
      full - Public can view entire volume text.
      paid-ebooks - Google eBook with a price.
      partial - Public able to see parts of text.
-  projection: string, Restrict information returned to a set of selected fields.
-    Allowed values
-      full - Includes all volume data.
-      lite - Includes a subset of fields in volumeInfo and accessInfo.
-  libraryRestrict: string, Restrict search to this user's library.
-    Allowed values
-      my-library - Restrict to the user's library, any shelf.
-      no-restrict - Do not restrict based on user's library.
-  source: string, String to identify the originator of this request.
-  langRestrict: string, Restrict results to books with this language code.
-  country: string, ISO-3166-1 code to override the IP-based location.
-  printType: string, Restrict to books or magazines.
-    Allowed values
-      all - All volume content types.
-      books - Just books.
-      magazines - Just magazines.
-  startIndex: integer, Index of the first result to return (starts at 0)
-  maxResults: integer, Maximum number of results to return.
-  q: string, Full-text search query string. (required)
-  partner: string, Restrict and brand results for partner ID.
-  download: string, Restrict to volumes by download availability.
-    Allowed values
-      epub - All volumes with epub.
-  showPreorders: boolean, Set to true to show books available for preorder. Defaults to false.
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -229,6 +238,7 @@ Returns:
            "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.)
+          "viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
          "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.)
            "isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
@@ -263,18 +273,8 @@ Returns:
        },
        "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)
+          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
          "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.
@@ -293,27 +293,24 @@ Returns:
            "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.
          },
+          "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.
+          },
+          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
        },
        "volumeInfo": { # General volume information.
+          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
-          "pageCount": 42, # Total number of pages.
-          "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).
-          },
-          "title": "A String", # Volume title. (In LITE projection.)
-          "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.
-            },
-          ],
-          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (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.)
-          "publishedDate": "A String", # Date of publication. (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)
@@ -322,21 +319,33 @@ Returns:
            "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. (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",
          ],
-          "publisher": "A String", # Publisher of this volume. (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.
-          "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.
-          "showReviewsLink": "A String", # URL to show reviews for this volume
-          "writeReviewLink": "A String", # URL to write a review for this volume
          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
-          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
-          "ratingsCount": 42, # The number of review ratings for this volume.
        },
        "id": "A String", # Unique identifier for a volume. (In LITE projection.)
        "selfLink": "A String", # URL to this resource. (In LITE projection.)
diff --git a/docs/dyn/calendar.v3.acl.html b/docs/dyn/calendar.v3.acl.html index ebfe1a3..f9fe4fd 100644 --- a/docs/dyn/calendar.v3.acl.html +++ b/docs/dyn/calendar.v3.acl.html @@ -17,14 +17,22 @@
delete = method(self, **kwargs)
Deletes an access control rule.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  ruleId: string, ACL rule identifier. (required)
-  calendarId: string, Calendar identifier. (required)
+  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
+  strict: string, A parameter
get = method(self, **kwargs)
Returns an access control rule.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  ruleId: string, ACL rule identifier. (required)
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
@@ -75,7 +83,11 @@ Args:
    "id": "A String", # Identifier of the ACL rule.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -103,7 +115,11 @@ Returns:
list = method(self, **kwargs)
Returns the rules in the access control list for the calendar.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -161,8 +177,12 @@ Args:
    "id": "A String", # Identifier of the ACL rule.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  ruleId: string, ACL rule identifier. (required)
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
@@ -213,8 +233,12 @@ Args:
    "id": "A String", # Identifier of the ACL rule.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  ruleId: string, ACL rule identifier. (required)
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/calendar.v3.calendarList.html b/docs/dyn/calendar.v3.calendarList.html index cd7d858..fdf538e 100644 --- a/docs/dyn/calendar.v3.calendarList.html +++ b/docs/dyn/calendar.v3.calendarList.html @@ -17,12 +17,20 @@
delete = method(self, **kwargs)
Deletes an entry on the user's calendar list.
 
Args:
-  calendarId: string, Calendar identifier. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
get = method(self, **kwargs)
Returns an entry on the user's calendar list.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -89,6 +97,10 @@ Args:
    "id": "A String", # Identifier of the calendar.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -124,6 +136,8 @@ Returns:
list = method(self, **kwargs)
Returns entries on the user's calendar list.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  minAccessRole: string, The minimum access role for the user in the returned entires. Optional. The default is no restriction.
    Allowed values
      freeBusyReader - The user can read free/busy information.
@@ -133,6 +147,8 @@ Args:
  maxResults: integer, Maximum number of entries returned on one result page. Optional.
  pageToken: string, Token specifying which result page to return. Optional.
  showHidden: boolean, Whether to show hidden entries. Optional. The default is False.
+  userip: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
@@ -216,7 +232,11 @@ Args:
    "id": "A String", # Identifier of the calendar.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -283,7 +303,11 @@ Args:
    "id": "A String", # Identifier of the calendar.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/calendar.v3.calendars.html b/docs/dyn/calendar.v3.calendars.html index 226c929..71ccb79 100644 --- a/docs/dyn/calendar.v3.calendars.html +++ b/docs/dyn/calendar.v3.calendars.html @@ -17,17 +17,29 @@
clear = method(self, **kwargs)
Clears a primary calendar. This operation deletes all data associated with the primary calendar of an account and cannot be undone.
 
Args:
-  calendarId: string, Calendar identifier. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
delete = method(self, **kwargs)
Deletes a secondary calendar.
 
Args:
-  calendarId: string, Calendar identifier. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
get = method(self, **kwargs)
Returns metadata for a calendar.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -58,6 +70,10 @@ Args:
    "id": "A String", # Identifier of the calendar.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -88,7 +104,11 @@ Args:
    "id": "A String", # Identifier of the calendar.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -119,7 +139,11 @@ Args:
    "id": "A String", # Identifier of the calendar.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/calendar.v3.colors.html b/docs/dyn/calendar.v3.colors.html index 7e7c652..cb373d7 100644 --- a/docs/dyn/calendar.v3.colors.html +++ b/docs/dyn/calendar.v3.colors.html @@ -17,6 +17,10 @@
get = method(self, **kwargs)
Returns the color definitions for calendars and events.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/calendar.v3.events.html b/docs/dyn/calendar.v3.events.html index 5bb1a2d..bc84745 100644 --- a/docs/dyn/calendar.v3.events.html +++ b/docs/dyn/calendar.v3.events.html @@ -18,14 +18,22 @@  
Args:
  eventId: string, Event identifier. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  sendNotifications: boolean, Whether to send notifications about the deletion of the event. Optional. The default is False.
-  calendarId: string, Calendar identifier. (required)
+  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
+  strict: string, A parameter
get = method(self, **kwargs)
Returns an event.
 
Args:
  eventId: string, Event identifier. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
  timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
  maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
 
@@ -34,10 +42,12 @@ Returns:
 
    {
      "creator": { # The creator of the event. Read-only.
+        "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The creator's name, if available.
        "email": "A String", # The creator's email address, if available.
      },
      "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+        "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The organizer's name, if available.
        "email": "A String", # The organizer's email address, if available.
      },
@@ -148,10 +158,12 @@ Args:
 
{
    "creator": { # The creator of the event. Read-only.
+      "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
      "displayName": "A String", # The creator's name, if available.
      "email": "A String", # The creator's email address, if available.
    },
    "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+      "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
      "displayName": "A String", # The organizer's name, if available.
      "email": "A String", # The organizer's email address, if available.
    },
@@ -254,17 +266,23 @@ Args:
    "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
 
    {
      "creator": { # The creator of the event. Read-only.
+        "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The creator's name, if available.
        "email": "A String", # The creator's email address, if available.
      },
      "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+        "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The organizer's name, if available.
        "email": "A String", # The organizer's email address, if available.
      },
@@ -375,10 +393,12 @@ Args:
 
{
    "creator": { # The creator of the event. Read-only.
+      "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
      "displayName": "A String", # The creator's name, if available.
      "email": "A String", # The creator's email address, if available.
    },
    "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+      "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
      "displayName": "A String", # The organizer's name, if available.
      "email": "A String", # The organizer's email address, if available.
    },
@@ -481,18 +501,24 @@ Args:
    "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  sendNotifications: boolean, Whether to send notifications about the creation of the new event. Optional. The default is False.
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
 
    {
      "creator": { # The creator of the event. Read-only.
+        "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The creator's name, if available.
        "email": "A String", # The creator's email address, if available.
      },
      "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+        "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The organizer's name, if available.
        "email": "A String", # The organizer's email address, if available.
      },
@@ -600,9 +626,13 @@ Returns:
Args:
  eventId: string, Recurring event identifier. (required)
  pageToken: string, Token specifying which result page to return. Optional.
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  maxResults: integer, Maximum number of events returned on one result page. Optional.
  showDeleted: boolean, Whether to include deleted events (with 'eventStatus' equals 'cancelled') in the result. Optional. The default is False.
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
  timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
  originalStart: string, The original start time of the instance in the result. Optional.
  maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
@@ -626,10 +656,12 @@ Returns:
    "items": [ # List of events on the calendar.
      {
          "creator": { # The creator of the event. Read-only.
+            "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
            "displayName": "A String", # The creator's name, if available.
            "email": "A String", # The creator's email address, if available.
          },
          "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+            "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
            "displayName": "A String", # The organizer's name, if available.
            "email": "A String", # The organizer's email address, if available.
          },
@@ -762,18 +794,22 @@ Args:
      startTime - Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter "singleEvents" is True)
      updated - Order by last modification time (ascending).
  showHiddenInvitations: boolean, Whether to include hidden invitations in the result. Optional. The default is False.
-  iCalUID: string, Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.
+  timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
+  pp: string, A parameter
+  trace: string, A parameter
+  pageToken: string, Token specifying which result page to return. Optional.
  updatedMin: string, Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
  singleEvents: boolean, Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
-  timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
-  maxResults: integer, Maximum number of events returned on one result page. Optional.
-  q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
  showDeleted: boolean, Whether to include deleted events (with 'eventStatus' equals 'cancelled') in the result. Optional. The default is False.
-  calendarId: string, Calendar identifier. (required)
-  timeMin: string, Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
-  pageToken: string, Token specifying which result page to return. Optional.
-  timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
+  strict: string, A parameter
  maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
+  iCalUID: string, Specifies iCalendar UID (iCalUID) of events to be included in the response. Optional.
+  maxResults: integer, Maximum number of events returned on one result page. Optional.
+  calendarId: string, Calendar identifier. (required)
+  timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
+  q: string, Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
+  userip: string, A parameter
+  timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
 
Returns:
  An object of the form
@@ -794,10 +830,12 @@ Returns:
    "items": [ # List of events on the calendar.
      {
          "creator": { # The creator of the event. Read-only.
+            "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
            "displayName": "A String", # The creator's name, if available.
            "email": "A String", # The creator's email address, if available.
          },
          "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+            "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
            "displayName": "A String", # The organizer's name, if available.
            "email": "A String", # The organizer's email address, if available.
          },
@@ -926,19 +964,25 @@ Returns:
 
Args:
  eventId: string, Event identifier. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  sendNotifications: boolean, Whether to send notifications about the change of the event's organizer. Optional. The default is False.
  destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)
  calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)
+  userip: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
 
    {
      "creator": { # The creator of the event. Read-only.
+        "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The creator's name, if available.
        "email": "A String", # The creator's email address, if available.
      },
      "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+        "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The organizer's name, if available.
        "email": "A String", # The organizer's email address, if available.
      },
@@ -1050,10 +1094,12 @@ Args:
 
{
    "creator": { # The creator of the event. Read-only.
+      "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
      "displayName": "A String", # The creator's name, if available.
      "email": "A String", # The creator's email address, if available.
    },
    "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+      "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
      "displayName": "A String", # The organizer's name, if available.
      "email": "A String", # The organizer's email address, if available.
    },
@@ -1156,18 +1202,24 @@ Args:
    "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
 
    {
      "creator": { # The creator of the event. Read-only.
+        "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The creator's name, if available.
        "email": "A String", # The creator's email address, if available.
      },
      "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+        "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The organizer's name, if available.
        "email": "A String", # The organizer's email address, if available.
      },
@@ -1273,19 +1325,25 @@ Returns:
quickAdd = method(self, **kwargs)
Creates an event based on a simple text string.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  sendNotifications: boolean, Whether to send notifications about the creation of the event. Optional. The default is False.
  text: string, The text describing the event to be created. (required)
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
 
    {
      "creator": { # The creator of the event. Read-only.
+        "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The creator's name, if available.
        "email": "A String", # The creator's email address, if available.
      },
      "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+        "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The organizer's name, if available.
        "email": "A String", # The organizer's email address, if available.
      },
@@ -1397,10 +1455,12 @@ Args:
 
{
    "creator": { # The creator of the event. Read-only.
+      "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
      "displayName": "A String", # The creator's name, if available.
      "email": "A String", # The creator's email address, if available.
    },
    "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+      "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
      "displayName": "A String", # The organizer's name, if available.
      "email": "A String", # The organizer's email address, if available.
    },
@@ -1503,18 +1563,24 @@ Args:
    "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
  calendarId: string, Calendar identifier. (required)
+  userip: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
 
    {
      "creator": { # The creator of the event. Read-only.
+        "self": True or False, # Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The creator's name, if available.
        "email": "A String", # The creator's email address, if available.
      },
      "organizer": { # The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in 'attendees' with the 'organizer' field set to True. To change the organizer, use the "move" operation. Read-only, except when importing an event.
+        "self": True or False, # Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
        "displayName": "A String", # The organizer's name, if available.
        "email": "A String", # The organizer's email address, if available.
      },
diff --git a/docs/dyn/calendar.v3.freebusy.html b/docs/dyn/calendar.v3.freebusy.html index e7e409c..01c992e 100644 --- a/docs/dyn/calendar.v3.freebusy.html +++ b/docs/dyn/calendar.v3.freebusy.html @@ -33,6 +33,10 @@ Args:
    "timeZone": "A String", # Time zone used in the response. Optional. The default is UTC.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/calendar.v3.settings.html b/docs/dyn/calendar.v3.settings.html index e0c63e3..a70cb7c 100644 --- a/docs/dyn/calendar.v3.settings.html +++ b/docs/dyn/calendar.v3.settings.html @@ -17,7 +17,11 @@
get = method(self, **kwargs)
Returns a single user setting.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  setting: string, Name of the user setting. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -32,6 +36,10 @@ Returns:
list = method(self, **kwargs)
Returns all user settings for the authenticated user.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/customsearch.v1.cse.html b/docs/dyn/customsearch.v1.cse.html index 24282b4..432b48f 100644 --- a/docs/dyn/customsearch.v1.cse.html +++ b/docs/dyn/customsearch.v1.cse.html @@ -18,6 +18,7 @@  
Args:
  dateRestrict: string, Specifies all search results are from a time period
+  hl: string, Sets the user interface language.
  orTerms: string, Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms
  highRange: string, Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
  num: integer, Number of search results to return
@@ -34,10 +35,12 @@ Args:
    Allowed values
      0 - Turns off duplicate content filter.
      1 - Turns on duplicate content filter.
+  pp: string, A parameter
  gl: string, Geolocation of end user.
  searchType: string, Specifies the search type: image.
    Allowed values
      image - custom image search
+  strict: string, A parameter
  fileType: string, Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...
  start: integer, The index of the first result to return
  imgDominantColor: string, Returns images of a specific dominant color: yellow, green, teal, blue, purple, pink, white, gray, black and brown.
@@ -93,6 +96,7 @@ Args:
  cref: string, The URL of a linked custom search engine
  sort: string, The sort expression to apply to the results
  hq: string, Appends the extra query terms to the query.
+  trace: string, A parameter
  c2coff: string, Turns off the translation between zh-CN and zh-TW.
  googlehost: string, The local Google domain to use to perform the search.
  safe: string, Search safety level
@@ -101,7 +105,6 @@ Args:
      medium - Enables moderate safe search filtering.
      off - Disables safe search filtering.
  exactTerms: string, Identifies a phrase that all documents in the search results must contain
-  hl: string, Sets the user interface language.
  lowRange: string, Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
  imgSize: string, Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.
    Allowed values
@@ -122,6 +125,7 @@ Args:
  q: string, Query (required)
  linkSite: string, Specifies that all search results should contain a link to a particular URL
  cx: string, The custom search engine ID to scope this search query
+  userip: string, A parameter
  siteSearchFilter: string, Controls whether to include or exclude results from the site named in the as_sitesearch parameter
    Allowed values
      e - exclude
@@ -133,21 +137,23 @@ Returns:
    {
    "promotions": [
      {
-        "link": "A String",
+        "title": "A String",
        "displayLink": "A String",
+        "htmlTitle": "A String",
+        "link": "A String",
+        "bodyLines": [
+          {
+            "url": "A String",
+            "htmlTitle": "A String",
+            "link": "A String",
+            "title": "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",
diff --git a/docs/dyn/discovery.v1.apis.html b/docs/dyn/discovery.v1.apis.html index 79ed0c3..9acd60c 100644 --- a/docs/dyn/discovery.v1.apis.html +++ b/docs/dyn/discovery.v1.apis.html @@ -17,8 +17,12 @@
getRest = method(self, **kwargs)
Retrieve the description of a particular version of an api.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  api: string, The name of the API. (required)
+  strict: string, A parameter
  version: string, The version of the API. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -68,13 +72,17 @@ Returns:
list = method(self, **kwargs)
Retrieve the list of APIs supported at this endpoint.
 
Args:
+  pp: string, A parameter
  name: string, Only include APIs with the given name.
+  trace: string, A parameter
  preferred: boolean, Return only the preferred version of an API.
  label: string, Only include APIs with a matching label, such as 'graduated' or 'labs'.
    Allowed values
      deprecated - APIs that have been deprecated.
      graduated - Supported APIs that have graduated from labs.
      labs - APIs that are experimental
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/drive.v1.files.html b/docs/dyn/drive.v1.files.html new file mode 100644 index 0000000..1e8dd14 --- /dev/null +++ b/docs/dyn/drive.v1.files.html @@ -0,0 +1,389 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
get = method(self, **kwargs)
Gets a file's metadata by id.
+ 
+Args:
+  pp: string, A parameter
+  projection: string, Restrict information returned for simplicity and optimization.
+    Allowed values
+      BASIC - Includes only the basic metadata fields
+      FULL - Includes all metadata fields
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
+  updateViewedDate: boolean, Whether to update the view date after successfully retrieving the file.
+  id: string, The id for the file in question. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "mimeType": "A String", # The mimetype of the file
+      "selfLink": "A String", # A link back to this file.
+      "kind": "drive#file", # The type of file. This is always drive#file
+      "description": "A String", # A short description of the file
+      "title": "A String", # The title of this file.
+      "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp).
+      "labels": { # Labels for the file.
+        "hidden": True or False, # Whether this file is hidden from the user
+        "starred": True or False, # Whether this file is starred by the user.
+        "trashed": True or False, # Whether this file has been trashed.
+      },
+      "indexableText": { # Indexable text attributes for the file (can only be written)
+        "text": "A String", # The text to be indexed for this file
+      },
+      "parentsCollection": [ # Collection of parent folders which contain this file.
+          # On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.
+        {
+          "parentLink": "A String", # A link to get the metadata for this parent
+          "id": "A String", # The id of this parent
+        },
+      ],
+      "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
+      "userPermission": { # The permissions for the authenticated user on this file.
+        "type": "A String", # The type of permission (For example: user, group etc).
+        "kind": "drive#permission", # The kind of this permission. This is always drive#permission
+        "etag": "A String", # An etag for this permission.
+        "role": "A String", # The role that this permission describes. (For example: reader, writer, owner)
+        "additionalRoles": [ # Any additional roles that this permission describes.
+          "A String",
+        ],
+      },
+      "etag": "A String", # ETag of the file.
+      "fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
+      "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
+      "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.
+      "lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted RFC 3339 timestamp).
+      "id": "A String", # The id of the file.
+      "md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
+      "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp).
+    }
+ +
insert = method(self, **kwargs)
Inserts a file, and any settable metadata or blob content sent with the request.
+ 
+Args:
+  body: object, The request body.
+    The object takes the form of:
+ 
+{
+    "mimeType": "A String", # The mimetype of the file
+    "selfLink": "A String", # A link back to this file.
+    "kind": "drive#file", # The type of file. This is always drive#file
+    "description": "A String", # A short description of the file
+    "title": "A String", # The title of this file.
+    "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp).
+    "labels": { # Labels for the file.
+      "hidden": True or False, # Whether this file is hidden from the user
+      "starred": True or False, # Whether this file is starred by the user.
+      "trashed": True or False, # Whether this file has been trashed.
+    },
+    "indexableText": { # Indexable text attributes for the file (can only be written)
+      "text": "A String", # The text to be indexed for this file
+    },
+    "parentsCollection": [ # Collection of parent folders which contain this file.
+        # On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.
+      {
+        "parentLink": "A String", # A link to get the metadata for this parent
+        "id": "A String", # The id of this parent
+      },
+    ],
+    "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
+    "userPermission": { # The permissions for the authenticated user on this file.
+      "type": "A String", # The type of permission (For example: user, group etc).
+      "kind": "drive#permission", # The kind of this permission. This is always drive#permission
+      "etag": "A String", # An etag for this permission.
+      "role": "A String", # The role that this permission describes. (For example: reader, writer, owner)
+      "additionalRoles": [ # Any additional roles that this permission describes.
+        "A String",
+      ],
+    },
+    "etag": "A String", # ETag of the file.
+    "fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
+    "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
+    "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.
+    "lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted RFC 3339 timestamp).
+    "id": "A String", # The id of the file.
+    "md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
+    "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp).
+  }
+ 
+  media_body: string, The filename of the media request body.
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "mimeType": "A String", # The mimetype of the file
+      "selfLink": "A String", # A link back to this file.
+      "kind": "drive#file", # The type of file. This is always drive#file
+      "description": "A String", # A short description of the file
+      "title": "A String", # The title of this file.
+      "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp).
+      "labels": { # Labels for the file.
+        "hidden": True or False, # Whether this file is hidden from the user
+        "starred": True or False, # Whether this file is starred by the user.
+        "trashed": True or False, # Whether this file has been trashed.
+      },
+      "indexableText": { # Indexable text attributes for the file (can only be written)
+        "text": "A String", # The text to be indexed for this file
+      },
+      "parentsCollection": [ # Collection of parent folders which contain this file.
+          # On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.
+        {
+          "parentLink": "A String", # A link to get the metadata for this parent
+          "id": "A String", # The id of this parent
+        },
+      ],
+      "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
+      "userPermission": { # The permissions for the authenticated user on this file.
+        "type": "A String", # The type of permission (For example: user, group etc).
+        "kind": "drive#permission", # The kind of this permission. This is always drive#permission
+        "etag": "A String", # An etag for this permission.
+        "role": "A String", # The role that this permission describes. (For example: reader, writer, owner)
+        "additionalRoles": [ # Any additional roles that this permission describes.
+          "A String",
+        ],
+      },
+      "etag": "A String", # ETag of the file.
+      "fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
+      "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
+      "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.
+      "lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted RFC 3339 timestamp).
+      "id": "A String", # The id of the file.
+      "md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
+      "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp).
+    }
+ +
patch = method(self, **kwargs)
Updates file metadata and/or content. This method supports patch semantics.
+ 
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "mimeType": "A String", # The mimetype of the file
+    "selfLink": "A String", # A link back to this file.
+    "kind": "drive#file", # The type of file. This is always drive#file
+    "description": "A String", # A short description of the file
+    "title": "A String", # The title of this file.
+    "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp).
+    "labels": { # Labels for the file.
+      "hidden": True or False, # Whether this file is hidden from the user
+      "starred": True or False, # Whether this file is starred by the user.
+      "trashed": True or False, # Whether this file has been trashed.
+    },
+    "indexableText": { # Indexable text attributes for the file (can only be written)
+      "text": "A String", # The text to be indexed for this file
+    },
+    "parentsCollection": [ # Collection of parent folders which contain this file.
+        # On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.
+      {
+        "parentLink": "A String", # A link to get the metadata for this parent
+        "id": "A String", # The id of this parent
+      },
+    ],
+    "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
+    "userPermission": { # The permissions for the authenticated user on this file.
+      "type": "A String", # The type of permission (For example: user, group etc).
+      "kind": "drive#permission", # The kind of this permission. This is always drive#permission
+      "etag": "A String", # An etag for this permission.
+      "role": "A String", # The role that this permission describes. (For example: reader, writer, owner)
+      "additionalRoles": [ # Any additional roles that this permission describes.
+        "A String",
+      ],
+    },
+    "etag": "A String", # ETag of the file.
+    "fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
+    "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
+    "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.
+    "lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted RFC 3339 timestamp).
+    "id": "A String", # The id of the file.
+    "md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
+    "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp).
+  }
+ 
+  pp: string, A parameter
+  trace: string, A parameter
+  newRevision: boolean, Whether a blob upload should create a new revision. If not set or false, the blob data in the current head revision will be replaced.
+  strict: string, A parameter
+  userip: string, A parameter
+  updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
+  updateModifiedDate: boolean, Controls updating the modified date of the file. If true, the modified date will be updated to the current time, regardless of whether other changes are being made. If false, the modified date will only be updated to the current time if other changes are also being made (changing the title, for example).
+  id: string, The id for the file in question. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "mimeType": "A String", # The mimetype of the file
+      "selfLink": "A String", # A link back to this file.
+      "kind": "drive#file", # The type of file. This is always drive#file
+      "description": "A String", # A short description of the file
+      "title": "A String", # The title of this file.
+      "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp).
+      "labels": { # Labels for the file.
+        "hidden": True or False, # Whether this file is hidden from the user
+        "starred": True or False, # Whether this file is starred by the user.
+        "trashed": True or False, # Whether this file has been trashed.
+      },
+      "indexableText": { # Indexable text attributes for the file (can only be written)
+        "text": "A String", # The text to be indexed for this file
+      },
+      "parentsCollection": [ # Collection of parent folders which contain this file.
+          # On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.
+        {
+          "parentLink": "A String", # A link to get the metadata for this parent
+          "id": "A String", # The id of this parent
+        },
+      ],
+      "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
+      "userPermission": { # The permissions for the authenticated user on this file.
+        "type": "A String", # The type of permission (For example: user, group etc).
+        "kind": "drive#permission", # The kind of this permission. This is always drive#permission
+        "etag": "A String", # An etag for this permission.
+        "role": "A String", # The role that this permission describes. (For example: reader, writer, owner)
+        "additionalRoles": [ # Any additional roles that this permission describes.
+          "A String",
+        ],
+      },
+      "etag": "A String", # ETag of the file.
+      "fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
+      "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
+      "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.
+      "lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted RFC 3339 timestamp).
+      "id": "A String", # The id of the file.
+      "md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
+      "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp).
+    }
+ +
update = method(self, **kwargs)
Updates file metadata and/or content
+ 
+Args:
+  body: object, The request body.
+    The object takes the form of:
+ 
+{
+    "mimeType": "A String", # The mimetype of the file
+    "selfLink": "A String", # A link back to this file.
+    "kind": "drive#file", # The type of file. This is always drive#file
+    "description": "A String", # A short description of the file
+    "title": "A String", # The title of this file.
+    "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp).
+    "labels": { # Labels for the file.
+      "hidden": True or False, # Whether this file is hidden from the user
+      "starred": True or False, # Whether this file is starred by the user.
+      "trashed": True or False, # Whether this file has been trashed.
+    },
+    "indexableText": { # Indexable text attributes for the file (can only be written)
+      "text": "A String", # The text to be indexed for this file
+    },
+    "parentsCollection": [ # Collection of parent folders which contain this file.
+        # On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.
+      {
+        "parentLink": "A String", # A link to get the metadata for this parent
+        "id": "A String", # The id of this parent
+      },
+    ],
+    "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
+    "userPermission": { # The permissions for the authenticated user on this file.
+      "type": "A String", # The type of permission (For example: user, group etc).
+      "kind": "drive#permission", # The kind of this permission. This is always drive#permission
+      "etag": "A String", # An etag for this permission.
+      "role": "A String", # The role that this permission describes. (For example: reader, writer, owner)
+      "additionalRoles": [ # Any additional roles that this permission describes.
+        "A String",
+      ],
+    },
+    "etag": "A String", # ETag of the file.
+    "fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
+    "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
+    "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.
+    "lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted RFC 3339 timestamp).
+    "id": "A String", # The id of the file.
+    "md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
+    "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp).
+  }
+ 
+  media_body: string, The filename of the media request body.
+  pp: string, A parameter
+  trace: string, A parameter
+  newRevision: boolean, Whether a blob upload should create a new revision. If not set or false, the blob data in the current head revision will be replaced.
+  strict: string, A parameter
+  userip: string, A parameter
+  updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
+  updateModifiedDate: boolean, Controls updating the modified date of the file. If true, the modified date will be updated to the current time, regardless of whether other changes are being made. If false, the modified date will only be updated to the current time if other changes are also being made (changing the title, for example).
+  id: string, The id for the file in question. (required)
+ 
+Returns:
+  An object of the form
+ 
+    {
+      "mimeType": "A String", # The mimetype of the file
+      "selfLink": "A String", # A link back to this file.
+      "kind": "drive#file", # The type of file. This is always drive#file
+      "description": "A String", # A short description of the file
+      "title": "A String", # The title of this file.
+      "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp).
+      "labels": { # Labels for the file.
+        "hidden": True or False, # Whether this file is hidden from the user
+        "starred": True or False, # Whether this file is starred by the user.
+        "trashed": True or False, # Whether this file has been trashed.
+      },
+      "indexableText": { # Indexable text attributes for the file (can only be written)
+        "text": "A String", # The text to be indexed for this file
+      },
+      "parentsCollection": [ # Collection of parent folders which contain this file.
+          # On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.
+        {
+          "parentLink": "A String", # A link to get the metadata for this parent
+          "id": "A String", # The id of this parent
+        },
+      ],
+      "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
+      "userPermission": { # The permissions for the authenticated user on this file.
+        "type": "A String", # The type of permission (For example: user, group etc).
+        "kind": "drive#permission", # The kind of this permission. This is always drive#permission
+        "etag": "A String", # An etag for this permission.
+        "role": "A String", # The role that this permission describes. (For example: reader, writer, owner)
+        "additionalRoles": [ # Any additional roles that this permission describes.
+          "A String",
+        ],
+      },
+      "etag": "A String", # ETag of the file.
+      "fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
+      "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
+      "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.
+      "lastViewedDate": "A String", # Last time this file was viewed by anyone (formatted RFC 3339 timestamp).
+      "id": "A String", # The id of the file.
+      "md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
+      "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp).
+    }
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/drive.v1.html b/docs/dyn/drive.v1.html new file mode 100644 index 0000000..e7879c9 --- /dev/null +++ b/docs/dyn/drive.v1.html @@ -0,0 +1,28 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
files = methodResource(self)
A collection resource.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/freebase.v1.html b/docs/dyn/freebase.v1.html index 67876b6..00e9e69 100644 --- a/docs/dyn/freebase.v1.html +++ b/docs/dyn/freebase.v1.html @@ -17,8 +17,12 @@

image = method(self, **kwargs)
Returns the scaled/cropped image attached to a freebase node.
 
Args:
+  pp: string, A parameter
  maxwidth: integer, Maximum width in pixels for resulting image.
+  trace: string, A parameter
  maxheight: integer, Maximum height in pixels for resulting image.
+  strict: string, A parameter
+  userip: string, A parameter
  fallbackid: string, Use the image associated with this secondary id if no image is associated with the primary id.
  pad: boolean, A boolean specifying whether the resulting image should be padded up to the requested dimensions.
  mode: string, Method used to scale or crop image.
@@ -33,8 +37,9 @@ Args:
 
Args:
  lang: string, The language of the results - an id of a /type/lang object.
-  cursor: string, The mql cursor.
+  pp: string, A parameter
  indent: integer, How many spaces to indent the json.
+  trace: string, A parameter
  callback: string, JS method name for JSONP callbacks.
  uniqueness_failure: string, How MQL responds to uniqueness failures.
    Allowed values
@@ -42,8 +47,11 @@ Args:
      soft - Just return the first encountered object.
  dateline: string, The dateline that you get in a mqlwrite response to ensure consistent results.
  html_escape: boolean, Whether or not to escape entities.
+  cursor: string, The mql cursor.
  cost: boolean, Show the costs or not.
+  userip: string, A parameter
  query: string, An envelope containing a single MQL query. (required)
+  strict: string, A parameter
  as_of_time: string, Run the query as it would've been run at the specified point in time.
text = methodResource(self)
A collection resource.
diff --git a/docs/dyn/freebase.v1.text.html b/docs/dyn/freebase.v1.text.html index 1909ab8..4a8e575 100644 --- a/docs/dyn/freebase.v1.text.html +++ b/docs/dyn/freebase.v1.text.html @@ -17,12 +17,16 @@
get = method(self, **kwargs)
Returns blob attached to node at specified id as HTML
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  format: string, Sanitizing transformation.
    Allowed values
      html - Return valid, sanitized html.
      plain - Return plain text - strip html tags.
      raw - Return the entire content as-is.
+  strict: string, A parameter
  maxlength: integer, The max number of characters to return. Valid only for 'plain' format.
+  userip: string, A parameter
  id: string, The id of the item that you want data about (required) (repeated)
 
Returns:
diff --git a/docs/dyn/gan.v1beta1.advertisers.html b/docs/dyn/gan.v1beta1.advertisers.html index 5d33040..8b454b8 100644 --- a/docs/dyn/gan.v1beta1.advertisers.html +++ b/docs/dyn/gan.v1beta1.advertisers.html @@ -17,20 +17,24 @@
get = method(self, **kwargs)
Retrieves data about a single advertiser if that the requesting advertiser/publisher has access to it. Only publishers can lookup advertisers. Advertisers can request information about themselves by omitting the advertiserId query parameter.
 
Args:
-  roleId: string, The ID of the requesting advertiser or publisher. (required)
  advertiserId: string, The ID of the advertiser to look up. Optional.
+  pp: string, A parameter
+  trace: string, A parameter
+  roleId: string, The ID of the requesting advertiser or publisher. (required)
+  strict: string, A parameter
  role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
    Allowed values
      advertisers - The requester is requesting as an advertiser.
      publishers - The requester is requesting as a publisher.
+  userip: string, A parameter
 
Returns:
  An object of the form
 
    { # An AdvertiserResource.
    "category": "A String", # Category that this advertiser belongs to. A valid list of categories can be found here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581
-    "productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.
-    "kind": "gan#advertiser", # The kind for an advertiser. The kind for one entity.
+    "contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.
+    "kind": "gan#advertiser", # The kind for an advertiser.
    "siteUrl": "A String", # URL of the website this advertiser advertises from.
    "contactPhone": "A String", # Phone that this advertiser would like publishers to contact them with.
    "description": "A String", # Description of the website the advertiser advertises from.
@@ -45,11 +49,12 @@ Returns:
      "amount": 3.14, # The amount of money.
      "currencyCode": "A String", # The 3-letter code of the currency in question.
    },
-    "contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.
+    "allowPublisherCreatedLinks": True or False, # True if the advertiser allows publisher created links, otherwise false.
    "item": # Object with schema name: Advertiser # The requested advertiser.
    "joinDate": "A String", # Date that this advertiser was approved as a Google Affiliate Network advertiser.
    "logoUrl": "A String", # URL to the logo this advertiser uses on the Google Affiliate Network.
    "id": "A String", # The ID of this advertiser.
+    "productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.
    "name": "A String", # The name of this advertiser.
  }
@@ -63,16 +68,20 @@ Args:
      deactivated - Deactivated means either the advertiser has removed you from their program, or it could also mean that you chose to remove yourself from the advertiser's program.
      declined - An advertiser that did not approve your application.
      pending - An advertiser program that you've already applied to, but they haven't yet decided to approve or decline your application.
-  roleId: string, The ID of the requesting advertiser or publisher. (required)
-  minNinetyDayEpc: number, Filters out all advertisers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
-  advertiserCategory: string, Caret(^) delimted list of advertiser categories. Valid categories are defined here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581. Filters out all advertisers not in one of the given advertiser categories. Optional.
+  trace: string, A parameter
  pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
+  pp: string, A parameter
+  roleId: string, The ID of the requesting advertiser or publisher. (required)
+  advertiserCategory: string, Caret(^) delimted list of advertiser categories. Valid categories are defined here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581. Filters out all advertisers not in one of the given advertiser categories. Optional.
+  minNinetyDayEpc: number, Filters out all advertisers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
+  strict: string, A parameter
  role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
    Allowed values
      advertisers - The requester is requesting as an advertiser.
      publishers - The requester is requesting as a publisher.
  maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.
  minSevenDayEpc: number, Filters out all advertisers that have a seven day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
+  userip: string, A parameter
  minPayoutRank: integer, A value between 1 and 4, where 1 represents the quartile of advertisers with the lowest ranks and 4 represents the quartile of advertisers with the highest ranks. Filters out all advertisers with a lower rank than the given quartile. For example if a 2 was given only advertisers with a payout rank of 25 or higher would be included. Optional.
 
Returns:
@@ -83,8 +92,8 @@ Returns:
    "items": [ # The advertiser list.
      { # An AdvertiserResource.
        "category": "A String", # Category that this advertiser belongs to. A valid list of categories can be found here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581
-        "productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.
-        "kind": "gan#advertiser", # The kind for an advertiser. The kind for one entity.
+        "contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.
+        "kind": "gan#advertiser", # The kind for an advertiser.
        "siteUrl": "A String", # URL of the website this advertiser advertises from.
        "contactPhone": "A String", # Phone that this advertiser would like publishers to contact them with.
        "description": "A String", # Description of the website the advertiser advertises from.
@@ -99,11 +108,12 @@ Returns:
          "amount": 3.14, # The amount of money.
          "currencyCode": "A String", # The 3-letter code of the currency in question.
        },
-        "contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.
+        "allowPublisherCreatedLinks": True or False, # True if the advertiser allows publisher created links, otherwise false.
        "item": # Object with schema name: Advertiser # The requested advertiser.
        "joinDate": "A String", # Date that this advertiser was approved as a Google Affiliate Network advertiser.
        "logoUrl": "A String", # URL to the logo this advertiser uses on the Google Affiliate Network.
        "id": "A String", # The ID of this advertiser.
+        "productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.
        "name": "A String", # The name of this advertiser.
      },
    ],
diff --git a/docs/dyn/gan.v1beta1.ccOffers.html b/docs/dyn/gan.v1beta1.ccOffers.html index 6ec8e7e..76a5297 100644 --- a/docs/dyn/gan.v1beta1.ccOffers.html +++ b/docs/dyn/gan.v1beta1.ccOffers.html @@ -18,11 +18,15 @@  
Args:
  advertiser: string, The advertiser ID of a card issuer whose offers to include. Optional, may be repeated. (repeated)
+  pp: string, A parameter
  projection: string, The set of fields to return.
    Allowed values
-      full - Include all offer fields
-      summary - Include only the basic fields needed to display an offer. This is the default.
+      full - Include all offer fields. This is the default.
+      summary - Include only the basic fields needed to display an offer.
  publisher: string, The ID of the publisher in question. (required)
+  userip: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
@@ -66,7 +70,6 @@ Returns:
        "prohibitedCategories": [ # Categories in which the issuer does not wish the card to be displayed. A summary field.
          "A String",
        ],
-        "creditRatingDisplay": "A String", # Text describing the credit ratings required for recipients of this card, for example "Excellent/Good." A summary field.
        "fraudLiability": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
        "cashAdvanceTerms": "A String", # Text describing the terms for cash advances. A summary field.
        "landingPageUrl": "A String", # The link to the issuer's page for this card. A summary field.
@@ -82,6 +85,7 @@ Returns:
          },
        ],
        "extendedWarranty": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
+        "emergencyInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
        "firstYearAnnualFee": 3.14, # The annual fee for the first year, if different from the ongoing fee. Optional.
        "trackingUrl": "A String", # The link to ping to register a click on this offer. A summary field.
        "latePaymentFee": "A String", # Text describing how much a late payment will cost, eg "up to $35." A summary field.
@@ -101,6 +105,7 @@ Returns:
          "A String",
        ],
        "ageMinimum": 3.14, # The youngest a recipient of this card may be.
+        "balanceComputationMethod": "A String", # Text describing how the balance is computed. A summary field.
        "aprDisplay": "A String", # Text describing the purchase APR. A summary field.
        "additionalCardHolderFee": "A String", # Any extra fees levied on card holders.
        "variableRatesLastUpdated": "A String", # When variable rates were last updated.
@@ -108,7 +113,7 @@ Returns:
        "purchaseRateType": "A String", # Fixed or variable.
        "statementCopyFee": "A String", # Fee for requesting a copy of your statement.
        "rewardsHaveBlackoutDates": True or False, # For airline miles rewards, tells whether blackout dates apply to the miles.
-        "emergencyInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
+        "creditRatingDisplay": "A String", # Text describing the credit ratings required for recipients of this card, for example "Excellent/Good." A summary field.
        "flightAccidentInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
        "annualRewardMaximum": 3.14, # The largest number of units you may accumulate in a year.
        "balanceTransferTerms": "A String", # Text describing the terms for balance transfers. A summary field.
diff --git a/docs/dyn/gan.v1beta1.events.html b/docs/dyn/gan.v1beta1.events.html index f01361c..894a0a8 100644 --- a/docs/dyn/gan.v1beta1.events.html +++ b/docs/dyn/gan.v1beta1.events.html @@ -18,12 +18,23 @@  
Args:
  orderId: string, Caret(^) delimited list of order IDs. Filters out all events that do not reference one of the given order IDs. Optional.
+  chargeType: string, Filters out all charge events that are not of the given charge type. Valid values: 'other', 'slotting_fee', 'monthly_minimum', 'tier_bonus', 'credit', 'debit'. Optional.
+    Allowed values
+      credit - A credit increases the publisher's payout amount and decreases the advertiser's invoice amount.
+      debit - A debit reduces the publisher's payout and increases the advertiser's invoice amount.
+      monthly_minimum - A payment made to Google by an advertiser as a minimum monthly network fee.
+      other - Catch all. Default if unset
+      slotting_fee - A one time payment made from an advertiser to a publisher.
+      tier_bonus - A payment from an advertiser to a publisher for the publisher maintaining a high tier level
  linkId: string, Caret(^) delimited list of link IDs. Filters out all events that do not reference one of the given link IDs. Optional.
  advertiserId: string, Caret(^) delimited list of advertiser IDs. Filters out all events that do not reference one of the given advertiser IDs. Only used when under publishers role. Optional.
  sku: string, Caret(^) delimited list of SKUs. Filters out all events that do not reference one of the given SKU. Optional.
+  pp: string, A parameter
+  trace: string, A parameter
+  pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
  roleId: string, The ID of the requesting advertiser or publisher. (required)
  productCategory: string, Caret(^) delimited list of product categories. Filters out all events that do not reference a product in one of the given product categories. Optional.
-  pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
+  strict: string, A parameter
  role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
    Allowed values
      advertisers - The requester is requesting as an advertiser.
@@ -41,16 +52,9 @@ Args:
  modifyDateMax: string, Filters out all events modified later than given date. Optional. Defaults to 24 hours after modifyDateMin, if modifyDateMin is explicitly set.
  eventDateMin: string, Filters out all events earlier than given date. Optional. Defaults to 24 hours from current date/time.
  maxResults: integer, Max number of offers to return in this page. Optional. Defaults to 20.
-  chargeType: string, Filters out all charge events that are not of the given charge type. Valid values: 'other', 'slotting_fee', 'monthly_minimum', 'tier_bonus', 'credit', 'debit'. Optional.
-    Allowed values
-      credit - A credit increases the publisher's payout amount and decreases the advertiser's invoice amount.
-      debit - A debit reduces the publisher's payout and increases the advertiser's invoice amount.
-      monthly_minimum - A payment made to Google by an advertiser as a minimum monthly network fee.
-      other - Catch all. Default if unset
-      slotting_fee - A one time payment made from an advertiser to a publisher.
-      tier_bonus - A payment from an advertiser to a publisher for the publisher maintaining a high tier level
  eventDateMax: string, Filters out all events later than given date. Optional. Defaults to 24 hours after eventMin.
  memberId: string, Caret(^) delimited list of member IDs. Filters out all events that do not reference one of the given member IDs. Optional.
+  userip: string, A parameter
  publisherId: string, Caret(^) delimited list of publisher IDs. Filters out all events that do not reference one of the given publishers IDs. Only used when under advertiser role. Optional.
 
Returns:
diff --git a/docs/dyn/gan.v1beta1.html b/docs/dyn/gan.v1beta1.html index e4ce028..f1d4fe5 100644 --- a/docs/dyn/gan.v1beta1.html +++ b/docs/dyn/gan.v1beta1.html @@ -20,6 +20,8 @@
events = methodResource(self)
A collection resource.
+
links = methodResource(self)
A collection resource.
+
publishers = methodResource(self)
A collection resource.
diff --git a/docs/dyn/gan.v1beta1.links.html b/docs/dyn/gan.v1beta1.links.html new file mode 100644 index 0000000..a413ff6 --- /dev/null +++ b/docs/dyn/gan.v1beta1.links.html @@ -0,0 +1,244 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
get = method(self, **kwargs)
Retrieves data about a single link if the requesting advertiser/publisher has access to it. Advertisers can look up their own links. Publishers can look up visible links or links belonging to advertisers they are in a relationship with.
+ 
+Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  roleId: string, The ID of the requesting advertiser or publisher. (required)
+  strict: string, A parameter
+  role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
+    Allowed values
+      advertisers - The requester is requesting as an advertiser.
+      publishers - The requester is requesting as a publisher.
+  linkId: string, The ID of the link to look up. (required)
+  userip: string, A parameter
+ 
+Returns:
+  An object of the form
+ 
+    { # A LinkResource.
+      "startDate": "A String", # Date that this link becomes active.
+      "kind": "gan#link", # The kind for one entity.
+      "endDate": "A String", # Date that this link becomes inactive.
+      "description": "A String", # Description.
+      "name": "A String", # The logical name for this link.
+      "createDate": "A String", # Date that this link was created.
+      "imageAltText": "A String", # image alt text.
+      "id": "A String", # The ID of this link.
+      "advertiserId": "A String", # The advertiser id for the advertiser who owns this link.
+      "creativeType": "A String", # Creative Type.
+      "promotionType": "A String", # Promotion Type
+      "duration": "A String", # Duration
+      "authorship": "A String", # Authorship
+      "availability": "A String", # Availability.
+      "isActive": True or False, # Flag for if this link is active.
+      "destinationUrl": "A String", # The destination URL for the link.
+    }
+ +
insert = method(self, **kwargs)
Inserts a new link.
+ 
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{ # A LinkResource.
+    "startDate": "A String", # Date that this link becomes active.
+    "kind": "gan#link", # The kind for one entity.
+    "endDate": "A String", # Date that this link becomes inactive.
+    "description": "A String", # Description.
+    "name": "A String", # The logical name for this link.
+    "createDate": "A String", # Date that this link was created.
+    "imageAltText": "A String", # image alt text.
+    "id": "A String", # The ID of this link.
+    "advertiserId": "A String", # The advertiser id for the advertiser who owns this link.
+    "creativeType": "A String", # Creative Type.
+    "promotionType": "A String", # Promotion Type
+    "duration": "A String", # Duration
+    "authorship": "A String", # Authorship
+    "availability": "A String", # Availability.
+    "isActive": True or False, # Flag for if this link is active.
+    "destinationUrl": "A String", # The destination URL for the link.
+  }
+ 
+  pp: string, A parameter
+  trace: string, A parameter
+  roleId: string, The ID of the requesting advertiser or publisher. (required)
+  strict: string, A parameter
+  role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
+    Allowed values
+      advertisers - The requester is requesting as an advertiser.
+      publishers - The requester is requesting as a publisher.
+  userip: string, A parameter
+ 
+Returns:
+  An object of the form
+ 
+    { # A LinkResource.
+      "startDate": "A String", # Date that this link becomes active.
+      "kind": "gan#link", # The kind for one entity.
+      "endDate": "A String", # Date that this link becomes inactive.
+      "description": "A String", # Description.
+      "name": "A String", # The logical name for this link.
+      "createDate": "A String", # Date that this link was created.
+      "imageAltText": "A String", # image alt text.
+      "id": "A String", # The ID of this link.
+      "advertiserId": "A String", # The advertiser id for the advertiser who owns this link.
+      "creativeType": "A String", # Creative Type.
+      "promotionType": "A String", # Promotion Type
+      "duration": "A String", # Duration
+      "authorship": "A String", # Authorship
+      "availability": "A String", # Availability.
+      "isActive": True or False, # Flag for if this link is active.
+      "destinationUrl": "A String", # The destination URL for the link.
+    }
+ +
list = method(self, **kwargs)
Retrieves all links that match the query parameters.
+ 
+Args:
+  linkType: string, The type of the link.
+    Allowed values
+      banner - 
+      text - 
+  promotionType: string, The promotion type. (repeated)
+    Allowed values
+      buy_get - 
+      coupon - 
+      free_gift - 
+      free_gift_wrap - 
+      free_shipping - 
+      none - 
+      ongoing - 
+      percent_off - 
+      price_cut - 
+      product_promotion - 
+      sale - 
+      sweepstakes - 
+  advertiserId: string, Limits the resulting links to the ones belonging to the listed advertisers. (repeated)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  roleId: string, The ID of the requesting advertiser or publisher. (required)
+  pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
+  role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
+    Allowed values
+      advertisers - The requester is requesting as an advertiser.
+      publishers - The requester is requesting as a publisher.
+  relationshipStatus: string, The status of the relationship.
+    Allowed values
+      approved - 
+      available - 
+  maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.
+  advertiserCategory: string, The advertiser's primary vertical. (repeated)
+    Allowed values
+      apparel_accessories - 
+      appliances_electronics - 
+      auto_dealer - 
+      automotive - 
+      babies_kids - 
+      blogs_personal_sites - 
+      books_magazines - 
+      computers - 
+      dating - 
+      department_stores - 
+      education - 
+      employment - 
+      financial_credit_cards - 
+      financial_other - 
+      flowers_gifts - 
+      grocery - 
+      health_beauty - 
+      home_garden - 
+      hosting_domain - 
+      internet_providers - 
+      legal - 
+      media_entertainment - 
+      medical - 
+      movies_games - 
+      music - 
+      nonprofit - 
+      office_supplies - 
+      online_games - 
+      outdoor - 
+      pets - 
+      real_estate - 
+      restaurants - 
+      sport_fitness - 
+      telecom - 
+      ticketing - 
+      toys_hobbies - 
+      travel - 
+      utilities - 
+      wholesale_relationship - 
+      wine_spirits - 
+  authorship: string, The role of the author of the link.
+    Allowed values
+      advertiser - 
+      publisher - 
+  startDateMin: string, The beginning of the start date range.
+  assetSize: string, The size of the given asset. (repeated)
+  startDateMax: string, The end of the start date range.
+  userip: string, A parameter
+ 
+Returns:
+  An object of the form
+ 
+    {
+    "nextPageToken": "A String", # The next page token.
+    "items": [ # The links.
+      { # A LinkResource.
+          "startDate": "A String", # Date that this link becomes active.
+          "kind": "gan#link", # The kind for one entity.
+          "endDate": "A String", # Date that this link becomes inactive.
+          "description": "A String", # Description.
+          "name": "A String", # The logical name for this link.
+          "createDate": "A String", # Date that this link was created.
+          "imageAltText": "A String", # image alt text.
+          "id": "A String", # The ID of this link.
+          "advertiserId": "A String", # The advertiser id for the advertiser who owns this link.
+          "creativeType": "A String", # Creative Type.
+          "promotionType": "A String", # Promotion Type
+          "duration": "A String", # Duration
+          "authorship": "A String", # Authorship
+          "availability": "A String", # Availability.
+          "isActive": True or False, # Flag for if this link is active.
+          "destinationUrl": "A String", # The destination URL for the link.
+        },
+    ],
+    "kind": "gan#links", # The kind for a page of links.
+  }
+ +
list_next = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
+ 
+Args:
+  previous_request: The request for the previous page.
+  previous_response: The response from the request for the previous page.
+ 
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/gan.v1beta1.publishers.html b/docs/dyn/gan.v1beta1.publishers.html index 1f2f736..26aec1d 100644 --- a/docs/dyn/gan.v1beta1.publishers.html +++ b/docs/dyn/gan.v1beta1.publishers.html @@ -17,11 +17,15 @@

get = method(self, **kwargs)
Retrieves data about a single advertiser if that the requesting advertiser/publisher has access to it. Only advertisers can look up publishers. Publishers can request information about themselves by omitting the publisherId query parameter.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
    Allowed values
      advertisers - The requester is requesting as an advertiser.
      publishers - The requester is requesting as a publisher.
  roleId: string, The ID of the requesting advertiser or publisher. (required)
+  userip: string, A parameter
  publisherId: string, The ID of the publisher to look up. Optional.
 
Returns:
@@ -29,7 +33,7 @@ Returns:
 
    { # A PublisherResource.
    "status": "A String", # The status of the requesting advertiser's relationship with this publisher.
-    "kind": "gan#publisher", # The kind for one publisher. The kind for a publisher.
+    "kind": "gan#publisher", # The kind for a publisher.
    "name": "A String", # The name of this publisher.
    "classification": "A String", # Classification that this publisher belongs to. See this link for all publisher classifications: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4
    "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher divided by the total number of clicks over the past seven days. Values are multiplied by 100 for display purposes.
@@ -60,15 +64,19 @@ Args:
      deactivated - A publisher that you terminated from your program. Publishers also have the ability to remove themselves from your program.
      declined - A publisher that you did not approve to your program.
      pending - Publishers that have applied to your program. We recommend reviewing and deciding on pending publishers on a weekly basis.
-  roleId: string, The ID of the requesting advertiser or publisher. (required)
+  trace: string, A parameter
  pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
  minSevenDayEpc: number, Filters out all publishers that have a seven day EPC average lower than the given value (inclusive). Min value 0.0. Optional.
+  roleId: string, The ID of the requesting advertiser or publisher. (required)
+  pp: string, A parameter
  minNinetyDayEpc: number, Filters out all publishers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
+  strict: string, A parameter
  role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
    Allowed values
      advertisers - The requester is requesting as an advertiser.
      publishers - The requester is requesting as a publisher.
  maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.
+  userip: string, A parameter
  minPayoutRank: integer, A value between 1 and 4, where 1 represents the quartile of publishers with the lowest ranks and 4 represents the quartile of publishers with the highest ranks. Filters out all publishers with a lower rank than the given quartile. For example if a 2 was given only publishers with a payout rank of 25 or higher would be included. Optional.
 
Returns:
@@ -79,7 +87,7 @@ Returns:
    "items": [ # The entity list.
      { # A PublisherResource.
        "status": "A String", # The status of the requesting advertiser's relationship with this publisher.
-        "kind": "gan#publisher", # The kind for one publisher. The kind for a publisher.
+        "kind": "gan#publisher", # The kind for a publisher.
        "name": "A String", # The name of this publisher.
        "classification": "A String", # Classification that this publisher belongs to. See this link for all publisher classifications: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4
        "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher divided by the total number of clicks over the past seven days. Values are multiplied by 100 for display purposes.
diff --git a/docs/dyn/groupssettings.v1.groups.html b/docs/dyn/groupssettings.v1.groups.html index 5eef93c..b84125d 100644 --- a/docs/dyn/groupssettings.v1.groups.html +++ b/docs/dyn/groupssettings.v1.groups.html @@ -17,7 +17,11 @@
get = method(self, **kwargs)
Gets one resource by id.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  groupUniqueId: string, The resource ID (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -82,7 +86,11 @@ Args:
    "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  groupUniqueId: string, The resource ID (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -147,7 +155,11 @@ Args:
    "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  groupUniqueId: string, The resource ID (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/latitude.v1.currentLocation.html b/docs/dyn/latitude.v1.currentLocation.html index bf0cda4..3969cc1 100644 --- a/docs/dyn/latitude.v1.currentLocation.html +++ b/docs/dyn/latitude.v1.currentLocation.html @@ -16,12 +16,23 @@
delete = method(self, **kwargs)
Deletes the authenticated user's current location.
 
-Args:
+Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
get = method(self, **kwargs)
Returns the authenticated user's current location.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  granularity: string, Granularity of the requested location.
+    Allowed values
+      best - Request best available granularity.
+      city - Request city-level granularty.
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -58,6 +69,10 @@ Args:
    "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/latitude.v1.location.html b/docs/dyn/latitude.v1.location.html index e0f2b0a..7165067 100644 --- a/docs/dyn/latitude.v1.location.html +++ b/docs/dyn/latitude.v1.location.html @@ -17,13 +17,24 @@
delete = method(self, **kwargs)
Deletes a location from the user's location history.
 
Args:
-  locationId: string, Timestamp of the location to delete (ms since epoch). (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  locationId: string, Timestamp of the location to delete (ms since epoch). (required)
+  userip: string, A parameter
get = method(self, **kwargs)
Reads a location from the user's location history.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  locationId: string, Timestamp of the location to read (ms since epoch). (required)
  granularity: string, Granularity of the location to return.
+    Allowed values
+      best - Request best available granularity.
+      city - Request city-level granularty.
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -60,6 +71,10 @@ Args:
  "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
}
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -80,10 +95,17 @@ Returns:
list = method(self, **kwargs)
Lists the user's location history.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  min_time: string, Minimum timestamp of locations to return (ms since epoch).
+  userip: string, A parameter
+  strict: string, A parameter
  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.
+    Allowed values
+      best - Request best available granularity.
+      city - Request city-level granularty.
+  max_time: string, Maximum timestamp of locations to return (ms since epoch).
 
Returns:
  An object of the form
diff --git a/docs/dyn/moderator.v1.featured.series.html b/docs/dyn/moderator.v1.featured.series.html index 84f141a..176cc67 100644 --- a/docs/dyn/moderator.v1.featured.series.html +++ b/docs/dyn/moderator.v1.featured.series.html @@ -17,6 +17,10 @@
list = method(self, **kwargs)
Lists the featured series.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/moderator.v1.my.series.html b/docs/dyn/moderator.v1.my.series.html index afdfa3e..5dec8db 100644 --- a/docs/dyn/moderator.v1.my.series.html +++ b/docs/dyn/moderator.v1.my.series.html @@ -17,6 +17,10 @@
list = method(self, **kwargs)
Lists all series created by the authenticated user.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/moderator.v1.myrecent.series.html b/docs/dyn/moderator.v1.myrecent.series.html index d43402c..2c7ef2f 100644 --- a/docs/dyn/moderator.v1.myrecent.series.html +++ b/docs/dyn/moderator.v1.myrecent.series.html @@ -17,6 +17,10 @@
list = method(self, **kwargs)
Lists the series the authenticated user has visited.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/moderator.v1.profiles.html b/docs/dyn/moderator.v1.profiles.html index c4a6a64..ad1b463 100644 --- a/docs/dyn/moderator.v1.profiles.html +++ b/docs/dyn/moderator.v1.profiles.html @@ -17,6 +17,10 @@
get = method(self, **kwargs)
Returns the profile information for the authenticated user.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -61,6 +65,10 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -105,6 +113,10 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/moderator.v1.responses.html b/docs/dyn/moderator.v1.responses.html index 075a827..2709e12 100644 --- a/docs/dyn/moderator.v1.responses.html +++ b/docs/dyn/moderator.v1.responses.html @@ -19,8 +19,9 @@ Args:
  seriesId: integer, The decimal ID of the Series. (required)
  topicId: integer, The decimal ID of the Topic within the Series. (required)
+  pp: string, A parameter
  unauthToken: string, User identifier for unauthenticated usage mode
-  parentSubmissionId: integer, The decimal ID of the parent Submission within the Series. (required)
+  strict: string, A parameter
  body: object, The request body. (required)
    The object takes the form of:
 
@@ -73,6 +74,9 @@ Args:
    },
  }
 
+  parentSubmissionId: integer, The decimal ID of the parent Submission within the Series. (required)
+  userip: string, A parameter
+  trace: string, A parameter
  anonymous: boolean, Set to true to mark the new submission as anonymous.
 
Returns:
@@ -132,11 +136,15 @@ Returns:
Args:
  sort: string, Sort order.
  seriesId: integer, The decimal ID of the Series. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  author: string, Restricts the results to submissions by a specific author.
  submissionId: integer, The decimal ID of the Submission within the Series. (required)
  q: string, Search query.
+  strict: string, A parameter
  max_results: integer, Maximum number of results to return.
  hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
+  userip: string, A parameter
  start_index: integer, Index of the first result to be retrieved.
 
Returns:
diff --git a/docs/dyn/moderator.v1.series.html b/docs/dyn/moderator.v1.series.html index c81c7c7..2d01c50 100644 --- a/docs/dyn/moderator.v1.series.html +++ b/docs/dyn/moderator.v1.series.html @@ -18,6 +18,10 @@  
Args:
  seriesId: integer, The decimal ID of the Series. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -94,6 +98,10 @@ Args:
  },
}
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -135,7 +143,11 @@ Returns:
 
Args:
  q: string, Search query.
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  max_results: integer, Maximum number of results to return.
+  userip: string, A parameter
  start_index: integer, Index of the first result to be retrieved.
 
Returns:
@@ -219,6 +231,10 @@ Args:
  },
}
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -300,6 +316,10 @@ Args:
  },
}
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/moderator.v1.series.responses.html b/docs/dyn/moderator.v1.series.responses.html index 14557cb..8adbb4b 100644 --- a/docs/dyn/moderator.v1.series.responses.html +++ b/docs/dyn/moderator.v1.series.responses.html @@ -19,10 +19,14 @@ Args:
  sort: string, Sort order.
  seriesId: integer, The decimal ID of the Series. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  author: string, Restricts the results to submissions by a specific author.
  q: string, Search query.
+  strict: string, A parameter
  max_results: integer, Maximum number of results to return.
  hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
+  userip: string, A parameter
  start_index: integer, Index of the first result to be retrieved.
 
Returns:
diff --git a/docs/dyn/moderator.v1.series.submissions.html b/docs/dyn/moderator.v1.series.submissions.html index b487362..7c06e50 100644 --- a/docs/dyn/moderator.v1.series.submissions.html +++ b/docs/dyn/moderator.v1.series.submissions.html @@ -19,11 +19,15 @@ Args:
  lang: string, The language code for the language the client prefers resuls in.
  seriesId: integer, The decimal ID of the Series. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  includeVotes: boolean, Specifies whether to include the current user's vote
  author: string, Restricts the results to submissions by a specific author.
  sort: string, Sort order.
+  strict: string, A parameter
  max_results: integer, Maximum number of results to return.
  q: string, Search query.
+  userip: string, A parameter
  start_index: integer, Index of the first result to be retrieved.
  hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
 
diff --git a/docs/dyn/moderator.v1.submissions.html b/docs/dyn/moderator.v1.submissions.html index 5e84d61..68fc830 100644 --- a/docs/dyn/moderator.v1.submissions.html +++ b/docs/dyn/moderator.v1.submissions.html @@ -19,8 +19,12 @@ Args:
  lang: string, The language code for the language the client prefers resuls in.
  seriesId: integer, The decimal ID of the Series. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  includeVotes: boolean, Specifies whether to include the current user's vote
  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+  userip: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
@@ -79,7 +83,9 @@ Returns:
Args:
  seriesId: integer, The decimal ID of the Series. (required)
  topicId: integer, The decimal ID of the Topic within the Series. (required)
+  pp: string, A parameter
  unauthToken: string, User identifier for unauthenticated usage mode
+  strict: string, A parameter
  body: object, The request body. (required)
    The object takes the form of:
 
@@ -132,6 +138,8 @@ Args:
    },
  }
 
+  userip: string, A parameter
+  trace: string, A parameter
  anonymous: boolean, Set to true to mark the new submission as anonymous.
 
Returns:
diff --git a/docs/dyn/moderator.v1.tags.html b/docs/dyn/moderator.v1.tags.html index 58254a5..dae06b5 100644 --- a/docs/dyn/moderator.v1.tags.html +++ b/docs/dyn/moderator.v1.tags.html @@ -18,8 +18,12 @@  
Args:
  seriesId: integer, The decimal ID of the Series. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  tagId: string, A parameter (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)
+  strict: string, A parameter
+  userip: string, A parameter
insert = method(self, **kwargs)
Inserts a new tag for the specified submission within the specified series.
 
@@ -38,7 +42,11 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -57,7 +65,11 @@ Returns:
 
Args:
  seriesId: integer, The decimal ID of the Series. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/moderator.v1.topics.html b/docs/dyn/moderator.v1.topics.html index 614246b..234af04 100644 --- a/docs/dyn/moderator.v1.topics.html +++ b/docs/dyn/moderator.v1.topics.html @@ -19,6 +19,10 @@ Args:
  seriesId: integer, The decimal ID of the Series. (required)
  topicId: integer, The decimal ID of the Topic within the Series. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -184,6 +188,10 @@ Args:
    "name": "A String",
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -270,8 +278,12 @@ Returns:
Args:
  seriesId: integer, The decimal ID of the Series. (required)
  q: string, Search query.
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  max_results: integer, Maximum number of results to return.
  mode: string, A parameter
+  userip: string, A parameter
  start_index: integer, Index of the first result to be retrieved.
 
Returns:
@@ -366,6 +378,8 @@ Returns:
Args:
  seriesId: integer, The decimal ID of the Series. (required)
  topicId: integer, The decimal ID of the Topic within the Series. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  body: object, The request body. (required)
    The object takes the form of:
 
@@ -446,6 +460,8 @@ Args:
    "name": "A String",
  }
 
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/moderator.v1.topics.submissions.html b/docs/dyn/moderator.v1.topics.submissions.html index 4808b2a..5e1e9c9 100644 --- a/docs/dyn/moderator.v1.topics.submissions.html +++ b/docs/dyn/moderator.v1.topics.submissions.html @@ -19,11 +19,15 @@ Args:
  seriesId: integer, The decimal ID of the Series. (required)
  topicId: integer, The decimal ID of the Topic within the Series. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  includeVotes: boolean, Specifies whether to include the current user's vote
  author: string, Restricts the results to submissions by a specific author.
  sort: string, Sort order.
+  strict: string, A parameter
  max_results: integer, Maximum number of results to return.
  q: string, Search query.
+  userip: string, A parameter
  start_index: integer, Index of the first result to be retrieved.
  hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
 
diff --git a/docs/dyn/moderator.v1.votes.html b/docs/dyn/moderator.v1.votes.html index 0827d74..dd6e7ad 100644 --- a/docs/dyn/moderator.v1.votes.html +++ b/docs/dyn/moderator.v1.votes.html @@ -18,9 +18,13 @@  
Args:
  seriesId: integer, The decimal ID of the Series. (required)
+  pp: string, A parameter
  unauthToken: string, User identifier for unauthenticated usage mode
  userId: string, A parameter
  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+  strict: string, A parameter
+  userip: string, A parameter
+  trace: string, A parameter
 
Returns:
  An object of the form
@@ -52,8 +56,12 @@ Args:
    "kind": "moderator#vote",
  }
 
+  pp: string, A parameter
  unauthToken: string, User identifier for unauthenticated usage mode
  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+  strict: string, A parameter
+  userip: string, A parameter
+  trace: string, A parameter
 
Returns:
  An object of the form
@@ -72,7 +80,11 @@ Returns:
 
Args:
  seriesId: integer, The decimal ID of the Series. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  max_results: integer, Maximum number of results to return.
+  userip: string, A parameter
  start_index: integer, Index of the first result to be retrieved.
 
Returns:
@@ -110,9 +122,13 @@ Args:
    "kind": "moderator#vote",
  }
 
+  pp: string, A parameter
  unauthToken: string, User identifier for unauthenticated usage mode
  userId: string, A parameter
  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+  strict: string, A parameter
+  userip: string, A parameter
+  trace: string, A parameter
 
Returns:
  An object of the form
@@ -144,9 +160,13 @@ Args:
    "kind": "moderator#vote",
  }
 
+  pp: string, A parameter
  unauthToken: string, User identifier for unauthenticated usage mode
  userId: string, A parameter
  submissionId: integer, The decimal ID of the Submission within the Series. (required)
+  strict: string, A parameter
+  userip: string, A parameter
+  trace: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/oauth2.v2.html b/docs/dyn/oauth2.v2.html index 4101f69..f463774 100644 --- a/docs/dyn/oauth2.v2.html +++ b/docs/dyn/oauth2.v2.html @@ -14,48 +14,15 @@ Methods defined here:
__init__(self)
-
issueTokenGet = method(self, **kwargs)
A description of how to use this function
- 
-Args:
-  origin: string, A parameter
-  force: boolean, A parameter
-  client_id: string, A parameter (required)
-  alg: string, A parameter
-  app_id: string, A parameter
-  android_device_id: string, A parameter
-  audience: string, A parameter
-  hl: string, A parameter
-  scope: string, A parameter (required)
-  response_type: string, A parameter (required)
- 
-Returns:
-  An object of the form
- 
-    {
-    "consent": {
-      "scopes": [
-        {
-          "description": "A String",
-          "detail": "A String",
-        },
-      ],
-      "oauthClient": {
-        "iconUri": "A String",
-        "developerEmail": "A String",
-        "name": "A String",
-      },
-    },
-    "token": "A String",
-    "code": "A String",
-    "issueAdvice": "A String",
-    "idToken": "A String",
-  }
-
tokeninfo = method(self, **kwargs)
A description of how to use this function
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  access_token: string, A parameter
  id_token: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -64,7 +31,7 @@ Returns:
    "issued_to": "A String", # To whom was the token issued to. In general the same as audience.
    "user_id": "A String", # The Gaia obfuscated user id.
    "expires_in": 42, # The expiry time of the token, as number of seconds left until expiry.
-    "access_type": "A String", # The access type granted with this toke. It can be offline or online.
+    "access_type": "A String", # The access type granted with this token. It can be offline or online.
    "audience": "A String", # Who is the intended audience for this token. In general the same as issued_to.
    "scope": "A String", # The space separated list of scopes granted to this token.
    "email": "A String", # The email address of the user. Present only if the email scope is present in the request.
diff --git a/docs/dyn/oauth2.v2.userinfo.html b/docs/dyn/oauth2.v2.userinfo.html index a6bd5d5..696d0d3 100644 --- a/docs/dyn/oauth2.v2.userinfo.html +++ b/docs/dyn/oauth2.v2.userinfo.html @@ -17,23 +17,27 @@
get = method(self, **kwargs)
A description of how to use this function
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
 
    {
-    "family_name": "A String",
-    "name": "A String",
-    "picture": "A String",
-    "locale": "A String",
-    "gender": "A String",
-    "email": "A String",
-    "birthday": "A String",
-    "link": "A String",
-    "given_name": "A String",
-    "timezone": "A String",
-    "id": "A String",
-    "verified_email": True or False,
+    "family_name": "A String", # The user's last name.
+    "name": "A String", # The user's full name.
+    "picture": "A String", # URL of the user's picture image.
+    "locale": "A String", # The user's default locale.
+    "gender": "A String", # The user's gender.
+    "email": "A String", # The user's email address.
+    "birthday": "A String", # The user's birthday. The year is not present.
+    "link": "A String", # URL of the profile page.
+    "given_name": "A String", # The user's first name.
+    "timezone": "A String", # The user's default timezone.
+    "id": "A String", # The focus obfuscated gaia id of the user.
+    "verified_email": True or False, # Boolean flag which is true if the email address is verified.
  }
v2 = methodResource(self)
A collection resource.
diff --git a/docs/dyn/oauth2.v2.userinfo.v2.me.html b/docs/dyn/oauth2.v2.userinfo.v2.me.html index ee10991..db42d92 100644 --- a/docs/dyn/oauth2.v2.userinfo.v2.me.html +++ b/docs/dyn/oauth2.v2.userinfo.v2.me.html @@ -17,23 +17,27 @@
get = method(self, **kwargs)
A description of how to use this function
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
 
    {
-    "family_name": "A String",
-    "name": "A String",
-    "picture": "A String",
-    "locale": "A String",
-    "gender": "A String",
-    "email": "A String",
-    "birthday": "A String",
-    "link": "A String",
-    "given_name": "A String",
-    "timezone": "A String",
-    "id": "A String",
-    "verified_email": True or False,
+    "family_name": "A String", # The user's last name.
+    "name": "A String", # The user's full name.
+    "picture": "A String", # URL of the user's picture image.
+    "locale": "A String", # The user's default locale.
+    "gender": "A String", # The user's gender.
+    "email": "A String", # The user's email address.
+    "birthday": "A String", # The user's birthday. The year is not present.
+    "link": "A String", # URL of the profile page.
+    "given_name": "A String", # The user's first name.
+    "timezone": "A String", # The user's default timezone.
+    "id": "A String", # The focus obfuscated gaia id of the user.
+    "verified_email": True or False, # Boolean flag which is true if the email address is verified.
  }
diff --git a/docs/dyn/orkut.v2.acl.html b/docs/dyn/orkut.v2.acl.html index 905d92e..86ed494 100644 --- a/docs/dyn/orkut.v2.acl.html +++ b/docs/dyn/orkut.v2.acl.html @@ -17,8 +17,12 @@
delete = method(self, **kwargs)
Excludes an element from the ACL of the activity.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  userId: string, ID of the user to be removed from the activity. (required)
-  activityId: string, ID of the activity. (required)
+  strict: string, A parameter
+  activityId: string, ID of the activity. (required)
+  userip: string, A parameter
Data descriptors defined here:
diff --git a/docs/dyn/orkut.v2.activities.html b/docs/dyn/orkut.v2.activities.html index 339bee1..5538185 100644 --- a/docs/dyn/orkut.v2.activities.html +++ b/docs/dyn/orkut.v2.activities.html @@ -17,20 +17,28 @@
delete = method(self, **kwargs)
Deletes an existing activity, if the access controls allow it.
 
Args:
-  activityId: string, ID of the activity to remove. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  activityId: string, ID of the activity to remove. (required)
+  userip: string, A parameter
list = method(self, **kwargs)
Retrieves a list of activities.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  pageToken: string, A continuation token that allows pagination.
+  hl: string, Specifies the interface language (host language) of your user interface.
  userId: string, The ID of the user whose activities will be listed. Can be me to refer to the viewer (i.e. the authenticated user). (required)
  maxResults: integer, The maximum number of activities to include in the response.
+  strict: string, A parameter
  collection: string, The collection of activities to list. (required)
    Allowed values
      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.
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/orkut.v2.activityVisibility.html b/docs/dyn/orkut.v2.activityVisibility.html index ce76a76..d78be34 100644 --- a/docs/dyn/orkut.v2.activityVisibility.html +++ b/docs/dyn/orkut.v2.activityVisibility.html @@ -17,7 +17,11 @@
get = method(self, **kwargs)
Gets the visibility of an existing activity.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  activityId: string, ID of the activity to get the visibility. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -58,7 +62,11 @@ Args:
    ],
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  activityId: string, ID of the activity. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -99,7 +107,11 @@ Args:
    ],
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  activityId: string, ID of the activity. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/orkut.v2.badges.html b/docs/dyn/orkut.v2.badges.html index 97f8884..0e0eae6 100644 --- a/docs/dyn/orkut.v2.badges.html +++ b/docs/dyn/orkut.v2.badges.html @@ -17,8 +17,12 @@
get = method(self, **kwargs)
Retrieves a badge from a user.
 
Args:
+  pp: string, A parameter
  badgeId: string, The ID of the badge that will be retrieved. (required)
+  trace: string, A parameter
  userId: string, The ID of the user whose badges will be listed. Can be me to refer to caller. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -38,7 +42,11 @@ Returns:
list = method(self, **kwargs)
Retrieves the list of visible badges of a user.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  userId: string, The id of the user whose badges will be listed. Can be me to refer to caller. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/orkut.v2.comments.html b/docs/dyn/orkut.v2.comments.html index 5b697de..9498f55 100644 --- a/docs/dyn/orkut.v2.comments.html +++ b/docs/dyn/orkut.v2.comments.html @@ -17,12 +17,20 @@
delete = method(self, **kwargs)
Deletes an existing comment.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  commentId: string, ID of the comment to remove. (required)
get = method(self, **kwargs)
Retrieves an existing comment.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  hl: string, Specifies the interface language (host language) of your user interface.
+  strict: string, A parameter
+  userip: string, A parameter
  commentId: string, ID of the comment to get. (required)
 
Returns:
@@ -92,7 +100,11 @@ Args:
  "id": "A String", # The unique ID for the comment.
}
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  activityId: string, The ID of the activity to contain the new comment. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -133,10 +145,14 @@ Args:
    Allowed values
      ascending - Use ascending sort order.
      descending - Use descending sort order.
+  pp: string, A parameter
+  trace: string, A parameter
  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.
+  maxResults: integer, The maximum number of activities to include in the response.
+  strict: string, A parameter
+  activityId: string, The ID of the activity containing the comments. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/orkut.v2.communities.html b/docs/dyn/orkut.v2.communities.html index acfc834..d7576d8 100644 --- a/docs/dyn/orkut.v2.communities.html +++ b/docs/dyn/orkut.v2.communities.html @@ -17,7 +17,11 @@
get = method(self, **kwargs)
Retrieves the basic information (aka. profile) of a community.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  hl: string, Specifies the interface language (host language) of your user interface.
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community to get. (required)
 
Returns:
@@ -79,9 +83,13 @@ Args:
    Allowed values
      id - Returns the communities sorted by a fixed, natural order.
      ranked - Returns the communities ranked accordingly to how they are displayed on the orkut web application.
+  pp: string, A parameter
+  trace: string, A parameter
+  hl: string, Specifies the interface language (host language) of your user interface.
  userId: string, The ID of the user whose communities will be listed. Can be me to refer to caller. (required)
  maxResults: integer, The maximum number of communities to include in the response.
-  hl: string, Specifies the interface language (host language) of your user interface.
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/orkut.v2.communityFollow.html b/docs/dyn/orkut.v2.communityFollow.html index 5e51c46..93caaa0 100644 --- a/docs/dyn/orkut.v2.communityFollow.html +++ b/docs/dyn/orkut.v2.communityFollow.html @@ -17,13 +17,21 @@
delete = method(self, **kwargs)
Removes a user from the followers of a community.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  userId: string, ID of the user. (required)
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, ID of the community. (required)
insert = method(self, **kwargs)
Adds a user as a follower of a community.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  userId: string, ID of the user. (required)
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, ID of the community. (required)
 
Returns:
diff --git a/docs/dyn/orkut.v2.communityMembers.html b/docs/dyn/orkut.v2.communityMembers.html index bd9b26c..4306414 100644 --- a/docs/dyn/orkut.v2.communityMembers.html +++ b/docs/dyn/orkut.v2.communityMembers.html @@ -17,14 +17,22 @@
delete = method(self, **kwargs)
Makes the user leave a community.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  userId: string, ID of the user. (required)
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, ID of the community. (required)
get = method(self, **kwargs)
Retrieves the relationship between a user and a community.
 
Args:
-  userId: string, ID of the user. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  hl: string, Specifies the interface language (host language) of your user interface.
+  userId: string, ID of the user. (required)
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, ID of the community. (required)
 
Returns:
@@ -63,7 +71,11 @@ Returns:
insert = method(self, **kwargs)
Makes the user join a community.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  userId: string, ID of the user. (required)
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, ID of the community. (required)
 
Returns:
@@ -103,9 +115,13 @@ Returns:
 
Args:
  friendsOnly: boolean, Whether to list only community members who are friends of the user.
+  trace: string, A parameter
  pageToken: string, A continuation token that allows pagination.
-  maxResults: integer, The maximum number of members to include in the response.
  hl: string, Specifies the interface language (host language) of your user interface.
+  pp: string, A parameter
+  maxResults: integer, The maximum number of members to include in the response.
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community whose members will be listed. (required)
 
Returns:
diff --git a/docs/dyn/orkut.v2.communityMessages.html b/docs/dyn/orkut.v2.communityMessages.html index 42551c3..7fb6101 100644 --- a/docs/dyn/orkut.v2.communityMessages.html +++ b/docs/dyn/orkut.v2.communityMessages.html @@ -18,7 +18,11 @@  
Args:
  topicId: string, The ID of the topic whose message will be moved to the trash folder. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  messageId: string, The ID of the message to be moved to the trash folder. (required)
+  userip: string, A parameter
  communityId: integer, The ID of the community whose message will be moved to the trash folder. (required)
insert = method(self, **kwargs)
Adds a message to a given community topic.
@@ -53,6 +57,10 @@ Args:
  }
 
  topicId: string, The ID of the topic the message should be added to. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community the message should be added to. (required)
 
Returns:
@@ -87,9 +95,13 @@ Returns:
 
Args:
  topicId: string, The ID of the topic which messages will be listed. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  pageToken: string, A continuation token that allows pagination.
-  maxResults: integer, The maximum number of messages to include in the response.
  hl: string, Specifies the interface language (host language) of your user interface.
+  maxResults: integer, The maximum number of messages to include in the response.
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community which messages will be listed. (required)
 
Returns:
diff --git a/docs/dyn/orkut.v2.communityPollComments.html b/docs/dyn/orkut.v2.communityPollComments.html index a1fde17..41021d7 100644 --- a/docs/dyn/orkut.v2.communityPollComments.html +++ b/docs/dyn/orkut.v2.communityPollComments.html @@ -35,6 +35,10 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community whose poll is being commented. (required)
  pollId: string, The ID of the poll being commented. (required)
 
@@ -59,9 +63,13 @@ Returns:
list = method(self, **kwargs)
Retrieves the comments of a community poll.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  pageToken: string, A continuation token that allows pagination.
-  maxResults: integer, The maximum number of comments to include in the response.
  hl: string, Specifies the interface language (host language) of your user interface.
+  maxResults: integer, The maximum number of comments to include in the response.
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community whose poll is having its comments listed. (required)
  pollId: string, The ID of the community whose polls will be listed. (required)
 
diff --git a/docs/dyn/orkut.v2.communityPollVotes.html b/docs/dyn/orkut.v2.communityPollVotes.html index aead915..d9f1c32 100644 --- a/docs/dyn/orkut.v2.communityPollVotes.html +++ b/docs/dyn/orkut.v2.communityPollVotes.html @@ -28,6 +28,10 @@ Args:
    "isVotevisible": True or False, # Whether this vote is visible to other users or not.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community whose poll is being voted. (required)
  pollId: string, The ID of the poll being voted. (required)
 
diff --git a/docs/dyn/orkut.v2.communityPolls.html b/docs/dyn/orkut.v2.communityPolls.html index c2e559d..b40677d 100644 --- a/docs/dyn/orkut.v2.communityPolls.html +++ b/docs/dyn/orkut.v2.communityPolls.html @@ -17,7 +17,11 @@
get = method(self, **kwargs)
Retrieves one specific poll of a community.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  hl: string, Specifies the interface language (host language) of your user interface.
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community for whose poll will be retrieved. (required)
  pollId: string, The ID of the poll to get. (required)
 
@@ -79,9 +83,13 @@ Returns:
list = method(self, **kwargs)
Retrieves the polls of a community.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  pageToken: string, A continuation token that allows pagination.
-  maxResults: integer, The maximum number of polls to include in the response.
  hl: string, Specifies the interface language (host language) of your user interface.
+  maxResults: integer, The maximum number of polls to include in the response.
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community which polls will be listed. (required)
 
Returns:
diff --git a/docs/dyn/orkut.v2.communityRelated.html b/docs/dyn/orkut.v2.communityRelated.html index d4d20e6..56e005a 100644 --- a/docs/dyn/orkut.v2.communityRelated.html +++ b/docs/dyn/orkut.v2.communityRelated.html @@ -17,7 +17,11 @@
list = method(self, **kwargs)
Retrieves the communities related to another one.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  hl: string, Specifies the interface language (host language) of your user interface.
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community whose related communities will be listed. (required)
 
Returns:
diff --git a/docs/dyn/orkut.v2.communityTopics.html b/docs/dyn/orkut.v2.communityTopics.html index c3d2b55..f822fc8 100644 --- a/docs/dyn/orkut.v2.communityTopics.html +++ b/docs/dyn/orkut.v2.communityTopics.html @@ -18,13 +18,21 @@  
Args:
  topicId: string, The ID of the topic to be moved to the trash folder. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community whose topic will be moved to the trash folder. (required)
get = method(self, **kwargs)
Retrieves a topic of a community.
 
Args:
  topicId: string, The ID of the topic to get. (required)
+  pp: string, A parameter
+  trace: string, A parameter
  hl: string, Specifies the interface language (host language) of your user interface.
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community whose topic will be retrieved. (required)
 
Returns:
@@ -142,7 +150,11 @@ Args:
    "id": "A String", # The ID of the topic.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  isShout: boolean, Whether this topic is a shout.
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community the topic should be added to. (required)
 
Returns:
@@ -204,9 +216,13 @@ Returns:
list = method(self, **kwargs)
Retrieves the topics of a community.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  pageToken: string, A continuation token that allows pagination.
-  maxResults: integer, The maximum number of topics to include in the response.
  hl: string, Specifies the interface language (host language) of your user interface.
+  maxResults: integer, The maximum number of topics to include in the response.
+  strict: string, A parameter
+  userip: string, A parameter
  communityId: integer, The ID of the community which topics will be listed. (required)
 
Returns:
diff --git a/docs/dyn/orkut.v2.counters.html b/docs/dyn/orkut.v2.counters.html index 174e4ca..b0f200b 100644 --- a/docs/dyn/orkut.v2.counters.html +++ b/docs/dyn/orkut.v2.counters.html @@ -17,7 +17,11 @@
list = method(self, **kwargs)
Retrieves the counters of a user.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  userId: string, The ID of the user whose counters will be listed. Can be me to refer to caller. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/orkut.v2.scraps.html b/docs/dyn/orkut.v2.scraps.html index 3c2604d..9f3aac2 100644 --- a/docs/dyn/orkut.v2.scraps.html +++ b/docs/dyn/orkut.v2.scraps.html @@ -176,6 +176,10 @@ Args:
  "id": "A String", # The ID for the activity.
}
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/pagespeedonline.v1.pagespeedapi.html b/docs/dyn/pagespeedonline.v1.pagespeedapi.html index 8c85adf..e1d37b3 100644 --- a/docs/dyn/pagespeedonline.v1.pagespeedapi.html +++ b/docs/dyn/pagespeedonline.v1.pagespeedapi.html @@ -17,13 +17,17 @@
runpagespeed = method(self, **kwargs)
Runs Page Speed analysis on the page at the specified URL, and returns a Page Speed score, a list of suggestions to make that page faster, and other information.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  locale: string, The locale used to localize formatted results
  rule: string, A Page Speed rule to run; if none are given, all rules are run (repeated)
  strategy: string, The analysis strategy to use
    Allowed values
      desktop - Fetch and analyze the URL for desktop browsers
      mobile - Fetch and analyze the URL for mobile devices
+  strict: string, A parameter
  url: string, The URL to fetch and analyze (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/plus.v1.activities.html b/docs/dyn/plus.v1.activities.html index 984dc04..97b4bf1 100644 --- a/docs/dyn/plus.v1.activities.html +++ b/docs/dyn/plus.v1.activities.html @@ -17,10 +17,11 @@
get = method(self, **kwargs)
Get an activity.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
  activityId: string, The ID of the activity to get. (required)
-  alt: string, Specifies an alternative representation type.
-    Allowed values
-      json - Use JSON format
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -129,7 +130,6 @@ Returns:
    "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.
  }
@@ -137,15 +137,16 @@ Returns:
list = method(self, **kwargs)
List all of the activities in the specified collection for a particular user.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
  userId: string, The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. (required)
  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.
+  strict: string, A parameter
  collection: string, The collection of activities to list. (required)
    Allowed values
      public - All public activities created by the specified user.
-  alt: string, Specifies an alternative representation type.
-    Allowed values
-      json - Use JSON format
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -259,7 +260,6 @@ Returns:
        "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.
      },
@@ -288,9 +288,13 @@ Args:
    Allowed values
      best - Sort activities by relevance to the user, most relevant first.
      recent - Sort activities by published date, most recent first.
+  pp: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
+  trace: string, A parameter
  query: string, Full-text search query string. (required)
 
Returns:
@@ -405,7 +409,6 @@ Returns:
        "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.
      },
diff --git a/docs/dyn/plus.v1.comments.html b/docs/dyn/plus.v1.comments.html index 1fb8562..316273c 100644 --- a/docs/dyn/plus.v1.comments.html +++ b/docs/dyn/plus.v1.comments.html @@ -17,6 +17,10 @@
get = method(self, **kwargs)
Get a comment.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  commentId: string, The ID of the comment to get. (required)
 
Returns:
@@ -55,16 +59,17 @@ Returns:
list = method(self, **kwargs)
List all of the comments for an activity.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
  maxResults: integer, The maximum number of comments to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
+  strict: string, A parameter
  activityId: string, The ID of the activity to get comments for. (required)
  sortOrder: string, The order in which to sort the list of comments.
    Allowed values
      ascending - Sort oldest comments first.
      descending - Sort newest comments first.
-  alt: string, Specifies an alternative representation type.
-    Allowed values
-      json - Use JSON format
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/plus.v1.people.html b/docs/dyn/plus.v1.people.html index 2eeac13..9f0a405 100644 --- a/docs/dyn/plus.v1.people.html +++ b/docs/dyn/plus.v1.people.html @@ -17,7 +17,11 @@
get = method(self, **kwargs)
Get a person's profile.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -113,13 +117,17 @@ Returns:
listByActivity = method(self, **kwargs)
List all of the people in the specified collection for a particular activity.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
  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.
+  strict: string, A parameter
  activityId: string, The ID of the activity to get the list of people for. (required)
  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.
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -234,10 +242,14 @@ Returns:
search = method(self, **kwargs)
Search all public profiles.
 
Args:
-  language: string, Specify the preferred language to search with. See search language codes for available values.
+  pp: string, A parameter
+  trace: string, A parameter
  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.
+  language: string, Specify the preferred language to search with. See search language codes for available values.
  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)
+  strict: string, A parameter
+  userip: string, A parameter
+  query: string, Specify a query string for full text search of public text in all profiles. (required)
 
Returns:
  An object of the form
diff --git a/docs/dyn/prediction.v1.5.hostedmodels.html b/docs/dyn/prediction.v1.5.hostedmodels.html index 8f54203..3f7254d 100644 --- a/docs/dyn/prediction.v1.5.hostedmodels.html +++ b/docs/dyn/prediction.v1.5.hostedmodels.html @@ -28,6 +28,10 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  hostedModelName: string, The name of a hosted model. (required)
 
Returns:
diff --git a/docs/dyn/prediction.v1.5.trainedmodels.html b/docs/dyn/prediction.v1.5.trainedmodels.html index 8aa06c0..1942b7f 100644 --- a/docs/dyn/prediction.v1.5.trainedmodels.html +++ b/docs/dyn/prediction.v1.5.trainedmodels.html @@ -17,6 +17,10 @@
analyze = method(self, **kwargs)
Get analysis of the model and the data the model was trained on.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: string, The unique name for the predictive model. (required)
 
Returns:
@@ -101,11 +105,19 @@ Returns:
delete = method(self, **kwargs)
Delete a trained model.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: string, The unique name for the predictive model. (required)
get = method(self, **kwargs)
Check training status of your model.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: string, The unique name for the predictive model. (required)
 
Returns:
@@ -165,6 +177,10 @@ Args:
    ],
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -196,8 +212,12 @@ Returns:
list = method(self, **kwargs)
List available models.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  pageToken: string, Pagination token
  maxResults: integer, Maximum number of results to return
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -257,6 +277,10 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: string, The unique name for the predictive model. (required)
 
Returns:
@@ -289,6 +313,10 @@ Args:
    "label": "A String", # The true class label of this instance
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: string, The unique name for the predictive model. (required)
 
Returns:
diff --git a/docs/dyn/shopping.v1.products.html b/docs/dyn/shopping.v1.products.html index fb00bf0..38c1ae0 100644 --- a/docs/dyn/shopping.v1.products.html +++ b/docs/dyn/shopping.v1.products.html @@ -20,32 +20,37 @@ Args:
  taxonomy: string, Merchant taxonomy
  recommendations_useGcsConfig: boolean, This parameter is currently ignored
  accountId: integer, Merchant center account id (required)
+  pp: string, A parameter
+  trace: string, A parameter
  plusOne_enabled: boolean, Whether to return +1 button code
-  plusOne_options: string, +1 button rendering specification
  recommendations_include: string, Recommendation specification
  source: string, Query source (required)
  location: string, Location used to determine tax and shipping
+  strict: string, A parameter
  productId: string, Id of product (required)
  productIdType: string, Type of productId (required)
  recommendations_enabled: boolean, Whether to return recommendation information
  categories_enabled: boolean, Whether to return category information
  attributeFilter: string, Comma separated list of attributes to return
  categories_useGcsConfig: boolean, This parameter is currently ignored
+  plusOne_styles: string, +1 button rendering styles
  thumbnails: string, Thumbnail specification
  categories_include: string, Category specification
  plusOne_useGcsConfig: boolean, Whether to use +1 button styles configured in the GCS account
+  userip: string, A parameter
 
Returns:
  An object of the form
 
    {
-    "selfLink": "A String", # Self link of product.
+    "selfLink": "A String",
    "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.
        {
+          "status": "A String",
          "link": "A String", # Link to product image.
          "thumbnails": [ # Thumbnails of product image.
            {
@@ -59,15 +64,21 @@ Returns:
      ],
      "inventories": [ # Inventories of product.
        {
+          "installmentPrice": 3.14, # Installment price of product inventory.
+          "installmentMonths": 42, # Number of months for installment price.
          "distance": 3.14, # Distance of product inventory.
          "price": 3.14, # Price of product inventory.
          "storeId": "A String", # Store ID of product inventory.
          "tax": 3.14, # Tax of product inventory.
          "shipping": 3.14, # Shipping cost of product inventory.
          "currency": "A String", # Currency of product inventory (an ISO 4217 alphabetic code).
+          "salePrice": 3.14, # Sale price of product inventory.
+          "originalPrice": 3.14, # Original price of product inventory. Only returned for products that are on sale.
          "distanceUnit": "A String", # Distance unit of product inventory.
+          "saleStartDate": "A String", # Sale start date.
          "availability": "A String", # Availability of product inventory.
          "channel": "A String", # Channel of product inventory (one of: online, local).
+          "saleEndDate": "A String", # Sale end date.
        },
      ],
      "author": { # Author of product.
@@ -143,6 +154,7 @@ Returns:
              "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
              "images": [ # Images of product.
                {
+                  "status": "A String",
                  "link": "A String", # Link to product image.
                  "thumbnails": [ # Thumbnails of product image.
                    {
@@ -156,15 +168,21 @@ Returns:
              ],
              "inventories": [ # Inventories of product.
                {
+                  "installmentPrice": 3.14, # Installment price of product inventory.
+                  "installmentMonths": 42, # Number of months for installment price.
                  "distance": 3.14, # Distance of product inventory.
                  "price": 3.14, # Price of product inventory.
                  "storeId": "A String", # Store ID of product inventory.
                  "tax": 3.14, # Tax of product inventory.
                  "shipping": 3.14, # Shipping cost of product inventory.
                  "currency": "A String", # Currency of product inventory (an ISO 4217 alphabetic code).
+                  "salePrice": 3.14, # Sale price of product inventory.
+                  "originalPrice": 3.14, # Original price of product inventory. Only returned for products that are on sale.
                  "distanceUnit": "A String", # Distance unit of product inventory.
+                  "saleStartDate": "A String", # Sale start date.
                  "availability": "A String", # Availability of product inventory.
                  "channel": "A String", # Channel of product inventory (one of: online, local).
+                  "saleEndDate": "A String", # Sale end date.
                },
              ],
              "author": { # Author of product.
@@ -277,25 +295,29 @@ Args:
  availability: string, Comma separated list of availabilities (outOfStock, limited, inStock, backOrder, preOrder, onDisplayToOrder) to return
  crowdBy: string, Crowding specification
  spelling_enabled: boolean, Whether to return spelling suggestions
+  pp: string, A parameter
  categoryRecommendations_category: string, Category for which to retrieve recommendations
  source: string, Query source (required)
-  categories_useGcsConfig: boolean, This parameter is currently ignored
  categoryRecommendations_enabled: boolean, Whether to return category recommendation information
  spelling_useGcsConfig: boolean, This parameter is currently ignored
  plusOne_enabled: boolean, Whether to return +1 button code
  useCase: string, One of CommerceSearchUseCase, ShoppingApiUseCase
  location: string, Location used to determine tax and shipping
  maxVariants: integer, Maximum number of variant results to return per result
+  plusOne_styles: string, +1 button rendering styles
+  strict: string, A parameter
  relatedQueries_enabled: boolean, Whether to return related queries
  facets_useGcsConfig: boolean, Whether to return facet information as configured in the GCS account
  categoryRecommendations_useGcsConfig: boolean, This parameter is currently ignored
  boostBy: string, Boosting specification
+  trace: string, A parameter
  safe: boolean, Whether safe search is enabled. Default: true
  maxResults: integer, Maximum number of results to return
  categories_enabled: boolean, Whether to return category information
  attributeFilter: string, Comma separated list of attributes to return
  categoryRecommendations_include: string, Category recommendation specification
-  plusOne_options: string, +1 button rendering specification
+  categories_useGcsConfig: boolean, This parameter is currently ignored
+  clickTracking: boolean, Whether to add a click tracking parameter to offer URLs
  facets_include: string, Facets to include (applies when useGcsConfig == false)
  thumbnails: string, Image thumbnails specification
  language: string, Language restriction (BCP 47)
@@ -306,6 +328,7 @@ Args:
  q: string, Search query
  redirects_useGcsConfig: boolean, Whether to return redirect information as configured in the GCS account
  plusOne_useGcsConfig: boolean, Whether to use +1 button styles configured in the GCS account
+  userip: string, A parameter
  relatedQueries_useGcsConfig: boolean, This parameter is currently ignored
  promotions_useGcsConfig: boolean, Whether to return promotion information as configured in the GCS account
  country: string, Country restriction (ISO 3166)
@@ -321,6 +344,7 @@ Returns:
          "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
          "images": [ # Images of product.
            {
+              "status": "A String",
              "link": "A String", # Link to product image.
              "thumbnails": [ # Thumbnails of product image.
                {
@@ -334,15 +358,21 @@ Returns:
          ],
          "inventories": [ # Inventories of product.
            {
+              "installmentPrice": 3.14, # Installment price of product inventory.
+              "installmentMonths": 42, # Number of months for installment price.
              "distance": 3.14, # Distance of product inventory.
              "price": 3.14, # Price of product inventory.
              "storeId": "A String", # Store ID of product inventory.
              "tax": 3.14, # Tax of product inventory.
              "shipping": 3.14, # Shipping cost of product inventory.
              "currency": "A String", # Currency of product inventory (an ISO 4217 alphabetic code).
+              "salePrice": 3.14, # Sale price of product inventory.
+              "originalPrice": 3.14, # Original price of product inventory. Only returned for products that are on sale.
              "distanceUnit": "A String", # Distance unit of product inventory.
+              "saleStartDate": "A String", # Sale start date.
              "availability": "A String", # Availability of product inventory.
              "channel": "A String", # Channel of product inventory (one of: online, local).
+              "saleEndDate": "A String", # Sale end date.
            },
          ],
          "author": { # Author of product.
@@ -412,7 +442,6 @@ Returns:
        "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.
@@ -439,13 +468,14 @@ Returns:
    "currentItemCount": 42, # Current item count.
    "items": [ # List of returned products.
      {
-        "selfLink": "A String", # Self link of product.
+        "selfLink": "A String",
        "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.
            {
+              "status": "A String",
              "link": "A String", # Link to product image.
              "thumbnails": [ # Thumbnails of product image.
                {
@@ -459,15 +489,21 @@ Returns:
          ],
          "inventories": [ # Inventories of product.
            {
+              "installmentPrice": 3.14, # Installment price of product inventory.
+              "installmentMonths": 42, # Number of months for installment price.
              "distance": 3.14, # Distance of product inventory.
              "price": 3.14, # Price of product inventory.
              "storeId": "A String", # Store ID of product inventory.
              "tax": 3.14, # Tax of product inventory.
              "shipping": 3.14, # Shipping cost of product inventory.
              "currency": "A String", # Currency of product inventory (an ISO 4217 alphabetic code).
+              "salePrice": 3.14, # Sale price of product inventory.
+              "originalPrice": 3.14, # Original price of product inventory. Only returned for products that are on sale.
              "distanceUnit": "A String", # Distance unit of product inventory.
+              "saleStartDate": "A String", # Sale start date.
              "availability": "A String", # Availability of product inventory.
              "channel": "A String", # Channel of product inventory (one of: online, local).
+              "saleEndDate": "A String", # Sale end date.
            },
          ],
          "author": { # Author of product.
@@ -543,6 +579,7 @@ Returns:
                  "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
                  "images": [ # Images of product.
                    {
+                      "status": "A String",
                      "link": "A String", # Link to product image.
                      "thumbnails": [ # Thumbnails of product image.
                        {
@@ -556,15 +593,21 @@ Returns:
                  ],
                  "inventories": [ # Inventories of product.
                    {
+                      "installmentPrice": 3.14, # Installment price of product inventory.
+                      "installmentMonths": 42, # Number of months for installment price.
                      "distance": 3.14, # Distance of product inventory.
                      "price": 3.14, # Price of product inventory.
                      "storeId": "A String", # Store ID of product inventory.
                      "tax": 3.14, # Tax of product inventory.
                      "shipping": 3.14, # Shipping cost of product inventory.
                      "currency": "A String", # Currency of product inventory (an ISO 4217 alphabetic code).
+                      "salePrice": 3.14, # Sale price of product inventory.
+                      "originalPrice": 3.14, # Original price of product inventory. Only returned for products that are on sale.
                      "distanceUnit": "A String", # Distance unit of product inventory.
+                      "saleStartDate": "A String", # Sale start date.
                      "availability": "A String", # Availability of product inventory.
                      "channel": "A String", # Channel of product inventory (one of: online, local).
+                      "saleEndDate": "A String", # Sale end date.
                    },
                  ],
                  "author": { # Author of product.
@@ -705,6 +748,7 @@ Returns:
              "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
              "images": [ # Images of product.
                {
+                  "status": "A String",
                  "link": "A String", # Link to product image.
                  "thumbnails": [ # Thumbnails of product image.
                    {
@@ -718,15 +762,21 @@ Returns:
              ],
              "inventories": [ # Inventories of product.
                {
+                  "installmentPrice": 3.14, # Installment price of product inventory.
+                  "installmentMonths": 42, # Number of months for installment price.
                  "distance": 3.14, # Distance of product inventory.
                  "price": 3.14, # Price of product inventory.
                  "storeId": "A String", # Store ID of product inventory.
                  "tax": 3.14, # Tax of product inventory.
                  "shipping": 3.14, # Shipping cost of product inventory.
                  "currency": "A String", # Currency of product inventory (an ISO 4217 alphabetic code).
+                  "salePrice": 3.14, # Sale price of product inventory.
+                  "originalPrice": 3.14, # Original price of product inventory. Only returned for products that are on sale.
                  "distanceUnit": "A String", # Distance unit of product inventory.
+                  "saleStartDate": "A String", # Sale start date.
                  "availability": "A String", # Availability of product inventory.
                  "channel": "A String", # Channel of product inventory (one of: online, local).
+                  "saleEndDate": "A String", # Sale end date.
                },
              ],
              "author": { # Author of product.
diff --git a/docs/dyn/siteVerification.v1.webResource.html b/docs/dyn/siteVerification.v1.webResource.html index 03c0c71..826e173 100644 --- a/docs/dyn/siteVerification.v1.webResource.html +++ b/docs/dyn/siteVerification.v1.webResource.html @@ -17,11 +17,19 @@
delete = method(self, **kwargs)
Relinquish ownership of a website or domain.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: string, The id of a verified site or domain. (required)
get = method(self, **kwargs)
Get the most current data for a website or domain.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: string, The id of a verified site or domain. (required)
 
Returns:
@@ -52,6 +60,10 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -78,7 +90,11 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
  verificationMethod: string, The method to use for verifying a site or domain. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -97,6 +113,10 @@ Returns:
list = method(self, **kwargs)
Get the list of your verified websites and domains.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -133,6 +153,10 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: string, The id of a verified site or domain. (required)
 
Returns:
@@ -166,6 +190,10 @@ Args:
    },
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
  id: string, The id of a verified site or domain. (required)
 
Returns:
diff --git a/docs/dyn/taskqueue.v1beta2.html b/docs/dyn/taskqueue.v1beta2.html new file mode 100644 index 0000000..de5877c --- /dev/null +++ b/docs/dyn/taskqueue.v1beta2.html @@ -0,0 +1,30 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
taskqueues = methodResource(self)
A collection resource.
+ +
tasks = methodResource(self)
A collection resource.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/taskqueue.v1beta2.taskqueues.html b/docs/dyn/taskqueue.v1beta2.taskqueues.html new file mode 100644 index 0000000..e3a9d0c --- /dev/null +++ b/docs/dyn/taskqueue.v1beta2.taskqueues.html @@ -0,0 +1,63 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
get = method(self, **kwargs)
Get detailed information about a TaskQueue.
+ 
+Args:
+  project: string, The project under which the queue lies. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  taskqueue: string, The id of the taskqueue to get the properties of. (required)
+  strict: string, A parameter
+  getStats: boolean, Whether to get stats. Optional.
+  userip: string, A parameter
+ 
+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:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/taskqueue.v1beta2.tasks.html b/docs/dyn/taskqueue.v1beta2.tasks.html new file mode 100644 index 0000000..94af291 --- /dev/null +++ b/docs/dyn/taskqueue.v1beta2.tasks.html @@ -0,0 +1,233 @@ + + +Python: class Resource + +

+ + + + + + + +
 
+class Resource(__builtin__.object)
   A class for interacting with a resource.
 
 Methods defined here:
+
__init__(self)
+ +
delete = method(self, **kwargs)
Delete a task from a TaskQueue.
+ 
+Args:
+  project: string, The project under which the queue lies. (required)
+  pp: string, A parameter
+  task: string, The id of the task to delete. (required)
+  trace: string, A parameter
+  taskqueue: string, The taskqueue to delete a task from. (required)
+  strict: string, A parameter
+  userip: string, A parameter
+ +
get = method(self, **kwargs)
Get a particular task from a TaskQueue.
+ 
+Args:
+  project: string, The project under which the queue lies. (required)
+  pp: string, A parameter
+  task: string, The task to get properties of. (required)
+  trace: string, A parameter
+  taskqueue: string, The taskqueue in which the task belongs. (required)
+  strict: string, A parameter
+  userip: string, A parameter
+ 
+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.
+      "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.
+      "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.
+    }
+ +
insert = method(self, **kwargs)
Insert a new task in a TaskQueue
+ 
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "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.
+    "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.
+    "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.
+  }
+ 
+  project: string, The project under which the queue lies (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  taskqueue: string, The taskqueue to insert the task into (required)
+  strict: string, A parameter
+  userip: string, A parameter
+ 
+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.
+      "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.
+      "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.
+ 
+Args:
+  groupByTag: boolean, When true, all returned tasks will have the same tag
+  project: string, The project under which the queue lies. (required)
+  pp: string, A parameter
+  leaseSecs: integer, The lease in seconds. (required)
+  taskqueue: string, The taskqueue to lease a task from. (required)
+  strict: string, A parameter
+  userip: string, A parameter
+  tag: string, The tag allowed for tasks in the response. Must only be specified if group_by_tag is true. If group_by_tag is true and tag is not specified the tag will be that of the oldest task by eta, i.e. the first available tag
+  trace: string, A parameter
+  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.
+          "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.
+          "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:
+  project: string, The project under which the queue lies. (required)
+  pp: string, A parameter
+  trace: string, A parameter
+  taskqueue: string, The id of the taskqueue to list tasks from. (required)
+  strict: string, A parameter
+  userip: string, A parameter
+ 
+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.
+          "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.
+          "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.
+  }
+ +
patch = method(self, **kwargs)
Update tasks that are leased out of a TaskQueue. This method supports patch semantics.
+ 
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "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.
+    "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.
+    "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.
+  }
+ 
+  project: string, The project under which the queue lies. (required)
+  pp: string, A parameter
+  task: string, A parameter (required)
+  newLeaseSeconds: integer, The new lease in seconds. (required)
+  trace: string, A parameter
+  taskqueue: string, A parameter (required)
+  strict: string, A parameter
+  userip: string, A parameter
+ 
+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.
+      "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.
+      "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.
+    }
+ +
update = method(self, **kwargs)
Update tasks that are leased out of a TaskQueue.
+ 
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+ 
+{
+    "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.
+    "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.
+    "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.
+  }
+ 
+  project: string, The project under which the queue lies. (required)
+  pp: string, A parameter
+  task: string, A parameter (required)
+  newLeaseSeconds: integer, The new lease in seconds. (required)
+  trace: string, A parameter
+  taskqueue: string, A parameter (required)
+  strict: string, A parameter
+  userip: string, A parameter
+ 
+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.
+      "tag": "A String", # Tag for the task, could be used later to lease tasks grouped by a specific tag.
+      "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.
+    }
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/tasks.v1.tasklists.html b/docs/dyn/tasks.v1.tasklists.html index c7ce7a2..9434b71 100644 --- a/docs/dyn/tasks.v1.tasklists.html +++ b/docs/dyn/tasks.v1.tasklists.html @@ -17,12 +17,20 @@

delete = method(self, **kwargs)
Deletes the authenticated user's specified task list.
 
Args:
-  tasklist: string, Task list identifier. (required)
+  pp: string, A parameter
+  tasklist: string, Task list identifier. (required)
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
get = method(self, **kwargs)
Returns the authenticated user's specified task list.
 
Args:
+  pp: string, A parameter
  tasklist: string, Task list identifier. (required)
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -51,6 +59,10 @@ Args:
    "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -67,8 +79,12 @@ Returns:
list = method(self, **kwargs)
Returns all the authenticated user's task lists.
 
Args:
+  pp: string, A parameter
+  trace: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -114,7 +130,11 @@ Args:
    "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
  }
 
+  pp: string, A parameter
  tasklist: string, Task list identifier. (required)
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -143,7 +163,11 @@ Args:
    "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
  }
 
+  pp: string, A parameter
  tasklist: string, Task list identifier. (required)
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/tasks.v1.tasks.html b/docs/dyn/tasks.v1.tasks.html index 83b9b96..f9effc4 100644 --- a/docs/dyn/tasks.v1.tasks.html +++ b/docs/dyn/tasks.v1.tasks.html @@ -17,19 +17,31 @@
clear = method(self, **kwargs)
Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.
 
Args:
-  tasklist: string, Task list identifier. (required)
+  pp: string, A parameter
+  tasklist: string, Task list identifier. (required)
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
delete = method(self, **kwargs)
Deletes the specified task from the task list.
 
Args:
+  pp: string, A parameter
  tasklist: string, Task list identifier. (required)
-  task: string, Task identifier. (required)
+  trace: string, A parameter
+  strict: string, A parameter
+  task: string, Task identifier. (required)
+  userip: string, A parameter
get = method(self, **kwargs)
Returns the specified task.
 
Args:
+  pp: string, A parameter
  tasklist: string, Task list identifier. (required)
+  trace: string, A parameter
+  strict: string, A parameter
  task: string, Task identifier. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -88,8 +100,12 @@ Args:
    "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
  }
 
+  pp: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
+  trace: string, A parameter
  previous: string, Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.
 
Returns:
@@ -122,17 +138,21 @@ Returns:
list = method(self, **kwargs)
Returns all tasks in the specified task list.
 
Args:
-  dueMax: string, Upper 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.
-  tasklist: string, Task list identifier. (required)
-  pageToken: string, Token specifying the result page to return. Optional.
-  updatedMin: string, Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
-  maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.
-  completedMin: string, Lower 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.
-  showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.
-  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.
+  dueMax: string, Upper 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.
+  pageToken: string, Token specifying the result page to return. Optional.
+  updatedMin: string, Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
+  showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.
+  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.
+  strict: string, A parameter
+  tasklist: string, Task list identifier. (required)
+  trace: string, A parameter
+  pp: string, A parameter
+  maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.
+  completedMin: string, Lower 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.
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -181,9 +201,13 @@ Returns:
move = method(self, **kwargs)
Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks.
 
Args:
+  pp: string, A parameter
  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.
+  strict: string, A parameter
+  userip: string, A parameter
  task: string, Task identifier. (required)
+  trace: string, A parameter
  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:
@@ -243,8 +267,12 @@ Args:
    "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
  }
 
+  pp: string, A parameter
  tasklist: string, Task list identifier. (required)
+  trace: string, A parameter
+  strict: string, A parameter
  task: string, Task identifier. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -303,8 +331,12 @@ Args:
    "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
  }
 
+  pp: string, A parameter
  tasklist: string, Task list identifier. (required)
+  trace: string, A parameter
+  strict: string, A parameter
  task: string, Task identifier. (required)
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/translate.v2.detections.html b/docs/dyn/translate.v2.detections.html index d384d00..b0dd6f6 100644 --- a/docs/dyn/translate.v2.detections.html +++ b/docs/dyn/translate.v2.detections.html @@ -18,6 +18,10 @@  
Args:
  q: string, The text to detect (required) (repeated)
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/translate.v2.languages.html b/docs/dyn/translate.v2.languages.html index 4178c45..cbcc451 100644 --- a/docs/dyn/translate.v2.languages.html +++ b/docs/dyn/translate.v2.languages.html @@ -17,7 +17,11 @@
list = method(self, **kwargs)
List the source/target languages supported by the API
 
Args:
+  pp: string, A parameter
  target: string, the language and collation in which the localized results should be returned
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/translate.v2.translations.html b/docs/dyn/translate.v2.translations.html index 8992683..aa78ba9 100644 --- a/docs/dyn/translate.v2.translations.html +++ b/docs/dyn/translate.v2.translations.html @@ -17,14 +17,18 @@
list = method(self, **kwargs)
Returns text translations from one language to another.
 
Args:
+  q: string, The text to translate (required) (repeated)
+  pp: string, A parameter
  target: string, The target language into which the text should be translated (required)
-  cid: string, The customization id for translate (repeated)
  format: string, The format of the text
    Allowed values
      html - Specifies the input is in HTML
      text - Specifies the input is in plain textual format
-  q: string, The text to translate (required) (repeated)
+  cid: string, The customization id for translate (repeated)
  source: string, The source language of the text
+  userip: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/urlshortener.v1.url.html b/docs/dyn/urlshortener.v1.url.html index 48cbe55..f8bc0b5 100644 --- a/docs/dyn/urlshortener.v1.url.html +++ b/docs/dyn/urlshortener.v1.url.html @@ -17,12 +17,16 @@
get = method(self, **kwargs)
Expands a short URL or gets creation time and analytics.
 
Args:
+  pp: string, A parameter
  projection: string, Additional information to return.
    Allowed values
      ANALYTICS_CLICKS - Returns only click counts.
      ANALYTICS_TOP_STRINGS - Returns only top string counts.
      FULL - Returns the creation timestamp and all available analytics.
+  trace: string, A parameter
  shortUrl: string, The short URL, including the protocol. (required)
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -333,6 +337,10 @@ Args:
    "id": "A String", # Short URL, e.g. "http://goo.gl/l6MS".
  }
 
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
@@ -491,10 +499,14 @@ Returns:
 
Args:
  start_token: string, Token for requesting successive pages of results.
+  pp: string, A parameter
  projection: string, Additional information to return.
    Allowed values
      ANALYTICS_CLICKS - Returns short URL click counts.
      FULL - Returns short URL click counts.
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/dyn/webfonts.v1.webfonts.html b/docs/dyn/webfonts.v1.webfonts.html index 5df6ea9..a3e7e68 100644 --- a/docs/dyn/webfonts.v1.webfonts.html +++ b/docs/dyn/webfonts.v1.webfonts.html @@ -24,6 +24,10 @@ Args:
      popularity - Sort by popularity
      style - Sort by number of styles
      trending - Sort by trending
+  pp: string, A parameter
+  trace: string, A parameter
+  strict: string, A parameter
+  userip: string, A parameter
 
Returns:
  An object of the form
diff --git a/docs/epy/api-objects.txt b/docs/epy/api-objects.txt index ad81fdb..e1bef82 100644 --- a/docs/epy/api-objects.txt +++ b/docs/epy/api-objects.txt @@ -1,13 +1,6 @@ apiclient apiclient-module.html apiclient.__package__ apiclient-module.html#__package__ -apiclient.contrib apiclient.contrib-module.html -apiclient.contrib.__package__ apiclient.contrib-module.html#__package__ -apiclient.contrib.latitude apiclient.contrib.latitude-module.html -apiclient.contrib.latitude.__package__ apiclient.contrib.latitude-module.html#__package__ -apiclient.contrib.moderator apiclient.contrib.moderator-module.html -apiclient.contrib.moderator.__package__ apiclient.contrib.moderator-module.html#__package__ apiclient.discovery apiclient.discovery-module.html -apiclient.discovery._fix_method_name apiclient.discovery-module.html#_fix_method_name apiclient.discovery.VARNAME apiclient.discovery-module.html#VARNAME apiclient.discovery._cast apiclient.discovery-module.html#_cast apiclient.discovery.MULTIPLIERS apiclient.discovery-module.html#MULTIPLIERS @@ -22,7 +15,7 @@ apiclient.discovery.RESERVED_WORDS apiclient.discovery-module.html#RESERVED_WORD apiclient.discovery.logger apiclient.discovery-module.html#logger apiclient.discovery.DEFAULT_METHOD_DOC apiclient.discovery-module.html#DEFAULT_METHOD_DOC apiclient.discovery.STACK_QUERY_PARAMETERS apiclient.discovery-module.html#STACK_QUERY_PARAMETERS -apiclient.discovery._write_headers apiclient.discovery-module.html#_write_headers +apiclient.discovery.fix_method_name apiclient.discovery-module.html#fix_method_name apiclient.discovery.DISCOVERY_URI apiclient.discovery-module.html#DISCOVERY_URI apiclient.discovery.URITEMPLATE apiclient.discovery-module.html#URITEMPLATE apiclient.errors apiclient.errors-module.html @@ -32,6 +25,7 @@ apiclient.ext.__package__ apiclient.ext-module.html#__package__ apiclient.http apiclient.http-module.html apiclient.http.set_user_agent apiclient.http-module.html#set_user_agent apiclient.http.tunnel_patch apiclient.http-module.html#tunnel_patch +apiclient.http.DEFAULT_CHUNK_SIZE apiclient.http-module.html#DEFAULT_CHUNK_SIZE apiclient.http.__package__ apiclient.http-module.html#__package__ apiclient.mimeparse apiclient.mimeparse-module.html apiclient.mimeparse.__credits__ apiclient.mimeparse-module.html#__credits__ @@ -65,10 +59,12 @@ oauth2client.client oauth2client.client-module.html oauth2client.client._extract_id_token oauth2client.client-module.html#_extract_id_token oauth2client.client._cached_http oauth2client.client-module.html#_cached_http oauth2client.client.ID_TOKEN_VERIFICATON_CERTS oauth2client.client-module.html#ID_TOKEN_VERIFICATON_CERTS -oauth2client.client.flow_from_clientsecrets oauth2client.client-module.html#flow_from_clientsecrets +oauth2client.client.credentials_from_clientsecrets_and_code oauth2client.client-module.html#credentials_from_clientsecrets_and_code oauth2client.client.__package__ oauth2client.client-module.html#__package__ -oauth2client.client.logger oauth2client.client-module.html#logger +oauth2client.client.flow_from_clientsecrets oauth2client.client-module.html#flow_from_clientsecrets +oauth2client.client.credentials_from_code oauth2client.client-module.html#credentials_from_code oauth2client.client._abstract oauth2client.client-module.html#_abstract +oauth2client.client.logger oauth2client.client-module.html#logger oauth2client.client.OOB_CALLBACK_URN oauth2client.client-module.html#OOB_CALLBACK_URN oauth2client.client.HAS_OPENSSL oauth2client.client-module.html#HAS_OPENSSL oauth2client.client.EXPIRY_FORMAT oauth2client.client-module.html#EXPIRY_FORMAT @@ -99,6 +95,9 @@ oauth2client.django_orm oauth2client.django_orm-module.html oauth2client.django_orm.__package__ oauth2client.django_orm-module.html#__package__ oauth2client.file oauth2client.file-module.html oauth2client.file.__package__ oauth2client.file-module.html#__package__ +oauth2client.locked_file oauth2client.locked_file-module.html +oauth2client.locked_file.logger oauth2client.locked_file-module.html#logger +oauth2client.locked_file.__package__ oauth2client.locked_file-module.html#__package__ oauth2client.multistore_file oauth2client.multistore_file-module.html oauth2client.multistore_file._multistores_lock oauth2client.multistore_file-module.html#_multistores_lock oauth2client.multistore_file.get_credential_storage oauth2client.multistore_file-module.html#get_credential_storage @@ -150,6 +149,7 @@ apiclient.http.HttpMockSequence.__init__ apiclient.http.HttpMockSequence-class.h apiclient.http.HttpRequest apiclient.http.HttpRequest-class.html apiclient.http.HttpRequest.from_json apiclient.http.HttpRequest-class.html#from_json apiclient.http.HttpRequest.execute apiclient.http.HttpRequest-class.html#execute +apiclient.http.HttpRequest._process_response apiclient.http.HttpRequest-class.html#_process_response apiclient.http.HttpRequest.next_chunk apiclient.http.HttpRequest-class.html#next_chunk apiclient.http.HttpRequest.to_json apiclient.http.HttpRequest-class.html#to_json apiclient.http.HttpRequest.__init__ apiclient.http.HttpRequest-class.html#__init__ @@ -178,6 +178,16 @@ apiclient.http.MediaInMemoryUpload.chunksize apiclient.http.MediaInMemoryUpload- apiclient.http.MediaInMemoryUpload.getbytes apiclient.http.MediaInMemoryUpload-class.html#getbytes apiclient.http.MediaInMemoryUpload.mimetype apiclient.http.MediaInMemoryUpload-class.html#mimetype apiclient.http.MediaInMemoryUpload.resumable apiclient.http.MediaInMemoryUpload-class.html#resumable +apiclient.http.MediaIoBaseUpload apiclient.http.MediaIoBaseUpload-class.html +apiclient.http.MediaIoBaseUpload.to_json apiclient.http.MediaIoBaseUpload-class.html#to_json +apiclient.http.MediaUpload.new_from_json apiclient.http.MediaUpload-class.html#new_from_json +apiclient.http.MediaIoBaseUpload.__init__ apiclient.http.MediaIoBaseUpload-class.html#__init__ +apiclient.http.MediaIoBaseUpload.size apiclient.http.MediaIoBaseUpload-class.html#size +apiclient.http.MediaUpload._to_json apiclient.http.MediaUpload-class.html#_to_json +apiclient.http.MediaIoBaseUpload.chunksize apiclient.http.MediaIoBaseUpload-class.html#chunksize +apiclient.http.MediaIoBaseUpload.getbytes apiclient.http.MediaIoBaseUpload-class.html#getbytes +apiclient.http.MediaIoBaseUpload.mimetype apiclient.http.MediaIoBaseUpload-class.html#mimetype +apiclient.http.MediaIoBaseUpload.resumable apiclient.http.MediaIoBaseUpload-class.html#resumable apiclient.http.MediaUpload apiclient.http.MediaUpload-class.html apiclient.http.MediaUpload.to_json apiclient.http.MediaUpload-class.html#to_json apiclient.http.MediaUpload.new_from_json apiclient.http.MediaUpload-class.html#new_from_json @@ -500,6 +510,36 @@ oauth2client.file.Storage._create_file_if_needed oauth2client.file.Storage-class oauth2client.client.Storage.put oauth2client.client.Storage-class.html#put oauth2client.file.Storage.release_lock oauth2client.file.Storage-class.html#release_lock oauth2client.client.Storage.delete oauth2client.client.Storage-class.html#delete +oauth2client.locked_file.AlreadyLockedException oauth2client.locked_file.AlreadyLockedException-class.html +oauth2client.locked_file.LockedFile oauth2client.locked_file.LockedFile-class.html +oauth2client.locked_file.LockedFile.open_and_lock oauth2client.locked_file.LockedFile-class.html#open_and_lock +oauth2client.locked_file.LockedFile.file_handle oauth2client.locked_file.LockedFile-class.html#file_handle +oauth2client.locked_file.LockedFile.is_locked oauth2client.locked_file.LockedFile-class.html#is_locked +oauth2client.locked_file.LockedFile.unlock_and_close oauth2client.locked_file.LockedFile-class.html#unlock_and_close +oauth2client.locked_file.LockedFile.filename oauth2client.locked_file.LockedFile-class.html#filename +oauth2client.locked_file.LockedFile.__init__ oauth2client.locked_file.LockedFile-class.html#__init__ +oauth2client.locked_file._FcntlOpener oauth2client.locked_file._FcntlOpener-class.html +oauth2client.locked_file._FcntlOpener.open_and_lock oauth2client.locked_file._FcntlOpener-class.html#open_and_lock +oauth2client.locked_file._Opener.file_handle oauth2client.locked_file._Opener-class.html#file_handle +oauth2client.locked_file._Opener.is_locked oauth2client.locked_file._Opener-class.html#is_locked +oauth2client.locked_file._Opener.filename oauth2client.locked_file._Opener-class.html#filename +oauth2client.locked_file._FcntlOpener.unlock_and_close oauth2client.locked_file._FcntlOpener-class.html#unlock_and_close +oauth2client.locked_file._Opener.__init__ oauth2client.locked_file._Opener-class.html#__init__ +oauth2client.locked_file._Opener oauth2client.locked_file._Opener-class.html +oauth2client.locked_file._Opener.open_and_lock oauth2client.locked_file._Opener-class.html#open_and_lock +oauth2client.locked_file._Opener.file_handle oauth2client.locked_file._Opener-class.html#file_handle +oauth2client.locked_file._Opener.is_locked oauth2client.locked_file._Opener-class.html#is_locked +oauth2client.locked_file._Opener.unlock_and_close oauth2client.locked_file._Opener-class.html#unlock_and_close +oauth2client.locked_file._Opener.filename oauth2client.locked_file._Opener-class.html#filename +oauth2client.locked_file._Opener.__init__ oauth2client.locked_file._Opener-class.html#__init__ +oauth2client.locked_file._PosixOpener oauth2client.locked_file._PosixOpener-class.html +oauth2client.locked_file._PosixOpener.open_and_lock oauth2client.locked_file._PosixOpener-class.html#open_and_lock +oauth2client.locked_file._Opener.file_handle oauth2client.locked_file._Opener-class.html#file_handle +oauth2client.locked_file._Opener.is_locked oauth2client.locked_file._Opener-class.html#is_locked +oauth2client.locked_file._PosixOpener._posix_lockfile oauth2client.locked_file._PosixOpener-class.html#_posix_lockfile +oauth2client.locked_file._Opener.filename oauth2client.locked_file._Opener-class.html#filename +oauth2client.locked_file._PosixOpener.unlock_and_close oauth2client.locked_file._PosixOpener-class.html#unlock_and_close +oauth2client.locked_file._Opener.__init__ oauth2client.locked_file._Opener-class.html#__init__ oauth2client.multistore_file.Error oauth2client.multistore_file.Error-class.html oauth2client.multistore_file.NewerCredentialStoreError oauth2client.multistore_file.NewerCredentialStoreError-class.html oauth2client.multistore_file._MultiStore oauth2client.multistore_file._MultiStore-class.html diff --git a/docs/epy/apiclient-module.html b/docs/epy/apiclient-module.html index 043bb97..9116cb7 100644 --- a/docs/epy/apiclient-module.html +++ b/docs/epy/apiclient-module.html @@ -75,12 +75,6 @@
    -
  • apiclient.contrib - -
  • apiclient.discovery: Client for discovery based APIs
  • apiclient.errors: Errors for the library.
  • apiclient.ext
    • @@ -140,7 +134,7 @@ - - -
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:54 2012
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:11 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:59 2012 - + - -
    _fix_method_name(name)fix_method_name(name)
    + Fix method names to avoid reserved word conflicts.    		 - source code - -
    - -
    -   - - - - - @@ -132,13 +117,13 @@ A client library for Google's discovery based APIs. - +
    _write_headers(self) - source code + source code
      - - +
    key2param(key)
    +     		key2param(key)
    Converts key names into parameter names.    		 source code @@ -172,13 +157,13 @@ A client library for Google's discovery based APIs.
      -
    build_from_document(service, + build_from_document(service, base, future=None, http=None, @@ -219,7 +204,7 @@ A client library for Google's discovery based APIs. -
    _media_size_to_long(maxSize)
    +     		_media_size_to_long(maxSize)
    Convert a string media size, such as 10GB or 3TB into an integer.    		 source code @@ -236,14 +221,15 @@ A client library for Google's discovery based APIs. - + rootDesc, + schema)
    + Build a Resource from the API description. @@ -361,6 +347,34 @@ A client library for Google's discovery based APIs.
    createResource(http, + createResource(http, baseUrl, model, requestBuilder, developerKey, resourceDesc, - futureDesc, - schema) source code @@ -310,7 +296,7 @@ A client library for Google's discovery based APIs.   - STACK_QUERY_PARAMETERS = ['trace', 'fields', 'pp', 'prettyPrin... + STACK_QUERY_PARAMETERS = ['trace', 'pp', 'userip', 'strict']
    + +
    + +
    + + +
    +

    fix_method_name(name) +

    +     		source code  +
    + + 
    +Fix method names to avoid reserved word conflicts.
+
+Args:
+  name: string, method name.
+
+Returns:
+  The name with a '_' prefixed if the name is a reserved word.
+
+
    +
    +
    +
    +
    -
    +
    @@ -414,6 +428,12 @@ Converts key names into parameter names. For example, converting "max-results" -> "max_results" +Args: + key: string, the method key name. + +Returns: + A safe method name based on the key name. +
    @@ -442,29 +462,26 @@ For example, converting "max-results" -> "max_results" 
     Construct a Resource for interacting with an API.
 
-Construct a Resource object for interacting with
-an API. The serviceName and version are the
-names from the Discovery service.
+Construct a Resource object for interacting with an API. The serviceName and
+version are the names from the Discovery service.
 
 Args:
-  serviceName: string, name of the service
-  version: string, the version of the service
+  serviceName: string, name of the service.
+  version: string, the version of the service.
   http: httplib2.Http, An instance of httplib2.Http or something that acts
     like it that HTTP requests will be made through.
-  discoveryServiceUrl: string, a URI Template that points to
-    the location of the discovery service. It should have two
-    parameters {api} and {apiVersion} that when filled in
-    produce an absolute URI to the discovery document for
-    that service.
-  developerKey: string, key obtained
-    from https://code.google.com/apis/console
-  model: apiclient.Model, converts to and from the wire format
-  requestBuilder: apiclient.http.HttpRequest, encapsulator for
-    an HTTP request
+  discoveryServiceUrl: string, a URI Template that points to the location of
+    the discovery service. It should have two parameters {api} and
+    {apiVersion} that when filled in produce an absolute URI to the discovery
+    document for that service.
+  developerKey: string, key obtained from
+    https://code.google.com/apis/console.
+  model: apiclient.Model, converts to and from the wire format.
+  requestBuilder: apiclient.http.HttpRequest, encapsulator for an HTTP
+    request.
 
 Returns:
-  A Resource object with methods for interacting with
-  the service.
+  A Resource object with methods for interacting with the service.
    @@ -472,7 +489,7 @@ Returns:
    -
    +
    @@ -494,26 +511,23 @@ Returns: 
     Create a Resource for interacting with an API.
 
-Same as `build()`, but constructs the Resource object
-from a discovery document that is it given, as opposed to
-retrieving one over HTTP.
+Same as `build()`, but constructs the Resource object from a discovery
+document that is it given, as opposed to retrieving one over HTTP.
 
 Args:
-  service: string, discovery document
-  base: string, base URI for all HTTP requests, usually the discovery URI
-  future: string, discovery document with future capabilities
-  auth_discovery: dict, information about the authentication the API supports
+  service: string, discovery document.
+  base: string, base URI for all HTTP requests, usually the discovery URI.
+  future: string, discovery document with future capabilities (deprecated).
   http: httplib2.Http, An instance of httplib2.Http or something that acts
     like it that HTTP requests will be made through.
   developerKey: string, Key for controlling API usage, generated
     from the API Console.
-  model: Model class instance that serializes and
-    de-serializes requests and responses.
+  model: Model class instance that serializes and de-serializes requests and
+    responses.
   requestBuilder: Takes an http request and packages it up to be executed.
 
 Returns:
-  A Resource object with methods for interacting with
-  the service.
+  A Resource object with methods for interacting with the service.
    @@ -548,6 +562,82 @@ Args: Returns: A string representation of 'value' based on the schema_type. + +
    +
    +
    +
    + +
    + +
    + + +
    +

    _media_size_to_long(maxSize) +

    +     		source code  +
    + + 
    +Convert a string media size, such as 10GB or 3TB into an integer.
+
+Args:
+  maxSize: string, size as a string, such as 2MB or 7GB.
+
+Returns:
+  The size as an integer value.
+
+
    +
    +
    +
    +
    + +
    + +
    + + +
    +

    createResource(http, + baseUrl, + model, + requestBuilder, + developerKey, + resourceDesc, + rootDesc, + schema) +

    +     		source code  +
    + + 
    +Build a Resource from the API description.
+
+Args:
+  http: httplib2.Http, Object to make http requests with.
+  baseUrl: string, base URL for the API. All requests are relative to this
+    URI.
+  model: apiclient.Model, converts to and from the wire format.
+  requestBuilder: class or callable that instantiates an
+    apiclient.HttpRequest object.
+  developerKey: string, key obtained from
+    https://code.google.com/apis/console
+  resourceDesc: object, section of deserialized discovery document that
+    describes a resource. Note that the top level discovery document
+    is considered a resource.
+  rootDesc: object, the entire deserialized discovery document.
+  schema: object, mapping of schema names to schema descriptions.
+
+Returns:
+  An instance of Resource with all the methods attached for interacting with
+  that resource.
+
    @@ -590,24 +680,6 @@ Returns:
    - -
    - -
    -

    STACK_QUERY_PARAMETERS

    - -
    -
    -
    -
    Value:
    - 
    -['trace', 'fields', 'pp', 'prettyPrint', 'userIp', 'userip', 'strict']
-
    -
    -
    -
    -
    - - - - - -
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:54 2012 19 20 __author__ = 'jcgregorio@google.com (Joe Gregorio)' 21 __all__ = [ - 22 'build', 'build_from_document' - 23 ] - 24 - 25 import copy - 26 import httplib2 - 27 import logging - 28 import os - 29 import random - 30 import re - 31 import uritemplate - 32 import urllib - 33 import urlparse - 34 import mimeparse - 35 import mimetypes - 36 - 37 try: - 38 from urlparse import parse_qsl - 39 except ImportError: - 40 from cgi import parse_qsl - 41 - 42 from apiclient.errors import HttpError - 43 from apiclient.errors import InvalidJsonError - 44 from apiclient.errors import MediaUploadSizeError - 45 from apiclient.errors import UnacceptableMimeTypeError - 46 from apiclient.errors import UnknownApiNameOrVersion - 47 from apiclient.errors import UnknownLinkType - 48 from apiclient. 22 'build', + 23 'build_from_document' + 24 'fix_method_name', + 25 'key2param' + 26 ] + 27 + 28 import copy + 29 import httplib2 + 30 import logging + 31 import os + 32 import random + 33 import re + 34 import uritemplate + 35 import urllib + 36 import urlparse + 37 import mimeparse + 38 import mimetypes + 39 + 40 try: + 41 from urlparse import parse_qsl + 42 except ImportError: + 43 from cgi import parse_qsl + 44 + 45 from apiclient.errors import HttpError + 46 from apiclient.errors import InvalidJsonError + 47 from apiclient.errors import MediaUploadSizeError + 48 from apiclient.errors import UnacceptableMimeTypeError + 49 from apiclient.errors import UnknownApiNameOrVersion + 50 from apiclient.errors import UnknownLinkType + 51 from apiclient.http import HttpRequest - 49 from apiclient. 52 from apiclient.http import MediaFileUpload - 50 from apiclient. 53 from apiclient.http import MediaUpload - 51 from apiclient.model import JsonModel - 52 from apiclient.model import RawModel - 53 from apiclient.schema import Schemas - 54 from email.mime.multipart import MIMEMultipart - 55 from email.mime.nonmultipart import MIMENonMultipart - 56 from oauth2client.anyjson import simplejson - 57 - 58 54 from apiclient.model import JsonModel + 55 from apiclient.model import RawModel + 56 from apiclient.schema import Schemas + 57 from email.mime.multipart import MIMEMultipart + 58 from email.mime.nonmultipart import MIMENonMultipart + 59 from oauth2client.anyjson import simplejson + 60 + 61 logger = logging.getLogger(__name__) - 59 - 60 URITEMPLATE = re.compile('{[^}]*}') - 61 VARNAME = re.compile('[a-zA-Z0-9_-]+') - 62 DISCOVERY_URI = ('https://www.googleapis.com/discovery/v1/apis/' - 63 '{api}/{apiVersion}/rest') - 64 DEFAULT_METHOD_DOC = 'A description of how to use this function' - 65 - 66 # Query parameters that work, but don't appear in discovery - 67 STACK_QUERY_PARAMETERS = ['trace', 'fields', 'pp', 'prettyPrint', 'userIp', - 68 'userip', 'strict'] - 69 - 70 RESERVED_WORDS = ['and', 'assert', 'break', 'class', 'continue', 'def', 'del', - 71 'elif', 'else', 'except', 'exec', 'finally', 'for', 'from', - 72 'global', 'if', 'import', 'in', 'is', 'lambda', 'not', 'or', - 73 'pass', 'print', 'raise', 'return', 'try', 'while' ] - 74 - 75 -
    76 -def _fix_method_name(name): -
    77 if name in RESERVED_WORDS: - 78 return name + '_' - 79 else: - 80 return name -
    81 - 82 -
    83 -def _write_headers(self): -
    84 # Utility no-op method for multipart media handling - 85 pass -
    86 - 87 -
    88 -def _add_query_parameter(url, name, value): -
    89 """Adds a query parameter to a url. - 90 - 91 Replaces the current value if it already exists in the URL. - 92 - 93 Args: - 94 url: string, url to add the query parameter to. - 95 name: string, query parameter name. - 96 value: string, query parameter value. - 97 - 98 Returns: - 99 Updated query parameter. Does not update the url if value is None. -100 """ -101 if value is None: -102 return url -103 else: -104 parsed = list(urlparse.urlparse(url)) -105 q = dict(parse_qsl(parsed[4])) -106 q[name] = value -107 parsed[4] = urllib.urlencode(q) -108 return urlparse.urlunparse(parsed) -
    109 -110 -
    111 -def key2param(key): -
    112 """Converts key names into parameter names. -113 -114 For example, converting "max-results" -> "max_results" -115 """ -116 result = [] -117 key = list(key) -118 if not key[0].isalpha(): -119 result.append('x') -120 for c in key: -121 if c.isalnum(): -122 result.append(c) -123 else: -124 result.append('_') -125 -126 return ''.join(result) -
    127 -128 -
    129 -def build(serviceName, -130 version, -131 http=None, -132 discoveryServiceUrl=DISCOVERY_URI, -133 developerKey=None, -134 model=None, -135 requestBuilder=HttpRequest): -
    136 """Construct a Resource for interacting with an API. -137 -138 Construct a Resource object for interacting with -139 an API. The serviceName and version are the -140 names from the Discovery service. -141 -142 Args: -143 serviceName: string, name of the service -144 version: string, the version of the service -145 http: httplib2.Http, An instance of httplib2.Http or something that acts -146 like it that HTTP requests will be made through. -147 discoveryServiceUrl: string, a URI Template that points to -148 the location of the discovery service. It should have two -149 parameters {api} and {apiVersion} that when filled in -150 produce an absolute URI to the discovery document for -151 that service. -152 developerKey: string, key obtained -153 from https://code.google.com/apis/console -154 model: apiclient.Model, converts to and from the wire format -155 requestBuilder: apiclient.http.HttpRequest, encapsulator for -156 an HTTP request -157 -158 Returns: -159 A Resource object with methods for interacting with -160 the service. -161 """ -162 params = { -163 'api': serviceName, -164 'apiVersion': version -165 } -166 -167 if 62 + 63 URITEMPLATE = re.compile('{[^}]*}') + 64 VARNAME = re.compile('[a-zA-Z0-9_-]+') + 65 DISCOVERY_URI = ('https://www.googleapis.com/discovery/v1/apis/' + 66 '{api}/{apiVersion}/rest') + 67 DEFAULT_METHOD_DOC = 'A description of how to use this function' + 68 + 69 # Parameters accepted by the stack, but not visible via discovery. + 70 STACK_QUERY_PARAMETERS = ['trace', 'pp', 'userip', 'strict'] + 71 + 72 # Python reserved words. + 73 RESERVED_WORDS = ['and', 'assert', 'break', 'class', 'continue', 'def', 'del', + 74 'elif', 'else', 'except', 'exec', 'finally', 'for', 'from', + 75 'global', 'if', 'import', 'in', 'is', 'lambda', 'not', 'or', + 76 'pass', 'print', 'raise', 'return', 'try', 'while' ] + 77 + 78 +
    79 -def fix_method_name(name): +
    80 """Fix method names to avoid reserved word conflicts. + 81 + 82 Args: + 83 name: string, method name. + 84 + 85 Returns: + 86 The name with a '_' prefixed if the name is a reserved word. + 87 """ + 88 if name in RESERVED_WORDS: + 89 return name + '_' + 90 else: + 91 return name +
    92 + 93 +
    94 -def _add_query_parameter(url, name, value): +
    95 """Adds a query parameter to a url. + 96 + 97 Replaces the current value if it already exists in the URL. + 98 + 99 Args: +100 url: string, url to add the query parameter to. +101 name: string, query parameter name. +102 value: string, query parameter value. +103 +104 Returns: +105 Updated query parameter. Does not update the url if value is None. +106 """ +107 if value is None: +108 return url +109 else: +110 parsed = list(urlparse.urlparse(url)) +111 q = dict(parse_qsl(parsed[4])) +112 q[name] = value +113 parsed[4] = urllib.urlencode(q) +114 return urlparse.urlunparse(parsed) +
    115 +116 +
    117 -def key2param(key): +
    118 """Converts key names into parameter names. +119 +120 For example, converting "max-results" -> "max_results" +121 +122 Args: +123 key: string, the method key name. +124 +125 Returns: +126 A safe method name based on the key name. +127 """ +128 result = [] +129 key = list(key) +130 if not key[0].isalpha(): +131 result.append('x') +132 for c in key: +133 if c.isalnum(): +134 result.append(c) +135 else: +136 result.append('_') +137 +138 return ''.join(result) +
    139 +140 +
    141 -def build(serviceName, +142 version, +143 http=None, +144 discoveryServiceUrl=DISCOVERY_URI, +145 developerKey=None, +146 model=None, +147 requestBuilder=HttpRequest): +
    148 """Construct a Resource for interacting with an API. +149 +150 Construct a Resource object for interacting with an API. The serviceName and +151 version are the names from the Discovery service. +152 +153 Args: +154 serviceName: string, name of the service. +155 version: string, the version of the service. +156 http: httplib2.Http, An instance of httplib2.Http or something that acts +157 like it that HTTP requests will be made through. +158 discoveryServiceUrl: string, a URI Template that points to the location of +159 the discovery service. It should have two parameters {api} and +160 {apiVersion} that when filled in produce an absolute URI to the discovery +161 document for that service. +162 developerKey: string, key obtained from +163 https://code.google.com/apis/console. +164 model: apiclient.Model, converts to and from the wire format. +165 requestBuilder: apiclient.http.HttpRequest, encapsulator for an HTTP +166 request. +167 +168 Returns: +169 A Resource object with methods for interacting with the service. +170 """ +171 params = { +172 'api': serviceName, +173 'apiVersion': version +174 } +175 +176 if http is None: -168 177 http = httplib2.Http() -169 -170 requested_url = uritemplate.expand(discoveryServiceUrl, params) -171 -172 # REMOTE_ADDR is defined by the CGI spec [RFC3875] as the environment -173 # variable that contains the network address of the client sending the -174 # request. If it exists then add that to the request for the discovery -175 # document to avoid exceeding the quota on discovery requests. -176 if 'REMOTE_ADDR' in os.environ: -177 requested_url = _add_query_parameter(requested_url, 'userIp', -178 os.environ['REMOTE_ADDR']) -179 logger.info('URL being requested: %s' % requested_url) +178 +179 requested_url = uritemplate.expand(discoveryServiceUrl, params) 180 -181 resp, content = 181 # REMOTE_ADDR is defined by the CGI spec [RFC3875] as the environment +182 # variable that contains the network address of the client sending the +183 # request. If it exists then add that to the request for the discovery +184 # document to avoid exceeding the quota on discovery requests. +185 if 'REMOTE_ADDR' in os.environ: +186 requested_url = _add_query_parameter(requested_url, 'userIp', +187 os.environ['REMOTE_ADDR']) +188 logger.info('URL being requested: %s' % requested_url) +189 +190 resp, content = http.request(requested_url) -182 -183 if resp.status == 404: -184 raise UnknownApiNameOrVersion("name: %s version: %s" % (serviceName, -185 version)) -186 if resp.status >= 400: -187 raise HttpError(resp, content, requested_url) -188 -189 try: -190 service = simplejson.loads(content) -191 except ValueError, e: -192 191 +192 if resp.status == 404: +193 raise UnknownApiNameOrVersion("name: %s version: %s" % (serviceName, +194 version)) +195 if resp.status >= 400: +196 raise HttpError(resp, content, requested_url) +197 +198 try: +199 service = simplejson.loads(content) +200 except ValueError, e: +201 logger.error('Failed to parse as JSON: ' + content) -193 raise InvalidJsonError() -194 -195 filename = os.path.join(os.path.dirname(__file__), 'contrib', -196 serviceName, 'future.json') -197 try: -198 f = file(filename, 'r') -199 future = f.read() -200 f.close() -201 except IOError: -202 future = None +202 raise InvalidJsonError() 203 -204 return build_from_document(content, discoveryServiceUrl, future, -205 http, developerKey, model, requestBuilder) +204 return build_from_document(content, discoveryServiceUrl, http=http, +205 developerKey=developerKey, model=model, requestBuilder=requestBuilder)
    206 207
    208 -def build_from_document( @@ -283,659 +287,660 @@ oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="r 212 http=None, 213 developerKey=None, 214 model=None, -215 requestBuilder=HttpRequest): +215 requestBuilder=HttpRequest):
    216 """Create a Resource for interacting with an API. 217 -218 Same as `build()`, but constructs the Resource object -219 from a discovery document that is it given, as opposed to -220 retrieving one over HTTP. -221 -222 Args: -223 service: string, discovery document -224 base: string, base URI for all HTTP requests, usually the discovery URI -225 future: string, discovery document with future capabilities -226 auth_discovery: dict, information about the authentication the API supports -227 http: httplib2.Http, An instance of httplib2.Http or something that acts -228 like it that HTTP requests will be made through. -229 developerKey: string, Key for controlling API usage, generated -230 from the API Console. -231 model: Model class instance that serializes and -232 de-serializes requests and responses. -233 requestBuilder: Takes an http request and packages it up to be executed. -234 -235 Returns: -236 A Resource object with methods for interacting with -237 the service. -238 """ +218 Same as `build()`, but constructs the Resource object from a discovery +219 document that is it given, as opposed to retrieving one over HTTP. +220 +221 Args: +222 service: string, discovery document. +223 base: string, base URI for all HTTP requests, usually the discovery URI. +224 future: string, discovery document with future capabilities (deprecated). +225 http: httplib2.Http, An instance of httplib2.Http or something that acts +226 like it that HTTP requests will be made through. +227 developerKey: string, Key for controlling API usage, generated +228 from the API Console. +229 model: Model class instance that serializes and de-serializes requests and +230 responses. +231 requestBuilder: Takes an http request and packages it up to be executed. +232 +233 Returns: +234 A Resource object with methods for interacting with the service. +235 """ +236 +237 # future is no longer used. +238 future = {} 239 -240 service = simplejson.loads(service) +240 service = simplejson.loads(service) 241 base = urlparse.urljoin(base, service['basePath']) -242 if future: -243 future = simplejson.loads(future) -244 auth_discovery = future.242 schema = Schemas(service) +243 +244 if model is None: +245 features = service.get('auth', {}) -245 else: -246 future = {} -247 auth_discovery = {} -248 schema = Schemas(service) +oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-70', 'get', 'link-70');">get('features', []) +246 model = JsonModel('dataWrapper' in features) +247 resource = createResource(http, base, model, requestBuilder, developerKey, +248 service, service, schema) 249 -250 if model is None: -251 features = service.250 return resource +
    251 +252 +
    253 -def _cast(value, schema_type): +
    254 """Convert value to a string based on JSON Schema type. +255 +256 See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on +257 JSON Schema. +258 +259 Args: +260 value: any, the value to convert +261 schema_type: string, the type that value should be interpreted as +262 +263 Returns: +264 A string representation of 'value' based on the schema_type. +265 """ +266 if schema_type == 'string': +267 if type(value) == type('') or type(value) == type(u''): +268 return value +269 else: +270 return str(value) +271 elif schema_type == 'integer': +272 return str(int(value)) +273 elif schema_type == 'number': +274 return str(float(value)) +275 elif schema_type == 'boolean': +276 return str(bool(value)).lower() +277 else: +278 if type(value) == type('') or type(value) == type(u''): +279 return value +280 else: +281 return str(value) +
    282 +283 +284 MULTIPLIERS = { +285 "KB": 2 ** 10, +286 "MB": 2 ** 20, +287 "GB": 2 ** 30, +288 "TB": 2 ** 40, +289 } +290 +291 +
    292 -def _media_size_to_long(maxSize): +
    293 """Convert a string media size, such as 10GB or 3TB into an integer. +294 +295 Args: +296 maxSize: string, size as a string, such as 2MB or 7GB. +297 +298 Returns: +299 The size as an integer value. +300 """ +301 if len(maxSize) < 2: +302 return 0 +303 units = maxSize[-2:].upper() +304 multiplier = MULTIPLIERS.get('features', []) -252 model = JsonModel('dataWrapper' in features) -253 resource = createResource(http, base, model, requestBuilder, developerKey, -254 service, future, schema) -255 -256 def auth_method(): -257 """Discovery information about the authentication the API uses.""" -258 return auth_discovery -
    259 -260 setattr(resource, 'auth_discovery', auth_method) -261 -262 return resource -
    263 -264 -
    265 -def _cast(value, schema_type): -
    266 """Convert value to a string based on JSON Schema type. -267 -268 See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on -269 JSON Schema. -270 -271 Args: -272 value: any, the value to convert -273 schema_type: string, the type that value should be interpreted as -274 -275 Returns: -276 A string representation of 'value' based on the schema_type. -277 """ -278 if schema_type == 'string': -279 if type(value) == type('') or type(value) == type(u''): -280 return value -281 else: -282 return str(value) -283 elif schema_type == 'integer': -284 return str(int(value)) -285 elif schema_type == 'number': -286 return str(float(value)) -287 elif schema_type == 'boolean': -288 return str(bool(value)).lower() -289 else: -290 if type(value) == type('') or type(value) == type(u''): -291 return value -292 else: -293 return str(value) -
    294 -295 MULTIPLIERS = { -296 "KB": 2 ** 10, -297 "MB": 2 ** 20, -298 "GB": 2 ** 30, -299 "TB": 2 ** 40, -300 } -301 -302 -
    303 -def _media_size_to_long(maxSize): -
    304 """Convert a string media size, such as 10GB or 3TB into an integer.""" -305 if len(maxSize) < 2: -306 return 0 -307 units = maxSize[-2:].upper() -308 multiplier = MULTIPLIERS.get(units, 0) -309 if multiplier: -310 return int(maxSize[:-2]) * multiplier -311 else: -312 return int(maxSize) -
    313 -314 -
    315 -def createResource(http, baseUrl, model, requestBuilder, -316 developerKey, resourceDesc, futureDesc, schema): -
    317 -318 class Resource(object): -319 """A class for interacting with a resource.""" -320 -321 def __init__(self): -322 self._http = http -323 self._baseUrl = baseUrl -324 self._model = model -325 self._developerKey = developerKey -326 self._requestBuilder = requestBuilder -
    327 -328 def createMethod(theclass, methodName, methodDesc, futureDesc): -329 methodName = _fix_method_name(methodName) -330 pathUrl = methodDesc['path'] -331 httpMethod = methodDesc['httpMethod'] -332 methodId = methodDesc['id'] -333 -334 mediaPathUrl = None -335 get(units, 0) +305 if multiplier: +306 return int(maxSize[:-2]) * multiplier +307 else: +308 return int(maxSize) +309 +310 +
    311 -def createResource(http, baseUrl, model, requestBuilder, +312 developerKey, resourceDesc, rootDesc, schema): +
    313 """Build a Resource from the API description. +314 +315 Args: +316 http: httplib2.Http, Object to make http requests with. +317 baseUrl: string, base URL for the API. All requests are relative to this +318 URI. +319 model: apiclient.Model, converts to and from the wire format. +320 requestBuilder: class or callable that instantiates an +321 apiclient.HttpRequest object. +322 developerKey: string, key obtained from +323 https://code.google.com/apis/console +324 resourceDesc: object, section of deserialized discovery document that +325 describes a resource. Note that the top level discovery document +326 is considered a resource. +327 rootDesc: object, the entire deserialized discovery document. +328 schema: object, mapping of schema names to schema descriptions. +329 +330 Returns: +331 An instance of Resource with all the methods attached for interacting with +332 that resource. +333 """ +334 +335 class Resource(object): +336 """A class for interacting with a resource.""" +337 +338 def __init__(self): +339 self._http = http +340 self._baseUrl = baseUrl +341 self._model = model +342 self._developerKey = developerKey +343 self._requestBuilder = requestBuilder +
    344 +345 def createMethod(theclass, methodName, methodDesc, rootDesc): +346 """Creates a method for attaching to a Resource. +347 +348 Args: +349 theclass: type, the class to attach methods to. +350 methodName: string, name of the method to use. +351 methodDesc: object, fragment of deserialized discovery document that +352 describes the method. +353 rootDesc: object, the entire deserialized discovery document. +354 """ +355 methodName = fix_method_name(methodName) +356 pathUrl = methodDesc['path'] +357 httpMethod = methodDesc['httpMethod'] +358 methodId = methodDesc['id'] +359 +360 mediaPathUrl = None +361 accept = [] -336 maxSize = 0 -337 if 'mediaUpload' in methodDesc: -338 mediaUpload = methodDesc['mediaUpload'] -339 # TODO(jcgregorio) Use URLs from discovery once it is updated. -340 parsed = list(urlparse.urlparse(baseUrl)) -341 basePath = parsed[2] -342 mediaPathUrl = '/upload' + basePath + pathUrl -343 accept = [] +362 maxSize = 0 +363 if 'mediaUpload' in methodDesc: +364 mediaUpload = methodDesc['mediaUpload'] +365 # TODO(jcgregorio) Use URLs from discovery once it is updated. +366 parsed = list(urlparse.urlparse(baseUrl)) +367 basePath = parsed[2] +368 mediaPathUrl = '/upload' + basePath + pathUrl +369 accept = mediaUpload['accept'] -344 maxSize = _media_size_to_long(mediaUpload.accept = mediaUpload['accept'] +370 maxSize = _media_size_to_long(mediaUpload.get('maxSize', '')) -345 -346 if 'parameters' not in methodDesc: -347 methodDesc['parameters'] = {} -348 for name in STACK_QUERY_PARAMETERS: -349 methodDesc['parameters'][name] = { -350 'type': 'string', -351 'location': 'query' -352 } -353 -354 if httpMethod in ['PUT', 'POST', 'PATCH'] and 'request' in methodDesc: -355 methodDesc['parameters']['body'] = { -356 'description': 'The request body.', -357 'type': 'object', -358 'required': True, -359 } -360 if 'request' in methodDesc: -361 methodDesc['parameters']['body'].update(methodDesc['request']) -362 else: -363 methodDesc['parameters']['body']['type'] = 'object' -364 if 'mediaUpload' in methodDesc: -365 methodDesc['parameters']['media_body'] = { -366 'description': 'The filename of the media request body.', -367 'type': 'string', -368 'required': False, -369 } -370 if 'body' in methodDesc['parameters']: -371 methodDesc['parameters']['body']['required'] = False -372 -373 argmap = {} # Map from method parameter name to query parameter name -374 required_params = [] # Required parameters -375 repeated_params = [] # Repeated parameters -376 pattern_params = {} # Parameters that must match a regex -377 query_params = [] # Parameters that will be used in the query string -378 path_params = {} # Parameters that will be used in the base URL -379 param_type = {} # The type of the parameter -380 enum_params = {} # Allowable enumeration values for each parameter -381 -382 -383 if 'parameters' in methodDesc: -384 for arg, desc in methodDesc['parameters'].iteritems(): -385 param = key2param(arg) -386 argmap[param] = arg -387 -388 if desc.get('maxSize', '')) +371 +372 if 'parameters' not in methodDesc: +373 methodDesc['parameters'] = {} +374 +375 # Add in the parameters common to all methods. +376 for name, desc in rootDesc.get('pattern', ''): -389 pattern_params[param] = desc['pattern'] -390 if desc.get('enum', ''): -391 enum_params[param] = desc['enum'] -392 if desc.get('required', False): -393 required_params.append(param) -394 if desc.get('repeated', False): -395 repeated_params.append(param) -396 if desc.get('location') == 'query': -397 query_params.append(param) -398 if desc.get('location') == 'path': -399 path_params[param] = param -400 param_type[param] = desc.get('type', 'string') -401 -402 for match in URITEMPLATE.finditer(pathUrl): -403 for namematch in VARNAME.finditer(match.group(0)): -404 name = key2param(namematch.group(0)) -405 path_params[name] = name -406 if name in query_params: -407 query_params.remove(name) -408 -409 def method(self, **kwargs): -410 for name in kwargs.iterkeys(): -411 if name not in argmap: -412 raise TypeError('Got an unexpected keyword argument "%s"' % name) +oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-87', 'get', 'link-70');">get    ('parameters', {}).iteritems():     +377 methodDesc['parameters'][name] = desc +378 +379 # Add in undocumented query parameters. +380 for name in STACK_QUERY_PARAMETERS: +381 methodDesc['parameters'][name] = { +382 'type': 'string', +383 'location': 'query' +384 } +385 +386 if httpMethod in ['PUT', 'POST', 'PATCH'] and 'request' in methodDesc: +387 methodDesc['parameters']['body'] = { +388 'description': 'The request body.', +389 'type': 'object', +390 'required': True, +391 } +392 if 'request' in methodDesc: +393 methodDesc['parameters']['body'].update(methodDesc['request']) +394 else: +395 methodDesc['parameters']['body']['type'] = 'object' +396 if 'mediaUpload' in methodDesc: +397 methodDesc['parameters']['media_body'] = { +398 'description': 'The filename of the media request body.', +399 'type': 'string', +400 'required': False, +401 } +402 if 'body' in methodDesc['parameters']: +403 methodDesc['parameters']['body']['required'] = False +404 +405 argmap = {} # Map from method parameter name to query parameter name +406 required_params = [] # Required parameters +407 repeated_params = [] # Repeated parameters +408 pattern_params = {} # Parameters that must match a regex +409 query_params = [] # Parameters that will be used in the query string +410 path_params = {} # Parameters that will be used in the base URL +411 param_type = {} # The type of the parameter +412 enum_params = {} # Allowable enumeration values for each parameter 413 -414 for name in required_params: -415 if name not in kwargs: -416 raise TypeError('Missing required parameter "%s"' % name) -417 -418 for name, regex in pattern_params.iteritems(): -419 if name in kwargs: -420 if isinstance(kwargs[name], basestring): -421 pvalues = [kwargs[name]] -422 else: -423 pvalues = kwargs[name] -424 for pvalue in pvalues: -425 if re.match(regex, pvalue) is None: -426 raise TypeError( -427 'Parameter "%s" value "%s" does not match the pattern "%s"' % -428 (name, pvalue, regex)) -429 -430 for name, enums in enum_params.iteritems(): -431 if name in kwargs: -432 # We need to handle the case of a repeated enum -433 # name differently, since we want to handle both -434 # arg='value' and arg=['value1', 'value2'] -435 if (name in repeated_params and -436 not isinstance(kwargs[name], basestring)): -437 values = kwargs[name] -438 else: -439 values = [kwargs[name]] -440 for value in values: -441 if value not in enums: -442 raise TypeError( -443 'Parameter "%s" value "%s" is not an allowed value in "%s"' % -444 (name, value, str(enums))) -445 -446 actual_query_params = {} -447 actual_path_params = {} -448 for key, value in kwargs.iteritems(): -449 to_type = param_type.414 +415 if 'parameters' in methodDesc: +416 for arg, desc in methodDesc['parameters'].iteritems(): +417 param = key2param(arg) +418 argmap[param] = arg +419 +420 if desc.get(key, 'string') -450 # For repeated parameters we cast each member of the list. -451 if key in repeated_params and type(value) == type([]): -452 cast_value = [_cast(x, to_type) for x in value] -453 else: -454 cast_value = _cast(value, to_type) -455 if key in query_params: -456 actual_query_params[argmap[key]] = cast_value -457 if key in path_params: -458 actual_path_params[argmap[key]] = cast_value -459 body_value = kwargs.get('pattern', ''): +421 pattern_params[param] = desc['pattern'] +422 if desc.get('body', None) -460 media_filename = kwargs.get('enum', ''): +423 enum_params[param] = desc['enum'] +424 if desc.get('media_body', None) -461 -462 if self._developerKey: -463 actual_query_params['key'] = self._developerKey -464 -465 model = self._model -466 # If there is no schema for the response then presume a binary blob. -467 if 'response' not in methodDesc: -468 model = RawModel() -469 -470 headers = {} -471 headers, params, query, body = model.get('required', False): +425 required_params.append(param) +426 if desc.get('repeated', False): +427 repeated_params.append(param) +428 if desc.get('location') == 'query': +429 query_params.append(param) +430 if desc.get('location') == 'path': +431 path_params[param] = param +432 param_type[param] = desc.get('type', 'string') +433 +434 for match in URITEMPLATE.finditer(pathUrl): +435 for namematch in VARNAME.finditer(match.group(0)): +436 name = key2param(namematch.group(0)) +437 path_params[name] = name +438 if name in query_params: +439 query_params.remove(name) +440 +441 def method(self, **kwargs): +442 # Don't bother with doc string, it will be over-written by createMethod. +443 for name in kwargs.iterkeys(): +444 if name not in argmap: +445 raise TypeError('Got an unexpected keyword argument "%s"' % name) +446 +447 for name in required_params: +448 if name not in kwargs: +449 raise TypeError('Missing required parameter "%s"' % name) +450 +451 for name, regex in pattern_params.iteritems(): +452 if name in kwargs: +453 if isinstance(kwargs[name], basestring): +454 pvalues = [kwargs[name]] +455 else: +456 pvalues = kwargs[name] +457 for pvalue in pvalues: +458 if re.match(regex, pvalue) is None: +459 raise TypeError( +460 'Parameter "%s" value "%s" does not match the pattern "%s"' % +461 (name, pvalue, regex)) +462 +463 for name, enums in enum_params.iteritems(): +464 if name in kwargs: +465 # We need to handle the case of a repeated enum +466 # name differently, since we want to handle both +467 # arg='value' and arg=['value1', 'value2'] +468 if (name in repeated_params and +469 not isinstance(kwargs[name], basestring)): +470 values = kwargs[name] +471 else: +472 values = [kwargs[name]] +473 for value in values: +474 if value not in enums: +475 raise TypeError( +476 'Parameter "%s" value "%s" is not an allowed value in "%s"' % +477 (name, value, str(enums))) +478 +479 actual_query_params = {} +480 actual_path_params = {} +481 for key, value in kwargs.iteritems(): +482 to_type = param_type.get(key, 'string') +483 # For repeated parameters we cast each member of the list. +484 if key in repeated_params and type(value) == type([]): +485 cast_value = [_cast(x, to_type) for x in value] +486 else: +487 cast_value = _cast(value, to_type) +488 if key in query_params: +489 actual_query_params[argmap[key]] = cast_value +490 if key in path_params: +491 actual_path_params[argmap[key]] = cast_value +492 body_value = kwargs.get('body', None) +493 media_filename = kwargs.get('media_body', None) +494 +495 if self._developerKey: +496 actual_query_params['key'] = self._developerKey +497 +498 model = self._model +499 # If there is no schema for the response then presume a binary blob. +500 if 'response' not in methodDesc: +501 model = RawModel() +502 +503 headers = {} +504 headers, params, query, body = model.request(headers, -472 actual_path_params, actual_query_params, body_value) -473 -474 expanded_url = uritemplate.expand(pathUrl, params) -475 url = urlparse.urljoin(self._baseUrl, expanded_url + query) -476 -477 505 actual_path_params, actual_query_params, body_value) +506 +507 expanded_url = uritemplate.expand(pathUrl, params) +508 url = urlparse.urljoin(self._baseUrl, expanded_url + query) +509 +510 resumable = None -478 multipart_boundary = '' -479 -480 if media_filename: -481 # Ensure we end up with a valid MediaUpload object. -482 if isinstance(media_filename, basestring): -483 (media_mime_type, encoding) = mimetypes.guess_type(media_filename) -484 if media_mime_type is None: -485 raise UnknownFileType(media_filename) -486 if not mimeparse.best_match([media_mime_type], ','.join(511 multipart_boundary = '' +512 +513 if media_filename: +514 # Ensure we end up with a valid MediaUpload object. +515 if isinstance(media_filename, basestring): +516 (media_mime_type, encoding) = mimetypes.guess_type(media_filename) +517 if media_mime_type is None: +518 raise UnknownFileType(media_filename) +519 if not mimeparse.best_match([media_mime_type], ','.join(accept)): -487 raise UnacceptableMimeTypeError(media_mime_type) -488 media_upload = MediaFileUpload(media_filename, media_mime_type) -489 elif isinstance(media_filename, MediaUpload): -490 media_upload = media_filename -491 else: -492 raise TypeError('media_filename must be str or MediaUpload.') -493 -494 # Check the maxSize -495 if maxSize > 0 and media_upload.accept)): +520 raise UnacceptableMimeTypeError(media_mime_type) +521 media_upload = MediaFileUpload(media_filename, media_mime_type) +522 elif isinstance(media_filename, MediaUpload): +523 media_upload = media_filename +524 else: +525 raise TypeError('media_filename must be str or MediaUpload.') +526 +527 # Check the maxSize +528 if maxSize > 0 and media_upload.size() > maxSize: -496 raise MediaUploadSizeError("Media larger than: %s" % maxSize) -497 -498 # Use the media path uri for media uploads -499 expanded_url = uritemplate.expand(mediaPathUrl, params) -500 url = urlparse.urljoin(self._baseUrl, expanded_url + query) -501 if media_upload.529 raise MediaUploadSizeError("Media larger than: %s" % maxSize) +530 +531 # Use the media path uri for media uploads +532 expanded_url = uritemplate.expand(mediaPathUrl, params) +533 url = urlparse.urljoin(self._baseUrl, expanded_url + query) +534 if media_upload.resumable(): -502 url = _add_query_parameter(url, 'uploadType', 'resumable') -503 -504 if media_upload.535 url = _add_query_parameter(url, 'uploadType', 'resumable') +536 +537 if media_upload.resumable(): -505 # This is all we need to do for resumable, if the body exists it gets -506 # sent in the first request, otherwise an empty body is sent. -507 538 # This is all we need to do for resumable, if the body exists it gets +539 # sent in the first request, otherwise an empty body is sent. +540 resumable = media_upload -508 else: -509 # A non-resumable upload -510 if body is None: -511 # This is a simple media upload -512 headers['content-type'] = media_upload.541 else: +542 # A non-resumable upload +543 if body is None: +544 # This is a simple media upload +545 headers['content-type'] = media_upload.mimetype() -513 body = media_upload.546 body = media_upload.getbytes(0, media_upload.size()) -514 url = _add_query_parameter(url, 'uploadType', 'media') -515 else: -516 # This is a multipart/related upload. -517 msgRoot = MIMEMultipart('related') -518 # msgRoot should not write out it's own headers -519 setattr(msgRoot, '_write_headers', lambda self: None) -520 -521 # attach the body as one part -522 msg = MIMENonMultipart(*headers['content-type'].split('/')) -523 msg.set_payload(body) -524 msgRoot.attach(msg) -525 -526 # attach the media as the second part -527 msg = MIMENonMultipart(*media_upload.547 url = _add_query_parameter(url, 'uploadType', 'media') +548 else: +549 # This is a multipart/related upload. +550 msgRoot = MIMEMultipart('related') +551 # msgRoot should not write out it's own headers +552 setattr(msgRoot, '_write_headers', lambda self: None) +553 +554 # attach the body as one part +555 msg = MIMENonMultipart(*headers['content-type'].split('/')) +556 msg.set_payload(body) +557 msgRoot.attach(msg) +558 +559 # attach the media as the second part +560 msg = MIMENonMultipart(*media_upload.mimetype().split('/')) -528 msg['Content-Transfer-Encoding'] = 'binary' -529 -530 payload = media_upload.561 msg['Content-Transfer-Encoding'] = 'binary' +562 +563 payload = media_upload.getbytes(0, media_upload.size()) -531 msg.set_payload(payload) -532 msgRoot.attach(msg) -533 body = msgRoot.as_string() -534 -535 multipart_boundary = msgRoot.get_boundary() -536 headers['content-type'] = ('multipart/related; ' -537 'boundary="%s"') % multipart_boundary -538 url = _add_query_parameter(url, 'uploadType', 'multipart') -539 -540 564 msg.set_payload(payload) +565 msgRoot.attach(msg) +566 body = msgRoot.as_string() +567 +568 multipart_boundary = msgRoot.get_boundary() +569 headers['content-type'] = ('multipart/related; ' +570 'boundary="%s"') % multipart_boundary +571 url = _add_query_parameter(url, 'uploadType', 'multipart') +572 +573 logger.info('URL being requested: %s' % url) -541 return self._requestBuilder(self._http, -542 model.574 return self._requestBuilder(self._http, +575 model.response, -543 url, -544 method=httpMethod, -545 body=body, -546 headers=headers, -547 methodId=methodId, -548 576 url, +577 method=httpMethod, +578 body=body, +579 headers=headers, +580 methodId=methodId, +581 resumable=resumable) -549 -550 docs = [methodDesc.582 +583 docs = [methodDesc.get('description', DEFAULT_METHOD_DOC), '\n\n'] -551 if len(argmap) > 0: -552 docs.append('Args:\n') -553 for arg in argmap.iterkeys(): -554 if arg in STACK_QUERY_PARAMETERS: -555 continue -556 repeated = '' -557 if arg in repeated_params: -558 repeated = ' (repeated)' -559 required = '' -560 if arg in required_params: -561 required = ' (required)' -562 paramdesc = methodDesc['parameters'][argmap[arg]] -563 paramdoc = paramdesc.get('description', DEFAULT_METHOD_DOC), '\n\n'] +584 if len(argmap) > 0: +585 docs.append('Args:\n') +586 +587 # Skip undocumented params and params common to all methods. +588 skip_parameters = rootDesc.get('description', 'A parameter') -564 if '$ref' in paramdesc: -565 docs.append( -566 (' %s: object, %s%s%s\n The object takes the' -567 ' form of:\n\n%s\n\n') % (arg, paramdoc, required, repeated, -568 schema.prettyPrintByName(paramdesc['$ref']))) -569 else: -570 paramtype = paramdesc.get('parameters', {}).keys() +589 skip_parameters.append(STACK_QUERY_PARAMETERS) +590 +591 for arg in argmap.iterkeys(): +592 if arg in skip_parameters: +593 continue +594 +595 repeated = '' +596 if arg in repeated_params: +597 repeated = ' (repeated)' +598 required = '' +599 if arg in required_params: +600 required = ' (required)' +601 paramdesc = methodDesc['parameters'][argmap[arg]] +602 paramdoc = paramdesc.get('type', 'string') -571 docs.append(' %s: %s, %s%s%s\n' % (arg, paramtype, paramdoc, required, -572 repeated)) -573 enum = paramdesc.get('description', 'A parameter') +603 if '$ref' in paramdesc: +604 docs.append( +605 (' %s: object, %s%s%s\n The object takes the' +606 ' form of:\n\n%s\n\n') % (arg, paramdoc, required, repeated, +607 schema.prettyPrintByName(paramdesc['$ref']))) +608 else: +609 paramtype = paramdesc.get('enum', []) -574 enumDesc = paramdesc.get('type', 'string') +610 docs.append(' %s: %s, %s%s%s\n' % (arg, paramtype, paramdoc, required, +611 repeated)) +612 enum = paramdesc.get('enumDescriptions', []) -575 if enum and enumDesc: -576 docs.append(' Allowed values\n') -577 for (name, desc) in zip(enum, enumDesc): -578 docs.append(' %s - %s\n' % (name, desc)) -579 if 'response' in methodDesc: -580 docs.append('\nReturns:\n An object of the form\n\n ') -581 docs.append(schema.prettyPrintSchema(methodDesc['response'])) -582 -583 setattr(method, '__doc__', ''.join(docs)) -584 setattr(theclass, methodName, method) -585 -586 def createNextMethodFromFuture(theclass, methodName, methodDesc, futureDesc): -587 """ This is a legacy method, as only Buzz and Moderator use the future.json -588 functionality for generating _next methods. It will be kept around as long -589 as those API versions are around, but no new APIs should depend upon it. -590 """ -591 methodName = _fix_method_name(methodName) -592 methodId = methodDesc['id'] + '.next' -593 -594 def methodNext(self, previous): -595 """Retrieve the next page of results. -596 -597 Takes a single argument, 'body', which is the results -598 from the last call, and returns the next set of items -599 in the collection. -600 -601 Returns: -602 None if there are no more items in the collection. -603 """ -604 if futureDesc['type'] != 'uri': -605 raise UnknownLinkType(futureDesc['type']) -606 -607 try: -608 p = previous -609 for key in futureDesc['location']: -610 p = p[key] -611 url = p -612 except (KeyError, TypeError): -613 return None -614 -615 url = _add_query_parameter(url, 'key', self._developerKey) -616 -617 headers = {} -618 headers, params, query, body = self._model.request(headers, {}, {}, None) -619 -620 logger.info('URL being requested: %s' % url) -621 resp, content = self._http.request(url, method='GET', headers=headers) -622 -623 return self._requestBuilder(self._http, -624 self._model.response, -625 url, -626 method='GET', -627 headers=headers, -628 methodId=methodId) -629 -630 setattr(theclass, methodName, methodNext) -631 -632 def createNextMethod(theclass, methodName, methodDesc, futureDesc): -633 methodName = _fix_method_name(methodName) -634 methodId = methodDesc['id'] + '.next' -635 -636 def methodNext(self, previous_request, previous_response): -637 """Retrieves the next page of results. -638 -639 Args: -640 previous_request: The request for the previous page. -641 previous_response: The response from the request for the previous page. +oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-149', 'get', 'link-70');">get('enum', []) +613 enumDesc = paramdesc.get('enumDescriptions', []) +614 if enum and enumDesc: +615 docs.append(' Allowed values\n') +616 for (name, desc) in zip(enum, enumDesc): +617 docs.append(' %s - %s\n' % (name, desc)) +618 if 'response' in methodDesc: +619 docs.append('\nReturns:\n An object of the form\n\n ') +620 docs.append(schema.prettyPrintSchema(methodDesc['response'])) +621 +622 setattr(method, '__doc__', ''.join(docs)) +623 setattr(theclass, methodName, method) +624 +625 def createNextMethod(theclass, methodName, methodDesc, rootDesc): +626 """Creates any _next methods for attaching to a Resource. +627 +628 The _next methods allow for easy iteration through list() responses. +629 +630 Args: +631 theclass: type, the class to attach methods to. +632 methodName: string, name of the method to use. +633 methodDesc: object, fragment of deserialized discovery document that +634 describes the method. +635 rootDesc: object, the entire deserialized discovery document. +636 """ +637 methodName = fix_method_name(methodName) +638 methodId = methodDesc['id'] + '.next' +639 +640 def methodNext(self, previous_request, previous_response): +641 """Retrieves the next page of results. 642 -643 Returns: -644 A request object that you can call 'execute()' on to request the next -645 page. Returns None if there are no more items in the collection. -646 """ -647 # Retrieve nextPageToken from previous_response -648 # Use as pageToken in previous_request to create new request. -649 -650 if 'nextPageToken' not in previous_response: -651 return None -652 -653 643 Args: +644 previous_request: The request for the previous page. +645 previous_response: The response from the request for the previous page. +646 +647 Returns: +648 A request object that you can call 'execute()' on to request the next +649 page. Returns None if there are no more items in the collection. +650 """ +651 # Retrieve nextPageToken from previous_response +652 # Use as pageToken in previous_request to create new request. +653 +654 if 'nextPageToken' not in previous_response: +655 return None +656 +657 request = copy.copy(previous_request) -654 -655 pageToken = previous_response['nextPageToken'] -656 parsed = list(urlparse.urlparse(request.uri)) -657 q = parse_qsl(parsed[4]) +apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-154', 'request', 'link-54');">request = copy.copy(previous_request) 658 -659 # Find and remove old 'pageToken' value from URI -660 newq = [(key, value) for (key, value) in q if key != 'pageToken'] -661 newq.append(('pageToken', pageToken)) -662 parsed[4] = urllib.urlencode(newq) -663 uri = urlparse.urlunparse(parsed) -664 -665 659 pageToken = previous_response['nextPageToken'] +660 parsed = list(urlparse.urlparse(request.uri = uri -666 -667 logger.info('URL being requested: %s' % uri) +apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-155', 'request', 'link-54');">request.uri)) +661 q = parse_qsl(parsed[4]) +662 +663 # Find and remove old 'pageToken' value from URI +664 newq = [(key, value) for (key, value) in q if key != 'pageToken'] +665 newq.append(('pageToken', pageToken)) +666 parsed[4] = urllib.urlencode(newq) +667 uri = urlparse.urlunparse(parsed) 668 -669 return 669 request -670 -671 setattr(theclass, methodName, methodNext) -672 -673 # Add basic methods to Resource -674 if 'methods' in resourceDesc: -675 for methodName, methodDesc in resourceDesc['methods'].iteritems(): -676 if futureDesc: -677 future = futureDesc['methods'].get(methodName, {}) -678 else: -679 future = None -680 createMethod(Resource, methodName, methodDesc, future) +apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-156', 'request', 'link-54');">request.uri = uri +670 +671 logger.info('URL being requested: %s' % uri) +672 +673 return request +674 +675 setattr(theclass, methodName, methodNext) +676 +677 # Add basic methods to Resource +678 if 'methods' in resourceDesc: +679 for methodName, methodDesc in resourceDesc['methods'].iteritems(): +680 createMethod(Resource, methodName, methodDesc, rootDesc) 681 682 # Add in nested resources 683 if 'resources' in resourceDesc: 684 -685 def createResourceMethod(theclass, methodName, methodDesc, futureDesc): -686 methodName = _fix_method_name(methodName) -687 -688 def methodResource(self): -689 return createResource(self._http, self._baseUrl, self._model, -690 self._requestBuilder, self._developerKey, -691 methodDesc, futureDesc, schema) -692 -693 setattr(methodResource, '__doc__', 'A collection resource.') -694 setattr(methodResource, '__is_resource__', True) -695 setattr(theclass, methodName, methodResource) -696 -697 for methodName, methodDesc in resourceDesc['resources'].iteritems(): -698 if futureDesc and 'resources' in futureDesc: -699 future = futureDesc['resources'].685 def createResourceMethod(theclass, methodName, methodDesc, rootDesc): +686 """Create a method on the Resource to access a nested Resource. +687 +688 Args: +689 theclass: type, the class to attach methods to. +690 methodName: string, name of the method to use. +691 methodDesc: object, fragment of deserialized discovery document that +692 describes the method. +693 rootDesc: object, the entire deserialized discovery document. +694 """ +695 methodName = fix_method_name(methodName) +696 +697 def methodResource(self): +698 return createResource(self._http, self._baseUrl, self._model, +699 self._requestBuilder, self._developerKey, +700 methodDesc, rootDesc, schema) +701 +702 setattr(methodResource, '__doc__', 'A collection resource.') +703 setattr(methodResource, '__is_resource__', True) +704 setattr(theclass, methodName, methodResource) +705 +706 for methodName, methodDesc in resourceDesc['resources'].iteritems(): +707 createResourceMethod(Resource, methodName, methodDesc, rootDesc) +708 +709 # Add _next() methods +710 # Look for response bodies in schema that contain nextPageToken, and methods +711 # that take a pageToken parameter. +712 if 'methods' in resourceDesc: +713 for methodName, methodDesc in resourceDesc['methods'].iteritems(): +714 if 'response' in methodDesc: +715 responseSchema = methodDesc['response'] +716 if '$ref' in responseSchema: +717 responseSchema = schema.get(methodName, {}) -700 else: -701 future = {} -702 createResourceMethod(Resource, methodName, methodDesc, future) -703 -704 # Add <m>_next() methods to Resource -705 if futureDesc and 'methods' in futureDesc: -706 for methodName, methodDesc in futureDesc['methods'].iteritems(): -707 if 'next' in methodDesc and methodName in resourceDesc['methods']: -708 createNextMethodFromFuture(Resource, methodName + '_next', -709 resourceDesc['methods'][methodName], -710 methodDesc['next']) -711 # Add _next() methods -712 # Look for response bodies in schema that contain nextPageToken, and methods -713 # that take a pageToken parameter. -714 if 'methods' in resourceDesc: -715 for methodName, methodDesc in resourceDesc['methods'].iteritems(): -716 if 'response' in methodDesc: -717 responseSchema = methodDesc['response'] -718 if '$ref' in responseSchema: -719 responseSchema = schema.get(responseSchema['$ref']) +718 hasNextPageToken = 'nextPageToken' in responseSchema.get(responseSchema['$ref']) -720 hasNextPageToken = 'nextPageToken' in responseSchema.get('properties', +719 {}) +720 hasPageToken = 'pageToken' in methodDesc.get('properties', -721 {}) -722 hasPageToken = 'pageToken' in methodDesc.get('parameters', {}) -723 if hasNextPageToken and hasPageToken: -724 createNextMethod(Resource, methodName + '_next', -725 resourceDesc['methods'][methodName], -726 methodName) -727 -728 return Resource() -729 + + + + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + + Package apiclient :: + Module http :: + Class MediaIoBaseUpload + + + + + + +
    [hide private]
    [frames] | no frames]
    +
    + +

    Class MediaIoBaseUpload

    source code

    +
    +
    + + + + + + + + + + + + +
    +
    +
    +
    +A MediaUpload for a io.Base objects.
+
+Note that the Python file object is compatible with io.Base and can be used
+with this class also.
+
+
+  fh = io.BytesIO('...Some data to upload...')
+  media = MediaIoBaseUpload(fh, mimetype='image/png',
+    chunksize=1024*1024, resumable=True)
+  service.objects().insert(
+      bucket='a_bucket_id',
+      name='smiley.png',
+      media_body=media).execute()
+
+
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + +
    Instance Methods[hide private]
    +
    +   + + + + + + +
    __init__(self, + fh, + mimetype, + chunksize=524288, + resumable=False)
    + Constructor.    		 + source code + +
    + +
    +   + + + + + + +
    chunksize(self)
    + Chunk size for resumable uploads.    		 + source code + +
    + +
    +   + + + + + + +
    mimetype(self)
    + Mime type of the body.    		 + source code + +
    + +
    +   + + + + + + +
    size(self)
    + Size of upload.    		 + source code + +
    + +
    +   + + + + + + +
    resumable(self)
    + Whether this upload is resumable.    		 + source code + +
    + +
    +   + + + + + + +
    getbytes(self, + begin, + length)
    + Get bytes from the media.    		 + source code + +
    + +
    +   + + + + + + +
    to_json(self)
    + This upload type is not serializable.    		 + source code + +
    + +
    +

    Inherited from MediaUpload (private): + _to_json +

    +

    Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

    +
    + + + + + + + + + +
    + + + + + +
    Class Methods[hide private]
    +
    +

    Inherited from MediaUpload: + new_from_json +

    +
    + + + + + + + + + +
    + + + + + +
    Properties[hide private]
    +
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + + + + + +
    Method Details[hide private]
    +
    + +
    + +
    + + +
    +

    __init__(self, + fh, + mimetype, + chunksize=524288, + resumable=False) +
    (Constructor) +

    +     		source code  +
    + + 
    +Constructor.
+
+Args:
+  fh: io.Base or file object, The source of the bytes to upload.
+  mimetype: string, Mime-type of the file. If None then a mime-type will be
+    guessed from the file extension.
+  chunksize: int, File will be uploaded in chunks of this many bytes. Only
+    used if resumable=True.
+  resumable: bool, True if this is a resumable upload. False means upload
+    in a single request.
+
+
    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    chunksize(self) +

    +     		source code  +
    + + 
    +Chunk size for resumable uploads.
+
+Returns:
+  Chunk size in bytes.
+
+
    +
    +
    Overrides: + MediaUpload.chunksize +
    +
    +
    +
    + +
    + +
    + + +
    +

    mimetype(self) +

    +     		source code  +
    + + 
    +Mime type of the body.
+
+Returns:
+  Mime type.
+
+
    +
    +
    Overrides: + MediaUpload.mimetype +
    +
    +
    +
    + +
    + +
    + + +
    +

    size(self) +

    +     		source code  +
    + + 
    +Size of upload.
+
+Returns:
+  Size of the body, or None of the size is unknown.
+
+
    +
    +
    Overrides: + MediaUpload.size +
    +
    +
    +
    + +
    + +
    + + +
    +

    resumable(self) +

    +     		source code  +
    + + 
    +Whether this upload is resumable.
+
+Returns:
+  True if resumable upload or False.
+
+
    +
    +
    Overrides: + MediaUpload.resumable +
    +
    +
    +
    + +
    + +
    + + +
    +

    getbytes(self, + begin, + length) +

    +     		source code  +
    + + 
    +Get bytes from the media.
+
+Args:
+  begin: int, offset from beginning of file.
+  length: int, number of bytes to read, starting at begin.
+
+Returns:
+  A string of bytes read. May be shorted than length if EOF was reached
+  first.
+
+
    +
    +
    Overrides: + MediaUpload.getbytes +
    +
    +
    +
    + +
    + +
    + + +
    +

    to_json(self) +

    +     		source code  +
    + + 
    +This upload type is not serializable.
+
+
    +
    +
    Overrides: + MediaUpload.to_json +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/epy/apiclient.http.MediaUpload-class.html b/docs/epy/apiclient.http.MediaUpload-class.html index d798223..852682f 100644 --- a/docs/epy/apiclient.http.MediaUpload-class.html +++ b/docs/epy/apiclient.http.MediaUpload-class.html @@ -55,19 +55,20 @@

    Class MediaUpload

    source code

    -
    - - - - - - - - +
    + + + + + + + + + - +
    @@ -76,6 +77,13 @@ Describes a media object to upload. Base class that defines the interface of MediaUpload subclasses. +Note that subclasses of MediaUpload may allow you to control the chunksize +when upload a media object. It is important to keep the size of the chunk as +large as possible to keep the upload efficient. Other factors may influence +the size of the chunk you use, particularly if you are working in an +environment where individual HTTP requests may have a hardcoded time limit, +such as under certain classes of requests under Google App Engine. + @@ -101,41 +109,8 @@ Base class that defines the interface of MediaUpload subclasses.
    		- - - -
    getbytes(self, - begin, - end) - source code - -
    - -
    -   - - - - - - -
    size(self) - source code - -
    - -
    -   - - - - + -
    chunksize(self)chunksize(self)
    + Chunk size for resumable uploads.    		 source code @@ -151,7 +126,8 @@ Base class that defines the interface of MediaUpload subclasses. - + + + + + + + @@ -312,6 +325,138 @@ representation produced by to_json().
    mimetype(self)mimetype(self)
    + Mime type of the body.    		 source code @@ -167,7 +143,25 @@ Base class that defines the interface of MediaUpload subclasses. - + + + +
    resumable(self)size(self)
    + Size of upload.    		 + source code + +
    + +
    +   + + + +
    resumable(self)
    + Whether this upload is resumable.    		 source code @@ -175,6 +169,25 @@ Base class that defines the interface of MediaUpload subclasses.
    +
    +   + + + + + + +
    getbytes(self, + begin, + end)
    + Get bytes from the media.    		 + source code + +
    +
    + +
    + +
    + + +
    +

    chunksize(self) +

    +     		source code  +
    + + 
    +Chunk size for resumable uploads.
+
+Returns:
+  Chunk size in bytes.
+
+
    +
    +
    +
    +
    + +
    + +
    + + +
    +

    mimetype(self) +

    +     		source code  +
    + + 
    +Mime type of the body.
+
+Returns:
+  Mime type.
+
+
    +
    +
    +
    +
    + +
    + +
    + + +
    +

    size(self) +

    +     		source code  +
    + + 
    +Size of upload.
+
+Returns:
+  Size of the body, or None of the size is unknown.
+
+
    +
    +
    +
    +
    + +
    + +
    + + +
    +

    resumable(self) +

    +     		source code  +
    + + 
    +Whether this upload is resumable.
+
+Returns:
+  True if resumable upload or False.
+
+
    +
    +
    +
    +
    + +
    + +
    + + +
    +

    getbytes(self, + begin, + end) +

    +     		source code  +
    + + 
    +Get bytes from the media.
+
+Args:
+  begin: int, offset from beginning of file.
+  length: int, number of bytes to read, starting at begin.
+
+Returns:
+  A string of bytes read. May be shorter than length if EOF was reached
+  first.
+
+
    +
    +
    +
    +
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012

    Class MediaUploadProgress

    source code

    -
    +
    - +
    @@ -111,7 +111,7 @@ Status of a resumable upload.
    		-
    progress(self)
    +     		progress(self)
    Percent of upload completed, as a float.    		 source code @@ -206,7 +206,8 @@ Constructor. Args: resumable_progress: int, bytes sent so far. - total_size: int, total bytes in complete upload. + total_size: int, total bytes in complete upload, or None if the total + upload size isn't known ahead of time.
    @@ -216,6 +217,32 @@ Args:
    + +
    + +
    + + +
    +

    progress(self) +

    +     		source code  +
    + + 
    +Percent of upload completed, as a float.
+
+Returns:
+  the percentage complete as a float, returning 0.0 if the total size of
+  the upload is unknown.
+
+
    +
    +
    +
    +

    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012

    Class RequestMockBuilder

    source code

    -
    +
    - +
    @@ -313,7 +313,7 @@ parameters and the expected response.
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:54 2012
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:11 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:59 2012
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:54 2012
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:11 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:59 2012

    Class BaseModel

    source code

    -
    +
    @@ -65,12 +65,12 @@ - - + + - + - +
    @@ -542,7 +542,7 @@ Returns: @@ -1330,7 +1395,7 @@
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012

    Class JsonModel

    source code

    -
    +
    @@ -70,7 +70,7 @@ - +
    @@ -425,7 +425,7 @@ Returns: @@ -979,231 +1030,239 @@ - - - - - - - - - - - - - - - - - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - + + + + + + + + + + + + + + + + + + + + + - - + + - + - + - + - + - + - + - + - + - @@ -1211,98 +1270,104 @@ - + - + - + - + - + - + - - + + - - + + - - + + - - + - - + + - - - + + + + + + +
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012

    Class Model

    source code

    -
    +
    - - - + + + - +
    @@ -295,7 +295,7 @@ Raises: @@ -922,25 +964,34 @@ - - + - - + + - - + + + + + + +
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012

    Class ProtocolBufferModel

    source code

    -
    +
    @@ -69,7 +69,7 @@ - +
    @@ -428,7 +428,7 @@ Returns: + + + + + - + - + - - - - -
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012

    Class RawModel

    source code

    -
    +
    @@ -65,12 +65,12 @@ + - - +
    @@ -331,7 +331,7 @@ Returns: @@ -772,31 +811,32 @@ (in OAuth2Credentials) - + - + - + - + - @@ -823,52 +863,53 @@ (in apiclient.schema) - + - + - + - + + + + + + - - - - - - +
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:54 2012
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:12 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:59 2012

    Class Schemas

    source code

    -
    +
    - +
    @@ -471,7 +471,7 @@ Args: @@ -677,33 +707,42 @@
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012

    Class _SchemaToStruct

    source code

    -
    +
    @@ -65,7 +65,7 @@ - +
    @@ -499,7 +499,7 @@ Returns: - + + + + + + + + + + + - - + + - - + + - - - - - - + - + - - - - -
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
  • exceptions.Exception: Common base class for all non-exit exceptions.
    • -
  • django.db.models.fields.Field: - Base class for all field types +
  • django.db.models.fields.Field
    		• - - - - - - + - + - + + + + + + + + + + +
    latitude
    -(in apiclient.contrib)    		locked_delete()
    -(in _Storage)    		locked_put()
    -(in Storage)
    load()
    (in oauth2client.clientsecrets)    		 locked_get()
    (in StorageByKeyName)    		locked_put()
    -(in Storage)    		locked_put()
    +(in _Storage)
    loadfile()
    (in oauth2client.clientsecrets)    		 locked_get()
    (in Storage)    		locked_put()
    -(in _Storage)    		LockedFile
    +(in oauth2client.locked_file)
    loads()
    @@ -564,14 +578,29 @@ (in Storage)    		 locked_put()
    (in StorageByKeyName)    		logger
    -(in oauth2client.multistore_file)    		logger
    +(in oauth2client.locked_file)
    locked_delete()
    (in Storage)    		 locked_put()
    (in Storage)    		logger
    +(in oauth2client.multistore_file)
    locked_delete()
    +(in _Storage)    		locked_put()
    +(in Storage)    		 
    locked_file
    +(in oauth2client)    		locked_put()
    +(in Storage)    		  
    @@ -584,63 +613,64 @@ (in oauth2client.appengine)    		 MediaInMemoryUpload
    (in apiclient.http)    		mimetype()
    -(in MediaInMemoryUpload)    		mimetype()
    +(in MediaFileUpload)
    make_signed_jwt()
    (in oauth2client.crypt)    		MediaIoBaseUpload
    +(in apiclient.http)    		mimetype()
    +(in MediaInMemoryUpload)
    make_value_from_datastore()
    +(in CredentialsProperty)    		 MediaUpload
    (in apiclient.http)    		mimetype()
    +(in MediaIoBaseUpload)
    make_value_from_datastore()
    +(in FlowProperty)    		MediaUploadProgress
    +(in apiclient.http)    		 mimetype()
    (in MediaUpload)
    make_value_from_datastore()
    -(in CredentialsProperty)    		MediaUploadProgress
    -(in apiclient.http)    		makepatch()
    +(in apiclient.model)    		MediaUploadSizeError
    +(in apiclient.errors)    		 model
    (in apiclient)
    make_value_from_datastore()
    -(in FlowProperty)    		MediaUploadSizeError
    -(in apiclient.errors)    		MAX_TOKEN_LIFETIME_SECS
    +(in SignedJwtAssertionCredentials)    		MemoryCache
    +(in oauth2client.client)    		 Model
    (in apiclient.model)
    makepatch()
    -(in apiclient.model)    		MemoryCache
    -(in oauth2client.client)    		moderator
    -(in apiclient.contrib)
    MAX_TOKEN_LIFETIME_SECS
    -(in SignedJwtAssertionCredentials)    		MAX_TOKEN_LIFETIME_SECS
    +(in oauth2client.crypt)    		 Message MULTIPLIERS
    (in apiclient.discovery)
    MAX_TOKEN_LIFETIME_SECS
    -(in oauth2client.crypt)    		MediaFileUpload
    +(in apiclient.http)    		 mimeparse
    (in apiclient)    		 multistore_file
    (in oauth2client)
    MediaFileUpload
    -(in apiclient.http)    		mimetype()
    -(in MediaFileUpload)    		 

    N

    - - - - - - - - - - - + + + + + - + + + + + + + + + + +
    oauth2clientoauth2decorator_from_clientsecrets()
    -(in oauth2client.appengine)    		oauth_aware()
    -(in OAuth2Decorator)
    OAUTH2CLIENT_NAMESPACE
    -(in oauth2client.appengine)    		 OAuth2DecoratorFromClientSecrets
    (in oauth2client.appengine)    		oauth_required()
    -(in OAuth2Decorator)
    OAuth2Credentials
    -(in oauth2client.client)    		OAuth2Handler
    -(in oauth2client.appengine)    		 OOB_CALLBACK_URN
    (in oauth2client.client)
    OAuth2Decorator
    +    		OAUTH2CLIENT_NAMESPACE
    (in oauth2client.appengine)    		OAuth2Handler
    +(in oauth2client.appengine)    		open_and_lock()
    +(in LockedFile)
    OAuth2Credentials
    +(in oauth2client.client)    		 OAuth2WebServerFlow
    (in oauth2client.client)    		 open_and_lock()
    +(in _FcntlOpener)
    OAuth2Decorator
    +(in oauth2client.appengine)    		oauth_aware()
    +(in OAuth2Decorator)    		open_and_lock()
    +(in _Opener)
    oauth2decorator_from_clientsecrets()
    +(in oauth2client.appengine)    		oauth_required()
    +(in OAuth2Decorator)    		open_and_lock()
    +(in _PosixOpener)
    request()
    (in Model)    		resumable()
    -(in MediaUpload)    		resumable()
    +(in MediaIoBaseUpload)
    release_lock()
    (in Storage)    		 RequestMockBuilder
    (in apiclient.http)    		ResumableUploadError
    -(in apiclient.errors)    		resumable()
    +(in MediaUpload)
    release_lock()
    (in Storage)    		 RESERVED_WORDS
    (in apiclient.discovery)    		run()
    -(in oauth2client.tools)    		ResumableUploadError
    +(in apiclient.errors)
    release_lock()
    (in _Storage)    		 response()
    (in BaseModel)    		 run()
    +(in oauth2client.tools)
    request()
    @@ -815,7 +855,7 @@ (in apiclient)    		 sign()
    (in Signer)    		step2_exchange()
    +    		step1_get_authorize_url()
    (in OAuth2WebServerFlow)
    SignedJwtAssertionCredentials
    (in oauth2client.client)    		Storage
    -(in oauth2client.client)    		step2_exchange()
    +(in OAuth2WebServerFlow)
    serialize()
    (in BaseModel)    		 Signer
    (in oauth2client.crypt)    		Storage
    -(in oauth2client.django_orm)    		Storage
    +(in oauth2client.client)
    serialize()
    (in JsonModel)    		 size()
    (in MediaFileUpload)    		Storage
    -(in oauth2client.file)    		Storage
    +(in oauth2client.django_orm)
    serialize()
    (in ProtocolBufferModel)    		 size()
    (in MediaInMemoryUpload)    		StorageByKeyName
    -(in oauth2client.appengine)    		Storage
    +(in oauth2client.file)
    set()
    (in MemoryCache)    		size()
    +(in MediaIoBaseUpload)    		StorageByKeyName
    +(in oauth2client.appengine)
    set_store()
    +(in OAuth2Credentials)    		 size()
    (in MediaUpload)    		 SubfieldBase
    set_store()
    -(in OAuth2Credentials)    		STACK_QUERY_PARAMETERS
    -(in apiclient.discovery)    		 
    set_user_agent()
    (in apiclient.http)    		step1_get_authorize_url()
    -(in OAuth2WebServerFlow)    		STACK_QUERY_PARAMETERS
    +(in apiclient.discovery)    		  
    @@ -879,22 +920,30 @@
    to_json()
    (in HttpRequest)    		to_json()
    +(in Credentials)    		tools
    +(in oauth2client)
    to_json()
    +(in MediaFileUpload)    		 to_json()
    (in OAuth2Credentials)    		 tunnel_patch()
    (in apiclient.http)
    to_json()
    -(in MediaFileUpload)    		to_json()
    +(in MediaInMemoryUpload)    		 to_python()
    (in CredentialsField)    		 TYPE_INSTALLED
    (in oauth2client.clientsecrets)
    to_json()
    -(in MediaInMemoryUpload)    		to_json()
    +(in MediaIoBaseUpload)    		 to_python()
    (in FlowField)    		 TYPE_WEB
    @@ -907,13 +956,6 @@ (in _SchemaToStruct)    		  
    to_json()
    -(in Credentials)    		tools
    -(in oauth2client)    		 

    U

    UnacceptableMimeTypeError
    (in apiclient.errors)    		UnexpectedMethodError
    -(in apiclient.errors)    		UnknownLinkType
    +    		UnknownApiNameOrVersion
    (in apiclient.errors)    		unlock_and_close()
    +(in _FcntlOpener)
    undent()
    (in _SchemaToStruct)    		UnknownApiNameOrVersion
    -(in apiclient.errors)    		URITEMPLATE
    -(in apiclient.discovery)    		UnknownClientSecretsFlowError
    +(in oauth2client.client)    		unlock_and_close()
    +(in _Opener)
    UnexpectedBodyError
    (in apiclient.errors)    		UnknownClientSecretsFlowError
    -(in oauth2client.client)    		 UnknownLinkType
    +(in apiclient.errors)    		unlock_and_close()
    +(in _PosixOpener)
    UnexpectedMethodError
    +(in apiclient.errors)    		unlock_and_close()
    +(in LockedFile)    		URITEMPLATE
    +(in apiclient.discovery)
    __call__()
    (in RequestMockBuilder)    		__package__
    -(in apiclient.discovery)    		_generate_refresh_request_body()
    -(in OAuth2Credentials)
    __credits__
    -(in apiclient.mimeparse)    		__package__
    -(in apiclient.errors)    		_generate_refresh_request_headers()
    -(in OAuth2Credentials)
    __email__
    -(in apiclient.mimeparse)    		 __package__
    (in apiclient.ext)    		_get_credential()
    -(in _MultiStore)
    __getstate__()
    -(in OAuth2Credentials)    		__package__
    -(in apiclient.http)    		 _get_reason()
    (in HttpError)
    __init__()
    -(in BatchError)    		__package__
    +    		__credits__
    (in apiclient.mimeparse)    		__package__
    +(in apiclient.http)    		 _get_storage()
    (in _MultiStore)
    __init__()
    -(in HttpError)    		__package__
    -(in apiclient.model)    		__email__
    +(in apiclient.mimeparse)    		__package__
    +(in apiclient.mimeparse)    		 _header_to_id()
    (in BatchHttpRequest)
    __init__()
    -(in UnexpectedBodyError)    		__package__
    -(in apiclient.schema)    		__getstate__()
    +(in OAuth2Credentials)    		__package__
    +(in apiclient.model)    		 _id_to_header()
    (in BatchHttpRequest)
    __init__()
    -(in UnexpectedMethodError)    		__package__
    -(in oauth2client)    		__init__()
    +(in BatchError)    		__package__
    +(in apiclient.schema)    		 _json_encode()
    (in oauth2client.crypt)
    __init__()
    -(in BatchHttpRequest)    		__package__
    -(in oauth2client.anyjson)    		__init__()
    +(in HttpError)    		__package__
    +(in oauth2client)    		 _lock()
    (in _MultiStore)
    __init__()
    -(in HttpMock)    		__package__
    -(in oauth2client.appengine)    		__init__()
    +(in UnexpectedBodyError)    		__package__
    +(in oauth2client.anyjson)    		 _locked_json_read()
    (in _MultiStore)
    __init__()
    -(in HttpMockSequence)    		__package__
    -(in oauth2client.client)    		__init__()
    +(in UnexpectedMethodError)    		__package__
    +(in oauth2client.appengine)    		 _locked_json_write()
    (in _MultiStore)
    __init__()
    -(in HttpRequest)    		__package__
    -(in oauth2client.clientsecrets)    		__init__()
    +(in BatchHttpRequest)    		__package__
    +(in oauth2client.client)    		 _log_request()
    (in BaseModel)
    __init__()
    -(in HttpRequestMock)    		__package__
    -(in oauth2client.crypt)    		__init__()
    +(in HttpMock)    		__package__
    +(in oauth2client.clientsecrets)    		 _log_response()
    (in BaseModel)
    __init__()
    -(in MediaFileUpload)    		__package__
    -(in oauth2client.django_orm)    		__init__()
    +(in HttpMockSequence)    		__package__
    +(in oauth2client.crypt)    		 _media_size_to_long()
    (in apiclient.discovery)
    __init__()
    -(in MediaInMemoryUpload)    		__package__
    -(in oauth2client.file)    		__init__()
    +(in HttpRequest)    		__package__
    +(in oauth2client.django_orm)    		 _MultiStore
    (in oauth2client.multistore_file)
    __init__()
    -(in MediaUploadProgress)    		__package__
    -(in oauth2client.multistore_file)    		__init__()
    +(in HttpRequestMock)    		__package__
    +(in oauth2client.file)    		 _multistores
    (in oauth2client.multistore_file)
    __init__()
    -(in RequestMockBuilder)    		__package__
    -(in oauth2client.tools)    		__init__()
    +(in MediaFileUpload)    		__package__
    +(in oauth2client.locked_file)    		 _multistores_lock
    (in oauth2client.multistore_file)
    __init__()
    -(in JsonModel)    		__repr__()
    -(in BatchError)    		__init__()
    +(in MediaInMemoryUpload)    		__package__
    +(in oauth2client.multistore_file)    		 _new_id()
    (in BatchHttpRequest)
    __init__()
    -(in ProtocolBufferModel)    		__init__()
    +(in MediaIoBaseUpload)    		__package__
    +(in oauth2client.tools)    		_Opener
    +(in oauth2client.locked_file)
    __init__()
    +(in MediaUploadProgress)    		__repr__()
    +(in BatchError)    		_posix_lockfile()
    +(in _PosixOpener)
    __init__()
    +(in RequestMockBuilder)    		 __repr__()
    (in HttpError)    		_PosixOpener
    +(in oauth2client.locked_file)
    __init__()
    +(in JsonModel)    		__setstate__()
    +(in OAuth2Credentials)    		 _prettyPrintByName()
    (in Schemas)
    __init__()
    +(in ProtocolBufferModel)    		_abstract()
    +(in apiclient.model)    		_prettyPrintSchema()
    +(in Schemas)
    __init__()
    (in Schemas)    		__setstate__()
    -(in OAuth2Credentials)    		_prettyPrintSchema()
    -(in Schemas)    		_abstract()
    +(in oauth2client.client)    		_process_response()
    +(in HttpRequest)
    __init__()
    (in _SchemaToStruct)    		_abstract()
    -(in apiclient.model)    		_add_query_parameter()
    +(in apiclient.discovery)    		 _properties
    (in CredentialsModel)
    __init__()
    (in AppAssertionCredentials)    		_abstract()
    -(in oauth2client.client)    		_all_properties
    +(in CredentialsModel)    		 _refresh()
    (in AppAssertionCredentials)
    __init__()
    (in OAuth2Decorator)    		_add_query_parameter()
    -(in apiclient.discovery)    		_build_query()
    +(in BaseModel)    		 _refresh()
    (in AccessTokenCredentials)
    __init__()
    (in OAuth2DecoratorFromClientSecrets)    		_all_properties
    -(in CredentialsModel)    		_cached_http
    +(in oauth2client.client)    		 _refresh()
    (in OAuth2Credentials)
    __init__()
    (in StorageByKeyName)    		_build_query()
    -(in BaseModel)    		_cast()
    +(in apiclient.discovery)    		 _refresh_and_apply_credentials()
    (in BatchHttpRequest)
    __init__()
    (in AccessTokenCredentials)    		_cached_http
    -(in oauth2client.client)    		_create_file_if_needed()
    +(in Storage)    		 _refresh_data_cache()
    (in _MultiStore)
    __init__()
    (in AssertionCredentials)    		_cast()
    -(in apiclient.discovery)    		_create_file_if_needed()
    +(in _MultiStore)    		 _SchemaToStruct
    (in apiclient.schema)
    __init__()
    (in MemoryCache)    		_create_file_if_needed()
    -(in Storage)    		_decode_credential_from_json()
    +(in _MultiStore)    		 _serialize_request()
    (in BatchHttpRequest)
    __init__()
    (in OAuth2Credentials)    		_create_file_if_needed()
    +    		_delete_credential()
    (in _MultiStore)    		 _Storage
    (in _MultiStore)
    __init__()
    (in OAuth2WebServerFlow)    		_decode_credential_from_json()
    -(in _MultiStore)    		_deserialize_response()
    +(in BatchHttpRequest)    		 _to_json()
    (in MediaUpload)
    __init__()
    (in SignedJwtAssertionCredentials)    		_delete_credential()
    -(in _MultiStore)    		_display_error_message()
    +(in OAuth2Decorator)    		 _to_json()
    (in Credentials)
    __init__()
    (in Signer)    		_deserialize_response()
    -(in BatchHttpRequest)    		_do_refresh_request()
    +(in OAuth2Credentials)    		 _to_str_impl()
    (in _SchemaToStruct)
    __init__()
    (in Verifier)    		_display_error_message()
    -(in OAuth2Decorator)    		_execute()
    +(in BatchHttpRequest)    		 _unlock()
    (in _MultiStore)
    __init__()
    (in Storage)    		_do_refresh_request()
    -(in OAuth2Credentials)    		_extract_id_token()
    +(in oauth2client.client)    		 _update_credential()
    (in _MultiStore)
    __init__()
    (in Storage)    		_execute()
    -(in BatchHttpRequest)    		_FcntlOpener
    +(in oauth2client.locked_file)    		 _updateFromCredential()
    (in OAuth2Credentials)
    __init__()
    -(in _Storage)    		_extract_id_token()
    -(in oauth2client.client)    		__init__()
    +(in LockedFile)    		_filter_blank()
    +(in apiclient.mimeparse)    		 _urlsafe_b64decode()
    (in oauth2client.client)
    __init__()
    -(in _MultiStore)    		_filter_blank()
    -(in apiclient.mimeparse)    		__init__()
    +(in _Opener)    		_generate_assertion()
    +(in AssertionCredentials)    		 _urlsafe_b64decode()
    (in oauth2client.crypt)
    __package__
    -(in apiclient)    		_fix_method_name()
    -(in apiclient.discovery)    		__init__()
    +(in _Storage)    		_generate_assertion()
    +(in SignedJwtAssertionCredentials)    		 _urlsafe_b64encode()
    (in oauth2client.crypt)
    __package__
    -(in apiclient.contrib)    		_generate_assertion()
    +    		__init__()
    +(in _MultiStore)    		_generate_refresh_request_body()
    (in AssertionCredentials)    		 _validate_clientsecrets()
    (in oauth2client.clientsecrets)
    __package__
    -(in apiclient.contrib.latitude)    		_generate_assertion()
    -(in SignedJwtAssertionCredentials)    		__package__
    +(in apiclient)    		_generate_refresh_request_body()
    +(in OAuth2Credentials)    		 _write()
    (in _MultiStore)
    __package__
    -(in apiclient.contrib.moderator)    		_generate_refresh_request_body()
    -(in AssertionCredentials)    		_write_headers()
    +    		__package__
    (in apiclient.discovery)    		_generate_refresh_request_headers()
    +(in OAuth2Credentials)    		 
    __package__
    +(in apiclient.errors)    		_get_credential()
    +(in _MultiStore)    		 
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:04 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:54 2012
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:08 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
  • apiclient @@ -106,7 +101,7 @@ @@ -136,7 +137,7 @@
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:04 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:54 2012 oauth2client.crypt
  • oauth2client.django_orm: OAuth 2.0 utilities for Django.
  • oauth2client.file: Utilities for OAuth.
    • +
  • oauth2client.locked_file: Locked file interface that should work on Unix and Windows pythons.
  • oauth2client.multistore_file: Multi-credential file store with lock support.
  • oauth2client.tools: Command-line tools for authenticating via OAuth 2.0
    • - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:54 2012
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:12 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:59 2012
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:54 2012
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:11 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:59 2012
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:54 2012 73 scope = ' '.join(scope) 74 self.scope = scope 75 - 76 super(AppAssertionCredentials, self). 76 super(AppAssertionCredentials, self).__init__( 77 None, @@ -249,9 +252,10 @@ oauth2client.appengine.FlowProperty.get_value_for_datastore" class="py-name" hre 154 if cred is None: 155 cred = '' 156 else: -157 cred = cred.157 cred = cred.to_json() @@ -333,6 +337,7 @@ oauth2client.client.Credentials.new_from_json" class="py-name" href="#" onclick= 227 self._cache.set(self._key_name, credential.to_json()) @@ -352,6 +357,7 @@ oauth2client.client.OAuth2Credentials.to_json" class="py-name" href="#" onclick= 241 self._cache.set(self._key_name, credentials.to_json()) @@ -599,12 +605,13 @@ oauth2client.client.OAuth2Credentials.authorize" class="py-name" href="#" onclic 456 decorator. 457 """ 458 try: -459 client_type, client_info = clientsecrets.loadfile(filename) -460 if client_type not in [clientsecrets.TYPE_WEB, clientsecrets.TYPE_INSTALLED]: -461 raise InvalidClientSecretsError('OAuth2Decorator doesn\'t support this OAuth 2.0 flow.') -462 super(OAuth2DecoratorFromClientSecrets, -463 self).459 client_type, client_info = clientsecrets.loadfile(filename) +460 if client_type not in [clientsecrets.TYPE_WEB, clientsecrets.TYPE_INSTALLED]: +461 raise InvalidClientSecretsError('OAuth2Decorator doesn\'t support this OAuth 2.0 flow.') +462 super(OAuth2DecoratorFromClientSecrets, +463 self).__init__( +oauth2client.multistore_file._MultiStore.__init__" class="py-name" href="#" onclick="return doclink('link-107', '__init__', 'link-27');">__init__( 464 client_info['client_id'], 465 client_info['client_secret'], 466 scope, 467 client_info['auth_uri'], 468 client_info['token_uri'], 469 message) -470 except clientsecrets.InvalidClientSecretsError: +470 except clientsecrets.InvalidClientSecretsError: 471 self._in_error = True 472 if message is not None: 473 self._message = message @@ -667,7 +677,8 @@ oauth2client.clientsecrets.InvalidClientSecretsError" class="py-name" href="#" o 490 Returns: An OAuth2Decorator 491 492 """ -493 return OAuth2DecoratorFromClientSecrets(filename, scope, message) +493 return OAuth2DecoratorFromClientSecrets(filename, scope, message) 494
    495 496 -class OAuth2Handler(webapp.RequestHandler): @@ -675,59 +686,59 @@ oauth2client.clientsecrets.InvalidClientSecretsError" class="py-name" href="#" o 498 499 @login_required
    500 - def get(self): -
    501 error = self.request.get('error') -502 if error: -503 errormsg = self.
    501 error = self.request.get('error_description', error) -504 self.response.out.write( +oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-113', 'get', 'link-52');">get('error') +502 if error: +503 errormsg = self.request.get('error_description', error) +504 self.response.out.write( 505 'The authorization request failed: %s' % errormsg) 506 else: 507 user = users.get_current_user() -508 flow = pickle.loads(memcache.508 flow = pickle.loads(memcache.get(user.user_id(), -509 namespace=OAUTH2CLIENT_NAMESPACE)) +oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-118', 'get', 'link-52');">get(user.user_id(), +509 namespace=OAUTH2CLIENT_NAMESPACE)) 510 # This code should be ammended with application specific error 511 # handling. The following cases should be considered: 512 # 1. What if the flow doesn't exist in memcache? Or is corrupt? 513 # 2. What if the step2_exchange fails? 514 if flow: -515 credentials = flow.step2_exchange(self.515 credentials = flow.step2_exchange(self.request.params) -516 StorageByKeyName( -517 CredentialsModel, user.user_id(), 'credentials').put(credentials) -518 self.redirect(str(self.request.params) +516 StorageByKeyName( +517 CredentialsModel, user.user_id(), 'credentials').put(credentials) +518 self.redirect(str(self.request.request.get('state'))) +oauth2client.client.Storage.get" class="py-name" href="#" onclick="return doclink('link-128', 'get', 'link-52');">get('state'))) 519 else: 520 # TODO Add error handling here. 521 pass
    522 523 -524 application = webapp.WSGIApplication([('/oauth2callback', OAuth2Handler)]) +524 application = webapp.WSGIApplication([('/oauth2callback', OAuth2Handler)])
    525 526 527 -def main(): -
    528 run_wsgi_app(application) +
    528 run_wsgi_app(application)
    529 + + diff --git a/docs/epy/oauth2client.locked_file-pysrc.html b/docs/epy/oauth2client.locked_file-pysrc.html new file mode 100644 index 0000000..f4b4c06 --- /dev/null +++ b/docs/epy/oauth2client.locked_file-pysrc.html @@ -0,0 +1,381 @@ + + + + + oauth2client.locked_file + + + + + + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + + Package oauth2client :: + Module locked_file + + + + + + +
    [hide private]
    [frames] | no frames]
    +
    +

    Source Code for Module oauth2client.locked_file

    +
    +  1  # Copyright 2011 Google Inc. All Rights Reserved. 
+  2   
+  3  """Locked file interface that should work on Unix and Windows pythons. 
+  4   
+  5  This module first tries to use fcntl locking to ensure serialized access 
+  6  to a file, then falls back on a lock file if that is unavialable. 
+  7   
+  8  Usage: 
+  9      f = LockedFile('filename', 'r+b', 'rb') 
+ 10      f.open_and_lock() 
+ 11      if f.is_locked(): 
+ 12        print 'Acquired filename with r+b mode' 
+ 13        f.file_handle().write('locked data') 
+ 14      else: 
+ 15        print 'Aquired filename with rb mode' 
+ 16      f.unlock_and_close() 
+ 17  """ 
+ 18   
+ 19  __author__ = 'cache@google.com (David T McWherter)' 
+ 20   
+ 21  import errno 
+ 22  import logging 
+ 23  import os 
+ 24  import time 
+ 25   
+ 26  logger = logging.getLogger(__name__) 
+ 27   
+ 28   
+
     29 -class AlreadyLockedException(Exception): 
+
     30    """Trying to lock a file that has already been locked by the LockedFile.""" 
+ 31    pass 
+
     32   
+ 33   
+
     34 -class _Opener(object): 
+
     35    """Base class for different locking primitives.""" 
+ 36   
+
     37 -  def __init__(self, filename, mode, fallback_mode): 
+
     38      """Create an Opener. 
+ 39   
+ 40      Args: 
+ 41        filename: string, The pathname of the file. 
+ 42        mode: string, The preferred mode to access the file with. 
+ 43        fallback_mode: string, The mode to use if locking fails. 
+ 44      """ 
+ 45      self._locked = False 
+ 46      self._filename = filename 
+ 47      self._mode = mode 
+ 48      self._fallback_mode = fallback_mode 
+ 49      self._fh = None 
+
     50   
+
     51 -  def is_locked(self): 
+
     52      """Was the file locked.""" 
+ 53      return self._locked 
+
     54   
+
     55 -  def file_handle(self): 
+
     56      """The file handle to the file.  Valid only after opened.""" 
+ 57      return self._fh 
+
     58   
+
     59 -  def filename(self): 
+
     60      """The filename that is being locked.""" 
+ 61      return self._filename 
+
     62   
+
     63 -  def open_and_lock(self, timeout, delay): 
+
     64      """Open the file and lock it. 
+ 65   
+ 66      Args: 
+ 67        timeout: float, How long to try to lock for. 
+ 68        delay: float, How long to wait between retries. 
+ 69      """ 
+ 70      pass 
+
     71   
+
     72 -  def unlock_and_close(self): 
+
     73      """Unlock and close the file.""" 
+ 74      pass 
+
     75   
+ 76   
+
     77 -class _PosixOpener(_Opener): 
+
     78    """Lock files using Posix advisory lock files.""" 
+ 79   
+
     80 -  def open_and_lock(self, timeout, delay): 
+
     81      """Open the file and lock it. 
+ 82   
+ 83      Tries to create a .lock file next to the file we're trying to open. 
+ 84   
+ 85      Args: 
+ 86        timeout: float, How long to try to lock for. 
+ 87        delay: float, How long to wait between retries. 
+ 88   
+ 89      Raises: 
+ 90        AlreadyLockedException: if the lock is already acquired. 
+ 91        IOError: if the open fails. 
+ 92      """ 
+ 93      if self._locked: 
+ 94        raise AlreadyLockedException('File %s is already locked' % 
+ 95                                     self._filename) 
+ 96      self._locked = False 
+ 97   
+ 98      try: 
+ 99        self._fh = open(self._filename, self._mode) 
+100      except IOError, e: 
+101        # If we can't access with _mode, try _fallback_mode and don't lock. 
+102        if e.errno == errno.EACCES: 
+103          self._fh = open(self._filename, self._fallback_mode) 
+104          return 
+105   
+106      lock_filename = self._posix_lockfile(self._filename) 
+107      start_time = time.time() 
+108      while True: 
+109        try: 
+110          self._lock_fd = os.open(lock_filename, 
+111                                  os.O_CREAT|os.O_EXCL|os.O_RDWR) 
+112          self._locked = True 
+113          break 
+114   
+115        except OSError, e: 
+116          if e.errno != errno.EEXIST: 
+117            raise 
+118          if (time.time() - start_time) >= timeout: 
+119            logger.warn('Could not acquire lock %s in %s seconds' % ( 
+120                lock_filename, timeout)) 
+121            # Close the file and open in fallback_mode. 
+122            if self._fh: 
+123              self._fh.close() 
+124            self._fh = open(self._filename, self._fallback_mode) 
+125            return 
+126          time.sleep(delay) 
+
    127   
+
    128 -  def unlock_and_close(self): 
+
    129      """Unlock a file by removing the .lock file, and close the handle.""" 
+130      if self._locked: 
+131        lock_filename = self._posix_lockfile(self._filename) 
+132        os.unlink(lock_filename) 
+133        os.close(self._lock_fd) 
+134        self._locked = False 
+135        self._lock_fd = None 
+136      if self._fh: 
+137        self._fh.close() 
+
    138   
+
    139 -  def _posix_lockfile(self, filename): 
+
    140      """The name of the lock file to use for posix locking.""" 
+141      return '%s.lock' % filename 
+
    142   
+143   
+144  try: 
+145    import fcntl 
+
    146 -  class _FcntlOpener(_Opener): 
+
    147      """Open, lock, and unlock a file using fcntl.lockf.""" 
+148   
+
    149 -    def open_and_lock(self, timeout, delay): 
+
    150        """Open the file and lock it. 
+151   
+152        Args: 
+153          timeout: float, How long to try to lock for. 
+154          delay: float, How long to wait between retries 
+155   
+156        Raises: 
+157          AlreadyLockedException: if the lock is already acquired. 
+158          IOError: if the open fails. 
+159        """ 
+160        if self._locked: 
+161          raise AlreadyLockedException('File %s is already locked' % 
+162                                       self._filename) 
+163        start_time = time.time() 
+164   
+165        try: 
+166          self._fh = open(self._filename, self._mode) 
+167        except IOError, e: 
+168          # If we can't access with _mode, try _fallback_mode and don't lock. 
+169          if e.errno == errno.EACCES: 
+170            self._fh = open(self._filename, self._fallback_mode) 
+171            return 
+172   
+173        # We opened in _mode, try to lock the file. 
+174        while True: 
+175          try: 
+176            fcntl.lockf(self._fh.fileno(), fcntl.LOCK_EX) 
+177            self._locked = True 
+178            return 
+179          except IOError, e: 
+180            # If not retrying, then just pass on the error. 
+181            if timeout == 0: 
+182              raise e 
+183            if e.errno != errno.EACCES: 
+184              raise e 
+185            # We could not acquire the lock.  Try again. 
+186            if (time.time() - start_time) >= timeout: 
+187              logger.warn('Could not lock %s in %s seconds' % ( 
+188                  self._filename, timeout)) 
+189              if self._fh: 
+190                self._fh.close() 
+191              self._fh = open(self._filename, self._fallback_mode) 
+192              return 
+193            time.sleep(delay) 
+
    194   
+195   
+
    196 -    def unlock_and_close(self): 
+
    197        """Close and unlock the file using the fcntl.lockf primitive.""" 
+198        if self._locked: 
+199          fcntl.lockf(self._fh.fileno(), fcntl.LOCK_UN) 
+200        self._locked = False 
+201        if self._fh: 
+202          self._fh.close() 
+
    203  except ImportError: 
+204    _FcntlOpener = None 
+205   
+206   
+
    207 -class LockedFile(object): 
+
    208    """Represent a file that has exclusive access.""" 
+209   
+
    210 -  def __init__(self, filename, mode, fallback_mode, use_fcntl=True): 
+
    211      """Construct a LockedFile. 
+212   
+213      Args: 
+214        filename: string, The path of the file to open. 
+215        mode: string, The mode to try to open the file with. 
+216        fallback_mode: string, The mode to use if locking fails. 
+217        use_fcntl: string, Whether or not fcntl-based locking should be used. 
+218      """ 
+219      if not use_fcntl: 
+220        self._opener = _PosixOpener(filename, mode, fallback_mode) 
+221      else: 
+222        if _FcntlOpener: 
+223          self._opener = _FcntlOpener(filename, mode, fallback_mode) 
+224        else: 
+225          self._opener = _PosixOpener(filename, mode, fallback_mode) 
+
    226   
+
    227 -  def filename(self): 
+
    228      """Return the filename we were constructed with.""" 
+229      return self._opener._filename 
+
    230   
+
    231 -  def file_handle(self): 
+
    232      """Return the file_handle to the opened file.""" 
+233      return self._opener.file_handle() 
+
    234   
+
    235 -  def is_locked(self): 
+
    236      """Return whether we successfully locked the file.""" 
+237      return self._opener.is_locked() 
+
    238   
+
    239 -  def open_and_lock(self, timeout=0, delay=0.05): 
+
    240      """Open the file, trying to lock it. 
+241   
+242      Args: 
+243        timeout: float, The number of seconds to try to acquire the lock. 
+244        delay: float, The number of seconds to wait between retry attempts. 
+245   
+246      Raises: 
+247        AlreadyLockedException: if the lock is already acquired. 
+248        IOError: if the open fails. 
+249      """ 
+250      self._opener.open_and_lock(timeout, delay) 
+
    251   
+
    252 -  def unlock_and_close(self): 
+
    253      """Unlock and close a file.""" 
+254      self._opener.unlock_and_close() 
+
    255   
+
    +
    + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:59 2012 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/epy/oauth2client.locked_file.AlreadyLockedException-class.html b/docs/epy/oauth2client.locked_file.AlreadyLockedException-class.html new file mode 100644 index 0000000..50e0dba --- /dev/null +++ b/docs/epy/oauth2client.locked_file.AlreadyLockedException-class.html @@ -0,0 +1,202 @@ + + + + + oauth2client.locked_file.AlreadyLockedException + + + + + + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + + Package oauth2client :: + Module locked_file :: + Class AlreadyLockedException + + + + + + +
    [hide private]
    [frames] | no frames]
    +
    + +

    Class AlreadyLockedException

    source code

    +
    +
    + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    +Trying to lock a file that has already been locked by the LockedFile.
+
+
    + + + + + + + + + + +
    + + + + + +
    Instance Methods[hide private]
    +
    +

    Inherited from exceptions.Exception: + __init__, + __new__ +

    +

    Inherited from exceptions.BaseException: + __delattr__, + __getattribute__, + __getitem__, + __getslice__, + __reduce__, + __repr__, + __setattr__, + __setstate__, + __str__, + __unicode__ +

    +

    Inherited from object: + __format__, + __hash__, + __reduce_ex__, + __sizeof__, + __subclasshook__ +

    +
    + + + + + + + + + +
    + + + + + +
    Properties[hide private]
    +
    +

    Inherited from exceptions.BaseException: + args, + message +

    +

    Inherited from object: + __class__ +

    +
    + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:58 2012 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/epy/oauth2client.locked_file.LockedFile-class.html b/docs/epy/oauth2client.locked_file.LockedFile-class.html new file mode 100644 index 0000000..1345b66 --- /dev/null +++ b/docs/epy/oauth2client.locked_file.LockedFile-class.html @@ -0,0 +1,374 @@ + + + + + oauth2client.locked_file.LockedFile + + + + + + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + + Package oauth2client :: + Module locked_file :: + Class LockedFile + + + + + + +
    [hide private]
    [frames] | no frames]
    +
    + +

    Class LockedFile

    source code

    +
    +
    + + + + + + + + + +
    +
    +
    +
    +Represent a file that has exclusive access.
+
+
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + +
    Instance Methods[hide private]
    +
    +   + + + + + + +
    __init__(self, + filename, + mode, + fallback_mode, + use_fcntl=True)
    + Construct a LockedFile.    		 + source code + +
    + +
    +   + + + + + + +
    filename(self)
    + Return the filename we were constructed with.    		 + source code + +
    + +
    +   + + + + + + +
    file_handle(self)
    + Return the file_handle to the opened file.    		 + source code + +
    + +
    +   + + + + + + +
    is_locked(self)
    + Return whether we successfully locked the file.    		 + source code + +
    + +
    +   + + + + + + +
    open_and_lock(self, + timeout=0, + delay=0.05)
    + Open the file, trying to lock it.    		 + source code + +
    + +
    +   + + + + + + +
    unlock_and_close(self)
    + Unlock and close a file.    		 + source code + +
    + +
    +

    Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

    +
    + + + + + + + + + +
    + + + + + +
    Properties[hide private]
    +
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + + + + + +
    Method Details[hide private]
    +
    + +
    + +
    + + +
    +

    __init__(self, + filename, + mode, + fallback_mode, + use_fcntl=True) +
    (Constructor) +

    +     		source code  +
    + + 
    +Construct a LockedFile.
+
+Args:
+  filename: string, The path of the file to open.
+  mode: string, The mode to try to open the file with.
+  fallback_mode: string, The mode to use if locking fails.
+  use_fcntl: string, Whether or not fcntl-based locking should be used.
+
+
    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    open_and_lock(self, + timeout=0, + delay=0.05) +

    +     		source code  +
    + + 
    +Open the file, trying to lock it.
+
+Args:
+  timeout: float, The number of seconds to try to acquire the lock.
+  delay: float, The number of seconds to wait between retry attempts.
+
+Raises:
+  AlreadyLockedException: if the lock is already acquired.
+  IOError: if the open fails.
+
+
    +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:58 2012 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/epy/oauth2client.locked_file._FcntlOpener-class.html b/docs/epy/oauth2client.locked_file._FcntlOpener-class.html new file mode 100644 index 0000000..f6c481c --- /dev/null +++ b/docs/epy/oauth2client.locked_file._FcntlOpener-class.html @@ -0,0 +1,301 @@ + + + + + oauth2client.locked_file._FcntlOpener + + + + + + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + + Package oauth2client :: + Module locked_file :: + Class _FcntlOpener + + + + + + +
    [hide private]
    [frames] | no frames]
    +
    + +

    Class _FcntlOpener

    source code

    +
    +
    + + + + + + + + + + +
    +
    +
    +
    +Open, lock, and unlock a file using fcntl.lockf.
+
+
    + + + + + + + + + + + + + + + + +
    + + + + + +
    Instance Methods[hide private]
    +
    +   + + + + + + +
    open_and_lock(self, + timeout, + delay)
    + Open the file and lock it.    		 + source code + +
    + +
    +   + + + + + + +
    unlock_and_close(self)
    + Close and unlock the file using the fcntl.lockf primitive.    		 + source code + +
    + +
    +

    Inherited from _Opener: + __init__, + file_handle, + filename, + is_locked +

    +

    Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

    +
    + + + + + + + + + +
    + + + + + +
    Properties[hide private]
    +
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + + + + + +
    Method Details[hide private]
    +
    + +
    + +
    + + +
    +

    open_and_lock(self, + timeout, + delay) +

    +     		source code  +
    + + 
    +Open the file and lock it.
+
+Args:
+  timeout: float, How long to try to lock for.
+  delay: float, How long to wait between retries
+
+Raises:
+  AlreadyLockedException: if the lock is already acquired.
+  IOError: if the open fails.
+
+
    +
    +
    Overrides: + _Opener.open_and_lock +
    +
    +
    +
    + +
    + +
    + + +
    +

    unlock_and_close(self) +

    +     		source code  +
    + + 
    +Close and unlock the file using the fcntl.lockf primitive.
+
+
    +
    +
    Overrides: + _Opener.unlock_and_close +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:58 2012 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/epy/oauth2client.locked_file._Opener-class.html b/docs/epy/oauth2client.locked_file._Opener-class.html new file mode 100644 index 0000000..c395e7b --- /dev/null +++ b/docs/epy/oauth2client.locked_file._Opener-class.html @@ -0,0 +1,402 @@ + + + + + oauth2client.locked_file._Opener + + + + + + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + + Package oauth2client :: + Module locked_file :: + Class _Opener + + + + + + +
    [hide private]
    [frames] | no frames]
    +
    + +

    Class _Opener

    source code

    +
    +
    + + + + + + + + + + + +
    + +
    +
    +
    +Base class for different locking primitives.
+
+
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + +
    Instance Methods[hide private]
    +
    +   + + + + + + +
    __init__(self, + filename, + mode, + fallback_mode)
    + Create an Opener.    		 + source code + +
    + +
    +   + + + + + + +
    is_locked(self)
    + Was the file locked.    		 + source code + +
    + +
    +   + + + + + + +
    file_handle(self)
    + The file handle to the file.    		 + source code + +
    + +
    +   + + + + + + +
    filename(self)
    + The filename that is being locked.    		 + source code + +
    + +
    +   + + + + + + +
    open_and_lock(self, + timeout, + delay)
    + Open the file and lock it.    		 + source code + +
    + +
    +   + + + + + + +
    unlock_and_close(self)
    + Unlock and close the file.    		 + source code + +
    + +
    +

    Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

    +
    + + + + + + + + + +
    + + + + + +
    Properties[hide private]
    +
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + + + + + +
    Method Details[hide private]
    +
    + +
    + +
    + + +
    +

    __init__(self, + filename, + mode, + fallback_mode) +
    (Constructor) +

    +     		source code  +
    + + 
    +Create an Opener.
+
+Args:
+  filename: string, The pathname of the file.
+  mode: string, The preferred mode to access the file with.
+  fallback_mode: string, The mode to use if locking fails.
+
+
    +
    +
    Overrides: + object.__init__ +
    +
    +
    +
    + +
    + +
    + + +
    +

    file_handle(self) +

    +     		source code  +
    + + 
    +The file handle to the file.  Valid only after opened.
+
+
    +
    +
    +
    +
    + +
    + +
    + + +
    +

    open_and_lock(self, + timeout, + delay) +

    +     		source code  +
    + + 
    +Open the file and lock it.
+
+Args:
+  timeout: float, How long to try to lock for.
+  delay: float, How long to wait between retries.
+
+
    +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:58 2012 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/epy/oauth2client.locked_file._PosixOpener-class.html b/docs/epy/oauth2client.locked_file._PosixOpener-class.html new file mode 100644 index 0000000..91e43b8 --- /dev/null +++ b/docs/epy/oauth2client.locked_file._PosixOpener-class.html @@ -0,0 +1,321 @@ + + + + + oauth2client.locked_file._PosixOpener + + + + + + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + + Package oauth2client :: + Module locked_file :: + Class _PosixOpener + + + + + + +
    [hide private]
    [frames] | no frames]
    +
    + +

    Class _PosixOpener

    source code

    +
    +
    + + + + + + + + + + +
    +
    +
    +
    +Lock files using Posix advisory lock files.
+
+
    + + + + + + + + + + + + + + + + + + + +
    + + + + + +
    Instance Methods[hide private]
    +
    +   + + + + + + +
    open_and_lock(self, + timeout, + delay)
    + Open the file and lock it.    		 + source code + +
    + +
    +   + + + + + + +
    unlock_and_close(self)
    + Unlock a file by removing the .lock file, and close the handle.    		 + source code + +
    + +
    +   + + + + + + +
    _posix_lockfile(self, + filename)
    + The name of the lock file to use for posix locking.    		 + source code + +
    + +
    +

    Inherited from _Opener: + __init__, + file_handle, + filename, + is_locked +

    +

    Inherited from object: + __delattr__, + __format__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __repr__, + __setattr__, + __sizeof__, + __str__, + __subclasshook__ +

    +
    + + + + + + + + + +
    + + + + + +
    Properties[hide private]
    +
    +

    Inherited from object: + __class__ +

    +
    + + + + + + +
    + + + + + +
    Method Details[hide private]
    +
    + +
    + +
    + + +
    +

    open_and_lock(self, + timeout, + delay) +

    +     		source code  +
    + + 
    +Open the file and lock it.
+
+Tries to create a .lock file next to the file we're trying to open.
+
+Args:
+  timeout: float, How long to try to lock for.
+  delay: float, How long to wait between retries.
+
+Raises:
+  AlreadyLockedException: if the lock is already acquired.
+  IOError: if the open fails.
+
+
    +
    +
    Overrides: + _Opener.open_and_lock +
    +
    +
    +
    + +
    + +
    + + +
    +

    unlock_and_close(self) +

    +     		source code  +
    + + 
    +Unlock a file by removing the .lock file, and close the handle.
+
+
    +
    +
    Overrides: + _Opener.unlock_and_close +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + +
       Trees      Indices      Help   
    + + + + + +
    + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:58 2012 + + http://epydoc.sourceforge.net +
    + + + + diff --git a/docs/epy/oauth2client.multistore_file-module.html b/docs/epy/oauth2client.multistore_file-module.html index 6698c6f..ae3a099 100644 --- a/docs/epy/oauth2client.multistore_file-module.html +++ b/docs/epy/oauth2client.multistore_file-module.html @@ -294,7 +294,7 @@ Returns:
    - Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 + Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:54 2012 33 34 import base64 35 import errno - 36 import fcntl - 37 import logging - 38 import os - 39 import threading - 40 - 41 from anyjson import simplejson - 42 from client import 36 import logging + 37 import os + 38 import threading + 39 + 40 from anyjson import simplejson + 41 from client import Storage as BaseStorage - 43 from client import Credentials + 42 from client import Credentials + 43 from locked_file import LockedFile 44 - 45 45 logger = logging.getLogger(__name__) +oauth2client.locked_file.logger +oauth2client.multistore_file.logger" class="py-name" href="#" onclick="return doclink('link-7', 'logger', 'link-7');">logger = logging.getLogger(__name__) 46 47 # A dict from 'filename'->_MultiStore instances - 48 _multistores = {} - 49 _multistores_lock = threading.Lock() + 48 _multistores = {} + 49 _multistores_lock = threading.Lock() 50 51
    52 -class Error(Exception): @@ -133,16 +134,20 @@ oauth2client.multistore_file.logger" class="py-name" href="#" onclick="return do 74 An object derived from client.Storage for getting/setting the 75 credential. 76 """ - 77 filename = os.path.realpath(os.path.expanduser(filename)) - 78 _multistores_lock.acquire() + 77 filename = os.path.realpath(os.path.expanduser(filename)) + 78 _multistores_lock.acquire() 79 try: - 80 multistore = _multistores.setdefault( - 81 filename, _MultiStore(filename, warn_on_readonly)) + 80 multistore = _multistores.setdefault( + 81 filename, _MultiStore(filename, warn_on_readonly)) 82 finally: - 83 _multistores_lock.release() + 83 _multistores_lock.release() 84 if type(scope) is list: 85 scope = ' '.join(scope) - 86 return multistore._get_storage(client_id, user_agent, scope) + 86 return multistore._get_storage(client_id, user_agent, scope)
    87 88
    89 -class _MultiStore(object): @@ -153,319 +158,333 @@ oauth2client.multistore_file.logger" class="py-name" href="#" onclick="return do 94 95 This will create the file if necessary. 96 """ - 97 self._filename = filename + 97 self._file = LockedFile(filename, 'r+b', 'rb') 98 self._thread_lock = threading.Lock() - 99 self._file_handle = None -100 self._read_only = False -101 self._warn_on_readonly = warn_on_readonly -102 -103 self._create_file_if_needed() -104 -105 # Cache of deserialized store. This is only valid after the -106 # _MultiStore is locked or _refresh_data_cache is called. This is -107 # of the form of: -108 # -109 # (client_id, user_agent, scope) -> OAuth2Credential -110 # -111 # If this is None, then the store hasn't been read yet. -112 self._data = None -
    113 -
    114 - class _Storage(BaseStorage): -
    115 """A Storage object that knows how to read/write a single credential.""" -116 -
    117 - def __init__(self, multistore, client_id, user_agent, scope): -
    118 self._multistore = multistore -119 self._client_id = client_id -120 self._user_agent = user_agent -121 self._scope = scope -
    122 -
    123 - def acquire_lock(self): -
    124 """Acquires any lock necessary to access this Storage. -125 -126 This lock is not reentrant. -127 """ -128 self._multistore._lock() -
    129 -
    130 - def release_lock(self): -
    131 """Release the Storage lock. -132 -133 Trying to release a lock that isn't held will result in a -134 RuntimeError. -135 """ -136 self._multistore._unlock() -
    137 -
    138 - def locked_get(self): -
    139 """Retrieve credential. -140 -141 The Storage lock must be held when this is called. -142 -143 Returns: -144 oauth2client.client.Credentials -145 """ -146 credential = self._multistore._get_credential( -147 self._client_id, self._user_agent, self._scope) -148 if credential: -149 credential.set_store(self) -150 return credential -
    151 -
    152 - def locked_put(self, credentials): -
    153 """Write a credential. -154 -155 The Storage lock must be held when this is called. -156 -157 Args: -158 credentials: Credentials, the credentials to store. -159 """ -160 self._multistore._update_credential(credentials, self._scope) -
    161 -
    162 - def locked_delete(self): -
    163 """Delete a credential. -164 -165 The Storage lock must be held when this is called. -166 -167 Args: -168 credentials: Credentials, the credentials to store. -169 """ -170 self._multistore._delete_credential(self._client_id, self._user_agent, -171 self._scope) -
    172 -
    173 - def _create_file_if_needed(self): -
    174 """Create an empty file if necessary. -175 -176 This method will not initialize the file. Instead it implements a -177 simple version of "touch" to ensure the file has been created. -178 """ -179 if not os.path.exists(self._filename): -180 old_umask = os.umask(0177) -181 try: -182 open(self._filename, 'a+b').close() -183 finally: -184 os.umask(old_umask) -
    185 -
    186 - def _lock(self): -
    187 """Lock the entire multistore.""" -188 self._thread_lock.acquire() -189 # Check to see if the file is writeable. -190 try: -191 self._file_handle = open(self._filename, 'r+b') -192 fcntl.lockf(self._file_handle.fileno(), fcntl.LOCK_EX) -193 except IOError, e: -194 if e.errno != errno.EACCES: -195 raise e -196 self._file_handle = open(self._filename, 'rb') -197 self._read_only = True -198 if self._warn_on_readonly: -199 99 self._read_only = False +100 self._warn_on_readonly = warn_on_readonly +101 +102 self._create_file_if_needed() +103 +104 # Cache of deserialized store. This is only valid after the +105 # _MultiStore is locked or _refresh_data_cache is called. This is +106 # of the form of: +107 # +108 # (client_id, user_agent, scope) -> OAuth2Credential +109 # +110 # If this is None, then the store hasn't been read yet. +111 self._data = None +
    112 +
    113 - class _Storage(BaseStorage): +
    114 """A Storage object that knows how to read/write a single credential.""" +115 +
    116 - def __init__(self, multistore, client_id, user_agent, scope): +
    117 self._multistore = multistore +118 self._client_id = client_id +119 self._user_agent = user_agent +120 self._scope = scope +
    121 +
    122 - def acquire_lock(self): +
    123 """Acquires any lock necessary to access this Storage. +124 +125 This lock is not reentrant. +126 """ +127 self._multistore._lock() +
    128 +
    129 - def release_lock(self): +
    130 """Release the Storage lock. +131 +132 Trying to release a lock that isn't held will result in a +133 RuntimeError. +134 """ +135 self._multistore._unlock() +
    136 +
    137 - def locked_get(self): +
    138 """Retrieve credential. +139 +140 The Storage lock must be held when this is called. +141 +142 Returns: +143 oauth2client.client.Credentials +144 """ +145 credential = self._multistore._get_credential( +146 self._client_id, self._user_agent, self._scope) +147 if credential: +148 credential.set_store(self) +149 return credential +
    150 +
    151 - def locked_put(self, credentials): +
    152 """Write a credential. +153 +154 The Storage lock must be held when this is called. +155 +156 Args: +157 credentials: Credentials, the credentials to store. +158 """ +159 self._multistore._update_credential(credentials, self._scope) +
    160 +
    161 - def locked_delete(self): +
    162 """Delete a credential. +163 +164 The Storage lock must be held when this is called. +165 +166 Args: +167 credentials: Credentials, the credentials to store. +168 """ +169 self._multistore._delete_credential(self._client_id, self._user_agent, +170 self._scope) +
    171 +
    172 - def _create_file_if_needed(self): +
    173 """Create an empty file if necessary. +174 +175 This method will not initialize the file. Instead it implements a +176 simple version of "touch" to ensure the file has been created. +177 """ +178 if not os.path.exists(self._file.filename()): +179 old_umask = os.umask(0177) +180 try: +181 open(self._file.filename(), 'a+b').close() +182 finally: +183 os.umask(old_umask) +
    184 +
    185 - def _lock(self): +
    186 """Lock the entire multistore.""" +187 self._thread_lock.acquire() +188 self._file.open_and_lock() +189 if not self._file.is_locked(): +190 self._read_only = True +191 if self._warn_on_readonly: +192 logger.warn('The credentials file (%s) is not writable. Opening in ' -200 'read-only mode. Any refreshed credentials will only be ' -201 'valid for this run.' % self._filename) -202 if os.path.getsize(self._filename) == 0: -203 logger.warn('The credentials file (%s) is not writable. Opening in ' +193 'read-only mode. Any refreshed credentials will only be ' +194 'valid for this run.' % self._file.filename()) +195 if os.path.getsize(self._file.filename()) == 0: +196 logger.debug('Initializing empty multistore file') -204 # The multistore is empty so write out an empty file. -205 self._data = {} -206 self._write() -207 elif not self._read_only or self._data is None: -208 # Only refresh the data if we are read/write or we haven't -209 # cached the data yet. If we are readonly, we assume is isn't -210 # changing out from under us and that we only have to read it -211 # once. This prevents us from whacking any new access keys that -212 # we have cached in memory but were unable to write out. -213 self._refresh_data_cache() -
    214 -
    215 - def _unlock(self): -
    216 """Release the lock on the multistore.""" -217 if not self._read_only: -218 fcntl.lockf(self._file_handle.fileno(), fcntl.LOCK_UN) -219 self._file_handle.close() -220 self._thread_lock.release() -
    221 -
    222 - def _locked_json_read(self): -
    223 """Get the raw content of the multistore file. -224 -225 The multistore must be locked when this is called. -226 -227 Returns: -228 The contents of the multistore decoded as JSON. -229 """ -230 assert self._thread_lock.locked() -231 self._file_handle.seek(0) -232 return simplejson.load(self._file_handle) -
    233 -
    234 - def _locked_json_write(self, data): -
    235 """Write a JSON serializable data structure to the multistore. -236 -237 The multistore must be locked when this is called. -238 -239 Args: -240 data: The data to be serialized and written. -241 """ -242 assert self._thread_lock.locked() -243 if self._read_only: -244 return -245 self._file_handle.seek(0) -246 simplejson.dump(data, self._file_handle, sort_keys=True, indent=2) -247 self._file_handle.truncate() -
    248 -
    249 - def _refresh_data_cache(self): -
    250 """Refresh the contents of the multistore. -251 -252 The multistore must be locked when this is called. -253 -254 Raises: -255 NewerCredentialStoreError: Raised when a newer client has written the -256 store. -257 """ -258 self._data = {} -259 try: -260 raw_data = self._locked_json_read() -261 except Exception: -262 logger.debug('Initializing empty multistore file') +197 # The multistore is empty so write out an empty file. +198 self._data = {} +199 self._write() +200 elif not self._read_only or self._data is None: +201 # Only refresh the data if we are read/write or we haven't +202 # cached the data yet. If we are readonly, we assume is isn't +203 # changing out from under us and that we only have to read it +204 # once. This prevents us from whacking any new access keys that +205 # we have cached in memory but were unable to write out. +206 self._refresh_data_cache() +
    207 +
    208 - def _unlock(self): +
    209 """Release the lock on the multistore.""" +210 self._file.unlock_and_close() +211 self._thread_lock.release() +
    212 +
    213 - def _locked_json_read(self): +
    214 """Get the raw content of the multistore file. +215 +216 The multistore must be locked when this is called. +217 +218 Returns: +219 The contents of the multistore decoded as JSON. +220 """ +221 assert self._thread_lock.locked() +222 self._file.file_handle().seek(0) +223 return simplejson.load(self._file.file_handle()) +
    224 +
    225 - def _locked_json_write(self, data): +
    226 """Write a JSON serializable data structure to the multistore. +227 +228 The multistore must be locked when this is called. +229 +230 Args: +231 data: The data to be serialized and written. +232 """ +233 assert self._thread_lock.locked() +234 if self._read_only: +235 return +236 self._file.file_handle().seek(0) +237 simplejson.dump(data, self._file.file_handle(), sort_keys=True, indent=2) +238 self._file.file_handle().truncate() +
    239 +
    240 - def _refresh_data_cache(self): +
    241 """Refresh the contents of the multistore. +242 +243 The multistore must be locked when this is called. +244 +245 Raises: +246 NewerCredentialStoreError: Raised when a newer client has written the +247 store. +248 """ +249 self._data = {} +250 try: +251 raw_data = self._locked_json_read() +252 except Exception: +253 logger.warn('Credential data store could not be loaded. ' -263 'Will ignore and overwrite.') -264 return -265 -266 version = 0 -267 try: -268 version = raw_data['file_version'] -269 except Exception: -270 logger.warn('Credential data store could not be loaded. ' +254 'Will ignore and overwrite.') +255 return +256 +257 version = 0 +258 try: +259 version = raw_data['file_version'] +260 except Exception: +261 logger.warn('Missing version for credential data store. It may be ' -271 'corrupt or an old version. Overwriting.') -272 if version > 1: -273 raise NewerCredentialStoreError( -274 'Credential file has file_version of %d. ' -275 'Only file_version of 1 is supported.' % version) -276 -277 credentials = [] -278 try: -279 credentials = raw_data['data'] -280 except (TypeError, KeyError): -281 pass -282 -283 for cred_entry in credentials: -284 try: -285 (key, credential) = self._decode_credential_from_json(cred_entry) -286 self._data[key] = credential -287 except: -288 # If something goes wrong loading a credential, just ignore it -289 logger.warn('Missing version for credential data store. It may be ' +262 'corrupt or an old version. Overwriting.') +263 if version > 1: +264 raise NewerCredentialStoreError( +265 'Credential file has file_version of %d. ' +266 'Only file_version of 1 is supported.' % version) +267 +268 credentials = [] +269 try: +270 credentials = raw_data['data'] +271 except (TypeError, KeyError): +272 pass +273 +274 for cred_entry in credentials: +275 try: +276 (key, credential) = self._decode_credential_from_json(cred_entry) +277 self._data[key] = credential +278 except: +279 # If something goes wrong loading a credential, just ignore it +280 logger.info('Error decoding credential, skipping', exc_info=True) -
    290 -
    291 - def _decode_credential_from_json(self, cred_entry): -
    292 """Load a credential from our JSON serialization. -293 -294 Args: -295 cred_entry: A dict entry from the data member of our format -296 -297 Returns: -298 (key, cred) where the key is the key tuple and the cred is the -299 OAuth2Credential object. -300 """ -301 raw_key = cred_entry['key'] -302 client_id = raw_key['clientId'] -303 user_agent = raw_key['userAgent'] -304 scope = raw_key['scope'] -305 key = (client_id, user_agent, scope) -306 credential = None -307 credential = Credentials.new_from_json(simplejson.dumps(cred_entry['credential'])) -308 return (key, credential) -
    309 -
    310 - def _write(self): -
    311 """Write the cached data back out. -312 -313 The multistore must be locked. -314 """ -315 raw_data = {'file_version': 1} -316 raw_creds = [] -317 raw_data['data'] = raw_creds -318 for (cred_key, cred) in self._data.items(): -319 raw_key = { -320 'clientId': cred_key[0], -321 'userAgent': cred_key[1], -322 'scope': cred_key[2] -323 } -324 raw_cred = simplejson.loads(cred.logger.info('Error decoding credential, skipping', exc_info=True) +
    281 +
    282 - def _decode_credential_from_json(self, cred_entry): +
    283 """Load a credential from our JSON serialization. +284 +285 Args: +286 cred_entry: A dict entry from the data member of our format +287 +288 Returns: +289 (key, cred) where the key is the key tuple and the cred is the +290 OAuth2Credential object. +291 """ +292 raw_key = cred_entry['key'] +293 client_id = raw_key['clientId'] +294 user_agent = raw_key['userAgent'] +295 scope = raw_key['scope'] +296 key = (client_id, user_agent, scope) +297 credential = None +298 credential = Credentials.new_from_json(simplejson.dumps(cred_entry['credential'])) +299 return (key, credential) +
    300 +
    301 - def _write(self): +
    302 """Write the cached data back out. +303 +304 The multistore must be locked. +305 """ +306 raw_data = {'file_version': 1} +307 raw_creds = [] +308 raw_data['data'] = raw_creds +309 for (cred_key, cred) in self._data.items(): +310 raw_key = { +311 'clientId': cred_key[0], +312 'userAgent': cred_key[1], +313 'scope': cred_key[2] +314 } +315 raw_cred = simplejson.loads(cred.to_json()) -325 raw_creds.append({'key': raw_key, 'credential': raw_cred}) -326 self._locked_json_write(raw_data) -
    327 -
    328 - def _get_credential(self, client_id, user_agent, scope): -
    329 """Get a credential from the multistore. -330 -331 The multistore must be locked. -332 -333 Args: -334 client_id: The client_id for the credential -335 user_agent: The user agent for the credential -336 scope: A string for the scope(s) being requested -337 -338 Returns: -339 The credential specified or None if not present -340 """ -341 key = (client_id, user_agent, scope) -342 -343 return self._data.to_json()) +316 raw_creds.append({'key': raw_key, 'credential': raw_cred}) +317 self._locked_json_write(raw_data) +
    318 +
    319 - def _get_credential(self, client_id, user_agent, scope): +
    320 """Get a credential from the multistore. +321 +322 The multistore must be locked. +323 +324 Args: +325 client_id: The client_id for the credential +326 user_agent: The user agent for the credential +327 scope: A string for the scope(s) being requested +328 +329 Returns: +330 The credential specified or None if not present +331 """ +332 key = (client_id, user_agent, scope) +333 +334 return self._data.get(key, None) -
    344 -
    345 - def _update_credential(self, cred, scope): -
    346 """Update a credential and write the multistore. -347 -348 This must be called when the multistore is locked. -349 -350 Args: -351 cred: The OAuth2Credential to update/set -352 scope: The scope(s) that this credential covers -353 """ -354 key = (cred.client_id, cred.user_agent, scope) -355 self._data[key] = cred -356 self._write() -
    357 -
    358 - def _delete_credential(self, client_id, user_agent, scope): -
    359 """Delete a credential and write the multistore. -360 -361 This must be called when the multistore is locked. -362 -363 Args: -364 client_id: The client_id for the credential -365 user_agent: The user agent for the credential -366 scope: The scope(s) that this credential covers -367 """ -368 key = (client_id, user_agent, scope) -369 try: -370 del self._data[key] -371 except KeyError: -372 pass -373 self._write() -
    374 -
    375 - def _get_storage(self, client_id, user_agent, scope): -
    376 """Get a Storage object to get/set a credential. -377 -378 This Storage is a 'view' into the multistore. -379 -380 Args: -381 client_id: The client_id for the credential -382 user_agent: The user agent for the credential -383 scope: A string for the scope(s) being requested -384 -385 Returns: -386 A Storage object that can be used to get/set this cred -387 """ -388 return self._Storage(self, client_id, user_agent, scope) -
    389 + + diff --git a/docs/epy/toc.html b/docs/epy/toc.html index 2d70785..f213ddb 100644 --- a/docs/epy/toc.html +++ b/docs/epy/toc.html @@ -16,10 +16,7 @@

    Modules

    apiclient
    apiclient.contrib
    apiclient.contrib.latitude
    apiclient.contrib.moderator
    apiclient
    apiclient.discovery
    apiclient.errors
    apiclient.ext
    oauth2client.clientsecrets
    oauth2client.crypt
    oauth2client.django_orm
    oauth2client.file
    oauth2client.file
    oauth2client.locked_file
    oauth2client.multistore_file
    oauth2client.tools
    [ 
     
    oauth2client.anyjson    		index
    /home/jcgregorio/projects/apiclient-release/oauth2client/anyjson.py
    +>index
    /home/jcgregorio/projects/clean/oauth2client/anyjson.py

    Utility module to import a JSON module
     
    Hides all the messy details of exactly where
    diff --git a/docs/oauth2client.appengine.html b/docs/oauth2client.appengine.html index 632c947..d79e342 100644 --- a/docs/oauth2client.appengine.html +++ b/docs/oauth2client.appengine.html @@ -8,7 +8,7 @@

    		•  
     
    oauth2client.appengine    		index
    /home/jcgregorio/projects/apiclient-release/oauth2client/appengine.py
    +>index
    /home/jcgregorio/projects/clean/oauth2client/appengine.py

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

    @@ -627,6 +627,8 @@ Returns:
      Datastore representation of the new model value in a form that is
      appropriate for storing in the datastore, or AUTO_UPDATE_UNCHANGED. +
    make_value_from_datastore_index_value(self, index_value)
    +
    Data descriptors inherited from google.appengine.ext.db.Property:
    __dict__
    @@ -726,6 +728,8 @@ Returns:
      Datastore representation of the new model value in a form that is
      appropriate for storing in the datastore, or AUTO_UPDATE_UNCHANGED.
    +
    make_value_from_datastore_index_value(self, index_value)
    +
    Data descriptors inherited from google.appengine.ext.db.Property:
    __dict__
    diff --git a/docs/oauth2client.client.html b/docs/oauth2client.client.html index c8d10f4..ae1104a 100644 --- a/docs/oauth2client.client.html +++ b/docs/oauth2client.client.html @@ -8,7 +8,7 @@
    		 
     
    oauth2client.client    		index
    /home/jcgregorio/projects/apiclient-release/oauth2client/client.py
    +>index
    /home/jcgregorio/projects/clean/oauth2client/client.py

    An OAuth 2.0 client.
     
    Tools for interacting with OAuth 2.0 protected resources.

    @@ -517,8 +517,9 @@ Returns:
    Class methods defined here:
    -
    from_json(cls, s) from __builtin__.type
    Instantiate a Credentials object from a JSON description of it. The JSON
    -should have been produced by calling .to_json() on the object.
    +
    from_json(cls, s) from __builtin__.type
    Instantiate a Credentials object from a JSON description of it.
    + 
    +The JSON should have been produced by calling .to_json() on the object.
     
    Args:
      data: dict, A deserialized JSON object.
    @@ -1237,7 +1238,53 @@ Data descriptors inherited from exceptio Functions
           
    flow_from_clientsecrets(filename, scope, message=None)
    Create a Flow from a clientsecrets file.
    +
    credentials_from_clientsecrets_and_code(filename, scope, code, message=None, redirect_uri='postmessage', http=None)
    Returns OAuth2Credentials from a clientsecrets file and an auth code.
    + 
    +Will create the right kind of Flow based on the contents of the clientsecrets
    +file or will raise InvalidClientSecretsError for unknown types of Flows.
    + 
    +Args:
    +  filename: string, File name of clientsecrets.
    +  scope: string or list of strings, scope(s) to request.
    +  code: string, An authroization code, most likely passed down from
    +    the client
    +  message: string, A friendly string to display to the user if the
    +    clientsecrets file is missing or invalid. If message is provided then
    +    sys.exit will be called in the case of an error. If message in not
    +    provided then clientsecrets.InvalidClientSecretsError will be raised.
    +  redirect_uri: string, this is generally set to 'postmessage' to match the
    +    redirect_uri that the client specified
    +  http: httplib2.Http, optional http instance to use to do the fetch
    + 
    +Returns:
    +  An OAuth2Credentials object.
    + 
    +Raises:
    +  FlowExchangeError if the authorization code cannot be exchanged for an
    +   access token
    +  UnknownClientSecretsFlowError if the file describes an unknown kind of Flow.
    +  clientsecrets.InvalidClientSecretsError if the clientsecrets file is
    +    invalid.
    +
    credentials_from_code(client_id, client_secret, scope, code, redirect_uri='postmessage', http=None, user_agent=None, token_uri='https://accounts.google.com/o/oauth2/token')
    Exchanges an authorization code for an OAuth2Credentials object.
    + 
    +Args:
    +  client_id: string, client identifier.
    +  client_secret: string, client secret.
    +  scope: string or list of strings, scope(s) to request.
    +  code: string, An authroization code, most likely passed down from
    +    the client
    +  redirect_uri: string, this is generally set to 'postmessage' to match the
    +    redirect_uri that the client specified
    +  http: httplib2.Http, optional http instance to use to do the fetch
    +  token_uri: string, URI for token endpoint. For convenience
    +    defaults to Google's endpoints but any OAuth 2.0 provider can be used.
    +Returns:
    +  An OAuth2Credentials object.
    + 
    +Raises:
    +  FlowExchangeError if the authorization code cannot be exchanged for an
    +   access token
    +
    flow_from_clientsecrets(filename, scope, message=None)
    Create a Flow from a clientsecrets file.
     
    Will create the right kind of Flow based on the contents of the clientsecrets
    file or will raise InvalidClientSecretsError for unknown types of Flows.
    diff --git a/docs/oauth2client.clientsecrets.html b/docs/oauth2client.clientsecrets.html index c614399..e06b779 100644 --- a/docs/oauth2client.clientsecrets.html +++ b/docs/oauth2client.clientsecrets.html @@ -8,7 +8,7 @@
    		 
     
    oauth2client.clientsecrets    		index
    /home/jcgregorio/projects/apiclient-release/oauth2client/clientsecrets.py
    +>index
    /home/jcgregorio/projects/clean/oauth2client/clientsecrets.py

    Utilities for reading OAuth 2.0 client secret files.
     
    A client_secrets.json file contains all the information needed to interact with
    diff --git a/docs/oauth2client.crypt.html b/docs/oauth2client.crypt.html index 8a68690..89661b3 100644 --- a/docs/oauth2client.crypt.html +++ b/docs/oauth2client.crypt.html @@ -8,7 +8,7 @@

    		 
     
    oauth2client.crypt    		index
    /home/jcgregorio/projects/apiclient-release/oauth2client/crypt.py
    +>index
    /home/jcgregorio/projects/clean/oauth2client/crypt.py

    # -*- coding: utf-8 -*-
    #
    # Copyright (C) 2011 Google Inc.
    diff --git a/docs/oauth2client.django_orm.html b/docs/oauth2client.django_orm.html index 19d2633..97303aa 100644 --- a/docs/oauth2client.django_orm.html +++ b/docs/oauth2client.django_orm.html @@ -8,7 +8,7 @@

    		 
     
    oauth2client.django_orm    		index
    /home/jcgregorio/projects/apiclient-release/oauth2client/django_orm.py
    +>index
    /home/jcgregorio/projects/clean/oauth2client/django_orm.py

    OAuth 2.0 utilities for Django.
     
    Utilities for using OAuth 2.0 in conjunction with
    diff --git a/docs/oauth2client.file.html b/docs/oauth2client.file.html index 8d77ef0..899754d 100644 --- a/docs/oauth2client.file.html +++ b/docs/oauth2client.file.html @@ -8,7 +8,7 @@

    		 
     
    oauth2client.file    		index
    /home/jcgregorio/projects/apiclient-release/oauth2client/file.py
    +>index
    /home/jcgregorio/projects/clean/oauth2client/file.py

    Utilities for OAuth.
     
    Utilities for making it easier to work with OAuth 2.0
    diff --git a/docs/oauth2client.html b/docs/oauth2client.html index 5f9d4aa..2ffa4f8 100644 --- a/docs/oauth2client.html +++ b/docs/oauth2client.html @@ -8,7 +8,7 @@  
     
    oauth2client (version 1.0b9)    index
    /home/jcgregorio/projects/apiclient-release/oauth2client/__init__.py     +>index
    /home/jcgregorio/projects/clean/oauth2client/__init__.py

    @@ -24,9 +24,10 @@ crypt
    django_orm
    file
    +locked_file
    multistore_file
    -tools
    -

    +tools
    +

     
    diff --git a/docs/oauth2client.locked_file.html b/docs/oauth2client.locked_file.html new file mode 100644 index 0000000..454e789 --- /dev/null +++ b/docs/oauth2client.locked_file.html @@ -0,0 +1,179 @@ + + +Python: module oauth2client.locked_file + + + + +
     
    + 
    oauth2client.locked_file    		index
    /home/jcgregorio/projects/clean/oauth2client/locked_file.py
    +

    Locked file interface that should work on Unix and Windows pythons.
    + 
    +This module first tries to use fcntl locking to ensure serialized access
    +to a file, then falls back on a lock file if that is unavialable.
    + 
    +Usage:
    +    f = LockedFile('filename', 'r+b', 'rb')
    +    f.open_and_lock()
    +    if f.is_locked():
    +      print 'Acquired filename with r+b mode'
    +      f.file_handle().write('locked data')
    +    else:
    +      print 'Aquired filename with rb mode'
    +    f.unlock_and_close()

    +

    + + + + + +
     
    +Modules
           
    errno
    +fcntl
    +    		logging
    +os
    +    		time
    +

    + + + + + +
     
    +Classes
           
    +
    __builtin__.object +
    +
    +
    LockedFile +
    +
    +
    exceptions.Exception(exceptions.BaseException) +
    +
    +
    AlreadyLockedException +
    +
    +
    +

    + + + + + + + +
     
    +class AlreadyLockedException(exceptions.Exception)
       Trying to lock a file that has already been locked by the LockedFile.
     
     
    Method resolution order:
    +
    AlreadyLockedException
    +
    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
    +
    +

    + + + + + + + +
     
    +class LockedFile(__builtin__.object)
       Represent a file that has exclusive access.
     
     Methods defined here:
    +
    __init__(self, filename, mode, fallback_mode, use_fcntl=True)
    Construct a LockedFile.
    + 
    +Args:
    +  filename: string, The path of the file to open.
    +  mode: string, The mode to try to open the file with.
    +  fallback_mode: string, The mode to use if locking fails.
    +  use_fcntl: string, Whether or not fcntl-based locking should be used.
    + +
    file_handle(self)
    Return the file_handle to the opened file.
    + +
    filename(self)
    Return the filename we were constructed with.
    + +
    is_locked(self)
    Return whether we successfully locked the file.
    + +
    open_and_lock(self, timeout=0, delay=0.050000000000000003)
    Open the file, trying to lock it.
    + 
    +Args:
    +  timeout: float, The number of seconds to try to acquire the lock.
    +  delay: float, The number of seconds to wait between retry attempts.
    + 
    +Raises:
    +  AlreadyLockedException: if the lock is already acquired.
    +  IOError: if the open fails.
    + +
    unlock_and_close(self)
    Unlock and close a file.
    + +
    +Data descriptors defined here:
    +
    __dict__
    +
    dictionary for instance variables (if defined)
    +
    +
    __weakref__
    +
    list of weak references to the object (if defined)
    +
    +

    + + + + + +
     
    +Data
           __author__ = 'cache@google.com (David T McWherter)'
    +logger = <logging.Logger instance>

    + + + + + +
     
    +Author
           cache@google.com (David T McWherter)
    + \ No newline at end of file diff --git a/docs/oauth2client.multistore_file.html b/docs/oauth2client.multistore_file.html index 92b2afe..ded2a60 100644 --- a/docs/oauth2client.multistore_file.html +++ b/docs/oauth2client.multistore_file.html @@ -8,7 +8,7 @@

    		 
     
    oauth2client.multistore_file    		index
    /home/jcgregorio/projects/apiclient-release/oauth2client/multistore_file.py
    +>index
    /home/jcgregorio/projects/clean/oauth2client/multistore_file.py

    Multi-credential file store with lock support.
     
    This module implements a JSON credential store where multiple
    @@ -45,12 +45,11 @@ The format of the stored data is like so        
    base64
    errno
    -    		fcntl
    -logging
    -    		os
    -json
    -    		threading
    -

    +logging
    +os
    +json
    +threading
    +

     
    diff --git a/docs/oauth2client.tools.html b/docs/oauth2client.tools.html index 4e475b7..d2c73a8 100644 --- a/docs/oauth2client.tools.html +++ b/docs/oauth2client.tools.html @@ -8,7 +8,7 @@     		 
     
    oauth2client.tools    		index
    /home/jcgregorio/projects/apiclient-release/oauth2client/tools.py
    +>index
    /home/jcgregorio/projects/clean/oauth2client/tools.py

    Command-line tools for authenticating via OAuth 2.0
     
    Do the OAuth 2.0 Web Server dance for a command line application. Stores the
    diff --git a/docs/uritemplate.html b/docs/uritemplate.html index 3be8aeb..8d8a8b8 100644 --- a/docs/uritemplate.html +++ b/docs/uritemplate.html @@ -8,7 +8,7 @@  
     
    uritemplate    index
    /home/jcgregorio/projects/apiclient-release/uritemplate/__init__.py     +>index
    /home/jcgregorio/projects/clean/uritemplate/__init__.py

    # Early, and incomplete implementation of -04.
    #