diff --git a/FAQ b/FAQ
deleted file mode 100644
index dc736f2..0000000
--- a/FAQ
+++ /dev/null
@@ -1,8 +0,0 @@
-Frequently asked questions?
-
-
-Q: How do I work out the arguments and methods that are available for a particular API?
-A: http://api-python-client-doc.appspot.com/ has dynamically generated
- documentation for all the APIs supported by this library.
-
-
diff --git a/MANIFEST.in b/MANIFEST.in
index 1636df2..5c82446 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,7 +1 @@
-recursive-include uritemplate *.py
-recursive-include apiclient *.json *.py
-include CHANGELOG
-include LICENSE
include README
-include FAQ
-include setpath.sh
diff --git a/MANIFEST_oauth2client.in b/MANIFEST_oauth2client.in
deleted file mode 100644
index 5c82446..0000000
--- a/MANIFEST_oauth2client.in
+++ /dev/null
@@ -1 +0,0 @@
-include README
diff --git a/Makefile b/Makefile
index 7474bbf..17ca6b2 100644
--- a/Makefile
+++ b/Makefile
@@ -15,64 +15,23 @@ coverage:
.PHONY: docs
docs:
- cd docs; ./build.sh
- python describe.py
- python samples-index.py > ../google-api-python-client.wiki/SampleApps.wiki
-
-.PHONY: wiki
-wiki:
- python samples-index.py > ../google-api-python-client.wiki/SampleApps.wiki
+ cd docs; ./build
.PHONY: prerelease
-prerelease: test
- -rm -rf dist/
- -sudo rm -rf dist/
- -rm -rf snapshot/
- -sudo rm -rf snapshot/
- ./tools/gae-zip-creator.sh
- python expandsymlinks.py
- cd snapshot; python setup.py clean
- cd snapshot; python setup.py sdist --formats=gztar,zip
- cd snapshot; tar czf google-api-python-client-samples-$(shell python setup.py --version).tar.gz samples
- cd snapshot; zip -r google-api-python-client-samples-$(shell python setup.py --version).zip samples
-
-
-.PHONY: release
-release: prerelease
- @echo "This target will upload a new release to PyPi and code.google.com hosting."
- @echo "Are you sure you want to proceed? (yes/no)"
- @read yn; if [ yes -ne $(yn) ]; then exit 1; fi
- @echo "Here we go..."
- cd snapshot; python setup.py sdist --formats=gztar,zip register upload
- wget "http://support.googlecode.com/svn/trunk/scripts/googlecode_upload.py" -O googlecode_upload.py
- python googlecode_upload.py --summary="google-api-python-client Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/dist/*.tar.gz
- python googlecode_upload.py --summary="google-api-python-client Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/dist/*.zip
- python googlecode_upload.py --summary="Full Dependecies Build for Google App Engine Projects Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/dist/gae/*.zip
- python googlecode_upload.py --summary="Samples for google-api-python-client Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/google-api-python-client-samples-*.tar.gz
- python googlecode_upload.py --summary="Samples for google-api-python-client Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/google-api-python-client-samples-*.zip
-
-.PHONY: oauth2_prerelease
oauth2_prerelease: test
-rm -rf dist/
-sudo rm -rf dist/
-rm -rf snapshot/
-sudo rm -rf snapshot/
mkdir snapshot
- python expandsymlinks.py --source=oauth2client --dest=snapshot/oauth2client
- python expandsymlinks.py --source=uritemplate --dest=snapshot/uritemplate
- cp setup_oauth2client.py snapshot/setup.py
- cp MANIFEST_oauth2client.in snapshot/MANIFEST.in
- cp README_oauth2client snapshot/README
+ python expandsymlinks.py
cd snapshot; python setup.py clean
cd snapshot; python setup.py sdist --formats=gztar,zip
-.PHONY: oauth2_release
+.PHONY: release
oauth2_release: oauth2_prerelease
- @echo "This target will upload a new release to PyPi and code.google.com hosting."
+ @echo "This target will upload a new release to PyPi."
@echo "Are you sure you want to proceed? (yes/no)"
@read yn; if [ yes -ne $(yn) ]; then exit 1; fi
@echo "Here we go..."
cd snapshot; python setup.py sdist --formats=gztar,zip register upload
- wget "http://support.googlecode.com/svn/trunk/scripts/googlecode_upload.py" -O googlecode_upload.py
- python googlecode_upload.py --summary="oauth2client Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/dist/*.tar.gz
- python googlecode_upload.py --summary="oauth2client Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/dist/*.zip
diff --git a/README b/README
index 1c9ffcd..4b32ac0 100644
--- a/README
+++ b/README
@@ -1,18 +1,12 @@
-This is python client library for Google's discovery based APIs.
+This is a client library for accessing resources protected by OAuth 2.0.
Installation
============
-To install, simply use pip or easy_install:
+To install, simply say
- $ pip --upgrade google-api-python-client
-
- $ easy_install --upgrade google-api-python-client
-
-See the Developers Guide for more detailed instructions and documentation:
-
- https://developers.google.com/api-client-library/python/start/get_started
+ $ easy_install --upgrade oauth2client
Third Party Libraries
@@ -21,12 +15,8 @@ Third Party Libraries
These libraries will be installed when you install the client library:
http://code.google.com/p/httplib2
-http://code.google.com/p/uri-templates
Depending on your version of Python, these libraries may also be installed:
http://pypi.python.org/pypi/simplejson/
-For development you will also need:
-
-http://pythonpaste.org/webtest/
diff --git a/README_oauth2client b/README_oauth2client
deleted file mode 100644
index 4b32ac0..0000000
--- a/README_oauth2client
+++ /dev/null
@@ -1,22 +0,0 @@
-This is a client library for accessing resources protected by OAuth 2.0.
-
-
-Installation
-============
-
-To install, simply say
-
- $ easy_install --upgrade oauth2client
-
-
-Third Party Libraries
-=====================
-
-These libraries will be installed when you install the client library:
-
-http://code.google.com/p/httplib2
-
-Depending on your version of Python, these libraries may also be installed:
-
-http://pypi.python.org/pypi/simplejson/
-
diff --git a/TODO b/TODO
deleted file mode 100644
index aeca34a..0000000
--- a/TODO
+++ /dev/null
@@ -1,4 +0,0 @@
-TODO
-====
-
- - Maybe support Python 3.x?
diff --git a/describe.py b/describe.py
deleted file mode 100755
index 5cecf64..0000000
--- a/describe.py
+++ /dev/null
@@ -1,390 +0,0 @@
-#!/usr/bin/python
-#
-# Copyright 2012 Google Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""Create documentation for generate API surfaces.
-
-Command-line tool that creates documentation for all APIs listed in discovery.
-The documentation is generated from a combination of the discovery document and
-the generated API surface itself.
-"""
-
-__author__ = 'jcgregorio@google.com (Joe Gregorio)'
-
-import argparse
-import os
-import re
-import string
-import sys
-
-from apiclient.discovery import DISCOVERY_URI
-from apiclient.discovery import build
-from apiclient.discovery import build_from_document
-from oauth2client.anyjson import simplejson
-import httplib2
-import uritemplate
-
-CSS = """
-"""
-
-METHOD_TEMPLATE = """
-
$name($params)
-
$doc
-
- $name()
-
-Returns the $name Resource.
-"""
-
-METHOD_LINK = """
- $name($params)
-$firstline
"""
-
-BASE = 'docs/dyn'
-
-DIRECTORY_URI = 'https://www.googleapis.com/discovery/v1/apis?preferred=true'
-
-parser = argparse.ArgumentParser(description=__doc__)
-
-parser.add_argument('--discovery_uri_template', default=DISCOVERY_URI,
- help='URI Template for discovery.')
-
-parser.add_argument('--discovery_uri', default='',
- help=('URI of discovery document. If supplied then only '
- 'this API will be documented.'))
-
-parser.add_argument('--directory_uri', default=DIRECTORY_URI,
- help=('URI of directory document. Unused if --discovery_uri'
- ' is supplied.'))
-
-parser.add_argument('--dest', default=BASE,
- help='Directory name to write documents into.')
-
-
-
-def safe_version(version):
- """Create a safe version of the verion string.
-
- Needed so that we can distinguish between versions
- and sub-collections in URIs. I.e. we don't want
- adsense_v1.1 to refer to the '1' collection in the v1
- version of the adsense api.
-
- Args:
- version: string, The version string.
- Returns:
- The string with '.' replaced with '_'.
- """
-
- return version.replace('.', '_')
-
-
-def unsafe_version(version):
- """Undoes what safe_version() does.
-
- See safe_version() for the details.
-
-
- Args:
- version: string, The safe version string.
- Returns:
- The string with '_' replaced with '.'.
- """
-
- return version.replace('_', '.')
-
-
-def method_params(doc):
- """Document the parameters of a method.
-
- Args:
- doc: string, The method's docstring.
-
- Returns:
- The method signature as a string.
- """
- doclines = doc.splitlines()
- if 'Args:' in doclines:
- begin = doclines.index('Args:')
- if 'Returns:' in doclines[begin+1:]:
- end = doclines.index('Returns:', begin)
- args = doclines[begin+1: end]
- else:
- args = doclines[begin+1:]
-
- parameters = []
- for line in args:
- m = re.search('^\s+([a-zA-Z0-9_]+): (.*)', line)
- if m is None:
- continue
- pname = m.group(1)
- desc = m.group(2)
- if '(required)' not in desc:
- pname = pname + '=None'
- parameters.append(pname)
- parameters = ', '.join(parameters)
- else:
- parameters = ''
- return parameters
-
-
-def method(name, doc):
- """Documents an individual method.
-
- Args:
- name: string, Name of the method.
- doc: string, The methods docstring.
- """
-
- params = method_params(doc)
- return string.Template(METHOD_TEMPLATE).substitute(
- name=name, params=params, doc=doc)
-
-
-def breadcrumbs(path, root_discovery):
- """Create the breadcrumb trail to this page of documentation.
-
- Args:
- path: string, Dot separated name of the resource.
- root_discovery: Deserialized discovery document.
-
- Returns:
- HTML with links to each of the parent resources of this resource.
- """
- parts = path.split('.')
-
- crumbs = []
- accumulated = []
-
- for i, p in enumerate(parts):
- prefix = '.'.join(accumulated)
- # The first time through prefix will be [], so we avoid adding in a
- # superfluous '.' to prefix.
- if prefix:
- prefix += '.'
- display = p
- if i == 0:
- display = root_discovery.get('title', display)
- crumbs.append('%s' % (prefix + p, display))
- accumulated.append(p)
-
- return ' . '.join(crumbs)
-
-
-def document_collection(resource, path, root_discovery, discovery, css=CSS):
- """Document a single collection in an API.
-
- Args:
- resource: Collection or service being documented.
- path: string, Dot separated name of the resource.
- root_discovery: Deserialized discovery document.
- discovery: Deserialized discovery document, but just the portion that
- describes the resource.
- css: string, The CSS to include in the generated file.
- """
- collections = []
- methods = []
- resource_name = path.split('.')[-2]
- html = [
- '',
- css,
- '%s
' % breadcrumbs(path[:-1], root_discovery),
- 'Instance Methods
'
- ]
-
- # Which methods are for collections.
- for name in dir(resource):
- if not name.startswith('_') and callable(getattr(resource, name)):
- if hasattr(getattr(resource, name), '__is_resource__'):
- collections.append(name)
- else:
- methods.append(name)
-
-
- # TOC
- if collections:
- for name in collections:
- if not name.startswith('_') and callable(getattr(resource, name)):
- href = path + name + '.html'
- html.append(string.Template(COLLECTION_LINK).substitute(
- href=href, name=name))
-
- if methods:
- for name in methods:
- if not name.startswith('_') and callable(getattr(resource, name)):
- doc = getattr(resource, name).__doc__
- params = method_params(doc)
- firstline = doc.splitlines()[0]
- html.append(string.Template(METHOD_LINK).substitute(
- name=name, params=params, firstline=firstline))
-
- if methods:
- html.append('Method Details
')
- for name in methods:
- dname = name.rsplit('_')[0]
- html.append(method(name, getattr(resource, name).__doc__))
-
- html.append('')
-
- return '\n'.join(html)
-
-
-def document_collection_recursive(resource, path, root_discovery, discovery):
-
- html = document_collection(resource, path, root_discovery, discovery)
-
- f = open(os.path.join(FLAGS.dest, path + 'html'), 'w')
- f.write(html.encode('utf-8'))
- f.close()
-
- for name in dir(resource):
- if (not name.startswith('_')
- and callable(getattr(resource, name))
- and hasattr(getattr(resource, name), '__is_resource__')):
- dname = name.rsplit('_')[0]
- collection = getattr(resource, name)()
- document_collection_recursive(collection, path + name + '.', root_discovery,
- discovery['resources'].get(dname, {}))
-
-def document_api(name, version):
- """Document the given API.
-
- Args:
- name: string, Name of the API.
- version: string, Version of the API.
- """
- service = build(name, version)
- response, content = http.request(
- uritemplate.expand(
- FLAGS.discovery_uri_template, {
- 'api': name,
- 'apiVersion': version})
- )
- discovery = simplejson.loads(content)
-
- version = safe_version(version)
-
- document_collection_recursive(
- service, '%s_%s.' % (name, version), discovery, discovery)
-
-
-def document_api_from_discovery_document(uri):
- """Document the given API.
-
- Args:
- uri: string, URI of discovery document.
- """
- http = httplib2.Http()
- response, content = http.request(FLAGS.discovery_uri)
- discovery = simplejson.loads(content)
-
- service = build_from_document(discovery)
-
- name = discovery['version']
- version = safe_version(discovery['version'])
-
- document_collection_recursive(
- service, '%s_%s.' % (name, version), discovery, discovery)
-
-
-if __name__ == '__main__':
- FLAGS = parser.parse_args(sys.argv[1:])
- if FLAGS.discovery_uri:
- document_api_from_discovery_document(FLAGS.discovery_uri)
- else:
- http = httplib2.Http()
- resp, content = http.request(
- FLAGS.directory_uri,
- headers={'X-User-IP': '0.0.0.0'})
- if resp.status == 200:
- directory = simplejson.loads(content)['items']
- for api in directory:
- document_api(api['name'], api['version'])
- else:
- sys.exit("Failed to load the discovery document.")
diff --git a/docs/build.sh b/docs/build
similarity index 88%
rename from docs/build.sh
rename to docs/build
index d5cdeb6..d006fc6 100755
--- a/docs/build.sh
+++ b/docs/build
@@ -22,7 +22,6 @@
# Notes: You may have to update the location of the
# App Engine library for your local system.
-export GOOGLE_APPENGINE=$HOME/projects/google_appengine/
export DJANGO_SETTINGS_MODULE=fakesettings
-export PYTHONPATH=`pwd`/..:$GOOGLE_APPENGINE
-epydoc --output epy --graph all --parse-only --docformat plaintext apiclient oauth2client
+export PYTHONPATH=$(pwd)/..
+epydoc --output epy --graph all --parse-only --docformat plaintext oauth2client
diff --git a/docs/dyn/adexchangebuyer_v1_1.accounts.html b/docs/dyn/adexchangebuyer_v1_1.accounts.html
deleted file mode 100644
index 074dedb..0000000
--- a/docs/dyn/adexchangebuyer_v1_1.accounts.html
+++ /dev/null
@@ -1,258 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(id)
-Gets one account by ID.
-
- list()
-Retrieves the authenticated user's list of accounts.
-
- patch(id, body)
-Updates an existing account. This method supports patch semantics.
-
- update(id, body)
-Updates an existing account.
-Method Details
-
-
get(id)
-
Gets one account by ID.
-
-Args:
- id: integer, The account id (required)
-
-Returns:
- An object of the form:
-
- { # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
- # - ASIA
- # - EUROPE
- # - US_EAST
- # - US_WEST
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
-
list()
-
Retrieves the authenticated user's list of accounts.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
- "items": [ # A list of accounts.
- { # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
- # - ASIA
- # - EUROPE
- # - US_EAST
- # - US_WEST
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- },
- ],
- "kind": "adexchangebuyer#accountsList", # Resource type.
- }
-
-
patch(id, body)
-
Updates an existing account. This method supports patch semantics.
-
-Args:
- id: integer, The account id (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
- # - ASIA
- # - EUROPE
- # - US_EAST
- # - US_WEST
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
-
-Returns:
- An object of the form:
-
- { # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
- # - ASIA
- # - EUROPE
- # - US_EAST
- # - US_WEST
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
-
update(id, body)
-
Updates an existing account.
-
-Args:
- id: integer, The account id (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
- # - ASIA
- # - EUROPE
- # - US_EAST
- # - US_WEST
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
-
-Returns:
- An object of the form:
-
- { # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
- # - ASIA
- # - EUROPE
- # - US_EAST
- # - US_WEST
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
Instance Methods
-
- get(accountId, buyerCreativeId)
-Gets the status for a single creative.
-
- insert(body)
-Submit a new creative.
-
- list(pageToken=None, maxResults=None, statusFilter=None)
-Retrieves a list of the authenticated user's active creatives.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(accountId, buyerCreativeId)
-
Gets the status for a single creative.
-
-Args:
- accountId: integer, The id for the account that will serve this creative. (required)
- buyerCreativeId: string, The buyer-specific id for this creative. (required)
-
-Returns:
- An object of the form:
-
- { # A creative and its classification data.
- "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.
- "kind": "adexchangebuyer#creative", # Resource type.
- "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,
- ],
- "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.
- }
-
-
insert(body)
-
Submit a new creative.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A creative and its classification data.
- "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.
- "kind": "adexchangebuyer#creative", # Resource type.
- "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,
- ],
- "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.
- }
-
-
-Returns:
- An object of the form:
-
- { # A creative and its classification data.
- "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.
- "kind": "adexchangebuyer#creative", # Resource type.
- "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,
- ],
- "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.
- }
-
-
list(pageToken=None, maxResults=None, statusFilter=None)
-
Retrieves a list of the authenticated user's active creatives.
-
-Args:
- pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
- maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
- statusFilter: string, When specified, only creatives having the given status are returned.
- Allowed values
- approved - Creatives which have been approved.
- disapproved - Creatives which have been disapproved.
- not_checked - Creatives whose status is not yet checked.
-
-Returns:
- An object of the form:
-
- { # The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
- "nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # A list of creatives.
- { # A creative and its classification data.
- "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.
- "kind": "adexchangebuyer#creative", # Resource type.
- "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,
- ],
- "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.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(id)
-Gets one direct deal by ID.
-
- list()
-Retrieves the authenticated user's list of direct deals.
-Method Details
-
-
get(id)
-
Gets one direct deal by ID.
-
-Args:
- id: string, The direct deal id (required)
-
-Returns:
- An object of the form:
-
- { # The configuration data for an Ad Exchange direct deal.
- "advertiser": "A String", # The name of the advertiser this deal is for.
- "kind": "adexchangebuyer#directDeal", # Resource type.
- "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
- "fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code.
- "startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
- "endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
- "sellerNetwork": "A String", # The name of the publisher offering this direct deal.
- "id": "A String", # Deal id.
- "accountId": 42, # The account id of the buyer this deal is for.
- }
-
-
list()
-
Retrieves the authenticated user's list of direct deals.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.
- "kind": "adexchangebuyer#directDealsList", # Resource type.
- "directDeals": [ # A list of direct deals relevant for your account.
- { # The configuration data for an Ad Exchange direct deal.
- "advertiser": "A String", # The name of the advertiser this deal is for.
- "kind": "adexchangebuyer#directDeal", # Resource type.
- "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
- "fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code.
- "startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
- "endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
- "sellerNetwork": "A String", # The name of the publisher offering this direct deal.
- "id": "A String", # Deal id.
- "accountId": 42, # The account id of the buyer this deal is for.
- },
- ],
- }
-
Instance Methods
-
- accounts()
-
-Returns the accounts Resource.
-
-
- creatives()
-
-Returns the creatives Resource.
-
-
- directDeals()
-
-Returns the directDeals Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/adexchangebuyer_v1_2.accounts.html b/docs/dyn/adexchangebuyer_v1_2.accounts.html
deleted file mode 100644
index 3cc70b1..0000000
--- a/docs/dyn/adexchangebuyer_v1_2.accounts.html
+++ /dev/null
@@ -1,258 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(id)
-Gets one account by ID.
-
- list()
-Retrieves the authenticated user's list of accounts.
-
- patch(id, body)
-Updates an existing account. This method supports patch semantics.
-
- update(id, body)
-Updates an existing account.
-Method Details
-
-
get(id)
-
Gets one account by ID.
-
-Args:
- id: integer, The account id (required)
-
-Returns:
- An object of the form:
-
- { # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
- # - ASIA
- # - EUROPE
- # - US_EAST
- # - US_WEST
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
-
list()
-
Retrieves the authenticated user's list of accounts.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
- "items": [ # A list of accounts.
- { # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
- # - ASIA
- # - EUROPE
- # - US_EAST
- # - US_WEST
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- },
- ],
- "kind": "adexchangebuyer#accountsList", # Resource type.
- }
-
-
patch(id, body)
-
Updates an existing account. This method supports patch semantics.
-
-Args:
- id: integer, The account id (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
- # - ASIA
- # - EUROPE
- # - US_EAST
- # - US_WEST
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
-
-Returns:
- An object of the form:
-
- { # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
- # - ASIA
- # - EUROPE
- # - US_EAST
- # - US_WEST
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
-
update(id, body)
-
Updates an existing account.
-
-Args:
- id: integer, The account id (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
- # - ASIA
- # - EUROPE
- # - US_EAST
- # - US_WEST
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
-
-Returns:
- An object of the form:
-
- { # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
- # - ASIA
- # - EUROPE
- # - US_EAST
- # - US_WEST
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
Instance Methods
-
- get(accountId, buyerCreativeId)
-Gets the status for a single creative.
-
- insert(body)
-Submit a new creative.
-
- list(pageToken=None, maxResults=None, statusFilter=None)
-Retrieves a list of the authenticated user's active creatives.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(accountId, buyerCreativeId)
-
Gets the status for a single creative.
-
-Args:
- accountId: integer, The id for the account that will serve this creative. (required)
- buyerCreativeId: string, The buyer-specific id for this creative. (required)
-
-Returns:
- An object of the form:
-
- { # A creative and its classification data.
- "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.
- "kind": "adexchangebuyer#creative", # Resource type.
- "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
- "agencyId": "A String", # The agency id for this creative.
- "width": 42, # Ad width.
- "attribute": [ # All attributes for the ads that may be shown from this snippet.
- 42,
- ],
- "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 reasons 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.
- {
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
- "A String",
- ],
- },
- ],
- "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
- 42,
- ],
- "accountId": 42, # Account id.
- }
-
-
insert(body)
-
Submit a new creative.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A creative and its classification data.
- "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.
- "kind": "adexchangebuyer#creative", # Resource type.
- "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
- "agencyId": "A String", # The agency id for this creative.
- "width": 42, # Ad width.
- "attribute": [ # All attributes for the ads that may be shown from this snippet.
- 42,
- ],
- "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 reasons 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.
- {
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
- "A String",
- ],
- },
- ],
- "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
- 42,
- ],
- "accountId": 42, # Account id.
- }
-
-
-Returns:
- An object of the form:
-
- { # A creative and its classification data.
- "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.
- "kind": "adexchangebuyer#creative", # Resource type.
- "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
- "agencyId": "A String", # The agency id for this creative.
- "width": 42, # Ad width.
- "attribute": [ # All attributes for the ads that may be shown from this snippet.
- 42,
- ],
- "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 reasons 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.
- {
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
- "A String",
- ],
- },
- ],
- "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
- 42,
- ],
- "accountId": 42, # Account id.
- }
-
-
list(pageToken=None, maxResults=None, statusFilter=None)
-
Retrieves a list of the authenticated user's active creatives.
-
-Args:
- pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
- maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
- statusFilter: string, When specified, only creatives having the given status are returned.
- Allowed values
- approved - Creatives which have been approved.
- disapproved - Creatives which have been disapproved.
- not_checked - Creatives whose status is not yet checked.
-
-Returns:
- An object of the form:
-
- { # The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
- "nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # A list of creatives.
- { # A creative and its classification data.
- "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.
- "kind": "adexchangebuyer#creative", # Resource type.
- "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
- "agencyId": "A String", # The agency id for this creative.
- "width": 42, # Ad width.
- "attribute": [ # All attributes for the ads that may be shown from this snippet.
- 42,
- ],
- "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 reasons 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.
- {
- "reason": "A String", # The categorized reason for disapproval.
- "details": [ # Additional details about the reason for disapproval.
- "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.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(id)
-Gets one direct deal by ID.
-
- list()
-Retrieves the authenticated user's list of direct deals.
-Method Details
-
-
get(id)
-
Gets one direct deal by ID.
-
-Args:
- id: string, The direct deal id (required)
-
-Returns:
- An object of the form:
-
- { # The configuration data for an Ad Exchange direct deal.
- "advertiser": "A String", # The name of the advertiser this deal is for.
- "kind": "adexchangebuyer#directDeal", # Resource type.
- "privateExchangeMinCpm": "A String", # The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).
- "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
- "fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
- "startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
- "endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
- "sellerNetwork": "A String", # The name of the publisher offering this direct deal.
- "id": "A String", # Deal id.
- "accountId": 42, # The account id of the buyer this deal is for.
- }
-
-
list()
-
Retrieves the authenticated user's list of direct deals.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.
- "kind": "adexchangebuyer#directDealsList", # Resource type.
- "directDeals": [ # A list of direct deals relevant for your account.
- { # The configuration data for an Ad Exchange direct deal.
- "advertiser": "A String", # The name of the advertiser this deal is for.
- "kind": "adexchangebuyer#directDeal", # Resource type.
- "privateExchangeMinCpm": "A String", # The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).
- "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
- "fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
- "startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
- "endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
- "sellerNetwork": "A String", # The name of the publisher offering this direct deal.
- "id": "A String", # Deal id.
- "accountId": 42, # The account id of the buyer this deal is for.
- },
- ],
- }
-
Instance Methods
-
- accounts()
-
-Returns the accounts Resource.
-
-
- creatives()
-
-Returns the creatives Resource.
-
-
- directDeals()
-
-Returns the directDeals Resource.
-
-
- performanceReport()
-
-Returns the performanceReport Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/adexchangebuyer_v1_2.performanceReport.html b/docs/dyn/adexchangebuyer_v1_2.performanceReport.html
deleted file mode 100644
index 63f9f2d..0000000
--- a/docs/dyn/adexchangebuyer_v1_2.performanceReport.html
+++ /dev/null
@@ -1,108 +0,0 @@
-
-
-
-
-Instance Methods
-
- list(accountId, endDateTime, startDateTime)
-Retrieves the authenticated user's list of performance metrics.
-Method Details
-
-
list(accountId, endDateTime, startDateTime)
-
Retrieves the authenticated user's list of performance metrics.
-
-Args:
- accountId: string, The account id to get the reports for. (required)
- endDateTime: string, The end time for the reports. (required)
- startDateTime: string, The start time for the reports. (required)
-
-Returns:
- An object of the form:
-
- { # The configuration data for an Ad Exchange performance report list. TODO(nathanbullock): need to add some release tests before releasing this. https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py
- "kind": "adexchangebuyer#performanceReportList", # Resource type.
- "performance_report": [ # A list of performance reports relevant for the account.
- {
- "kind": "adexchangebuyer#performanceReport", # Resource type.
- "timestamp": "A String", # Timestamp of the starting time of this performance data.
- "region": "A String", # The trading location of this data.
- "latency50thPercentile": 3.14, # The Nth percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
- "latency85thPercentile": 3.14,
- "latency95thPercentile": 3.14,
- },
- ],
- }
-
Instance Methods
-
- list(pageToken=None, maxResults=None)
-List all ad clients in this Ad Exchange account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(pageToken=None, maxResults=None)
-
List all ad clients in this Ad Exchange account.
-
-Args:
- pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad clients returned in this list response.
- {
- "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
- "kind": "adexchangeseller#adClient", # Kind of resource this is, in this case adexchangeseller#adClient.
- "id": "A String", # Unique identifier of this ad client.
- "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
- "supportsReporting": True or False, # Whether this ad client supports being reported on.
- },
- ],
- "kind": "adexchangeseller#adClients", # Kind of list this is, in this case adexchangeseller#adClients.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(adClientId, adUnitId, pageToken=None, maxResults=None)
-List all custom channels which the specified ad unit belongs to.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(adClientId, adUnitId, pageToken=None, maxResults=None)
-
List all custom channels which the specified ad unit belongs to.
-
-Args:
- adClientId: string, Ad client which contains the ad unit. (required)
- adUnitId: string, Ad unit for which to list custom channels. (required)
- 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.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adexchangeseller#customChannel", # Kind of resource this is, in this case adexchangeseller#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adexchangeseller#customChannels", # Kind of list this is, in this case adexchangeseller#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- customchannels()
-
-Returns the customchannels Resource.
-
-
- get(adClientId, adUnitId)
-Gets the specified ad unit in the specified ad client.
-
- list(adClientId, pageToken=None, includeInactive=None, maxResults=None)
-List all ad units in the specified ad client for this Ad Exchange account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(adClientId, adUnitId)
-
Gets the specified ad unit in the specified ad client.
-
-Args:
- adClientId: string, Ad client for which to get the ad unit. (required)
- adUnitId: string, Ad unit to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adexchangeseller#adUnit", # Kind of resource this is, in this case adexchangeseller#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this ad unit.
- }
-
-
list(adClientId, pageToken=None, includeInactive=None, maxResults=None)
-
List all ad units in the specified ad client for this Ad Exchange account.
-
-Args:
- adClientId: string, Ad client for which to list ad units. (required)
- 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.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adexchangeseller#adUnit", # Kind of resource this is, in this case adexchangeseller#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this ad unit.
- },
- ],
- "kind": "adexchangeseller#adUnits", # Kind of list this is, in this case adexchangeseller#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
-List all ad units in the specified custom channel.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
-
List all ad units in the specified custom channel.
-
-Args:
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel for which to list ad units. (required)
- 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.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adexchangeseller#adUnit", # Kind of resource this is, in this case adexchangeseller#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this ad unit.
- },
- ],
- "kind": "adexchangeseller#adUnits", # Kind of list this is, in this case adexchangeseller#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- adunits()
-
-Returns the adunits Resource.
-
-
- get(adClientId, customChannelId)
-Get the specified custom channel from the specified ad client.
-
- list(adClientId, pageToken=None, maxResults=None)
-List all custom channels in the specified ad client for this Ad Exchange account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(adClientId, customChannelId)
-
Get the specified custom channel from the specified ad client.
-
-Args:
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adexchangeseller#customChannel", # Kind of resource this is, in this case adexchangeseller#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
-
list(adClientId, pageToken=None, maxResults=None)
-
List all custom channels in the specified ad client for this Ad Exchange account.
-
-Args:
- adClientId: string, Ad client for which to list custom channels. (required)
- 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.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adexchangeseller#customChannel", # Kind of resource this is, in this case adexchangeseller#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adexchangeseller#customChannels", # Kind of list this is, in this case adexchangeseller#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- adclients()
-
-Returns the adclients Resource.
-
-
- adunits()
-
-Returns the adunits Resource.
-
-
- customchannels()
-
-Returns the customchannels Resource.
-
-
- reports()
-
-Returns the reports Resource.
-
-
- urlchannels()
-
-Returns the urlchannels Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/adexchangeseller_v1.reports.html b/docs/dyn/adexchangeseller_v1.reports.html
deleted file mode 100644
index 4b2e40e..0000000
--- a/docs/dyn/adexchangeseller_v1.reports.html
+++ /dev/null
@@ -1,155 +0,0 @@
-
-
-
-
-Instance Methods
-
- saved()
-
-Returns the saved Resource.
-
-
- generate(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)
-Generate an Ad Exchange 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.
-
- generate_media(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)
-Generate an Ad Exchange 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.
-Method Details
-
-
generate(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)
-
Generate an Ad Exchange 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:
- 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)
- 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)
- 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)
- maxResults: integer, The maximum number of rows of report data to return.
- dimension: string, Dimensions to base the report on. (repeated)
- startIndex: integer, Index of the first row of report data to return.
- filter: string, Filters to be run on the report. (repeated)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adexchangeseller#report", # Kind this is, in this case adexchangeseller#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-
-
generate_media(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)
-
Generate an Ad Exchange 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:
- 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)
- 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)
- 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)
- maxResults: integer, The maximum number of rows of report data to return.
- dimension: string, Dimensions to base the report on. (repeated)
- startIndex: integer, Index of the first row of report data to return.
- filter: string, Filters to be run on the report. (repeated)
-
-Returns:
- The media object as a string.
-
-
-
Instance Methods
-
- generate(savedReportId, locale=None, maxResults=None, startIndex=None)
-Generate an Ad Exchange report based on the saved report ID sent in the query parameters.
-
- list(pageToken=None, maxResults=None)
-List all saved reports in this Ad Exchange account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
generate(savedReportId, locale=None, maxResults=None, startIndex=None)
-
Generate an Ad Exchange report based on the saved report ID sent in the query parameters.
-
-Args:
- savedReportId: string, The saved report to retrieve. (required)
- locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
- maxResults: integer, The maximum number of rows of report data to return.
- startIndex: integer, Index of the first row of report data to return.
-
-Returns:
- An object of the form:
-
- {
- "kind": "adexchangeseller#report", # Kind this is, in this case adexchangeseller#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-
-
list(pageToken=None, maxResults=None)
-
List all saved reports in this Ad Exchange account.
-
-Args:
- pageToken: string, A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of saved reports to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The saved reports returned in this list response.
- {
- "kind": "adexchangeseller#savedReport", # Kind of resource this is, in this case adexchangeseller#savedReport.
- "id": "A String", # Unique identifier of this saved report.
- "name": "A String", # This saved report's name.
- },
- ],
- "kind": "adexchangeseller#savedReports", # Kind of list this is, in this case adexchangeseller#savedReports.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(adClientId, pageToken=None, maxResults=None)
-List all URL channels in the specified ad client for this Ad Exchange account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(adClientId, pageToken=None, maxResults=None)
-
List all URL channels in the specified ad client for this Ad Exchange account.
-
-Args:
- adClientId: string, Ad client for which to list URL channels. (required)
- 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.
- maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The URL channels returned in this list response.
- {
- "kind": "adexchangeseller#urlChannel", # Kind of resource this is, in this case adexchangeseller#urlChannel.
- "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
- },
- ],
- "kind": "adexchangeseller#urlChannels", # Kind of list this is, in this case adexchangeseller#urlChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(userKey, applicationName, eventName=None, actorIpAddress=None, filters=None, maxResults=None, pageToken=None, startTime=None, endTime=None)
-Retrieves a list of activities for a specific customer and application.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(userKey, applicationName, eventName=None, actorIpAddress=None, filters=None, maxResults=None, pageToken=None, startTime=None, endTime=None)
-
Retrieves a list of activities for a specific customer and application.
-
-Args:
- userKey: string, Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. (required)
- applicationName: string, Application name for which the events are to be retrieved. (required)
- eventName: string, Name of the event being queried.
- actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
- filters: string, Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
- maxResults: integer, Number of activity records to be shown in each page.
- pageToken: string, Token to specify next page.
- startTime: string, Return events which occured at or after this time.
- endTime: string, Return events which occured at or before this time.
-
-Returns:
- An object of the form:
-
- { # JSON template for a collection of activites.
- "nextPageToken": "A String", # Token for retrieving the next page
- "items": [ # Each record in read response.
- { # JSON template for the activity resource.
- "kind": "admin#reports#activity", # Kind of resource this is.
- "ownerDomain": "A String", # Domain of source customer.
- "actor": { # User doing the action.
- "profileId": "A String", # Obfuscated user id of the user.
- "email": "A String", # Email address of the user.
- "key": "A String", # For OAuth 2LO API requests, consumer_key of the requestor.
- "callerType": "A String", # User or OAuth 2LO request.
- },
- "id": { # Unique identifier for each activity record.
- "applicationName": "A String", # Application name to which the event belongs.
- "uniqueQualifier": "A String", # Unique qualifier if multiple events have the same time.
- "customerId": "A String", # Obfuscated customer ID of the source customer.
- "time": "A String", # Time of occurrence of the activity.
- },
- "ipAddress": "A String", # IP Address of the user doing the action.
- "events": [ # Activity events.
- {
- "type": "A String", # Type of event.
- "name": "A String", # Name of event.
- "parameters": [ # Parameter value pairs for various applications.
- {
- "boolValue": True or False, # Boolean value of the parameter.
- "intValue": "A String", # Integral value of the parameter.
- "value": "A String", # String value of the parameter.
- "name": "A String", # The name of the parameter.
- },
- ],
- },
- ],
- },
- ],
- "kind": "admin#reports#activities", # Kind of list response this is.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(date, pageToken=None, parameters=None)
-Retrieves a report which is a collection of properties / statistics for a specific customer.
-
- get_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(date, pageToken=None, parameters=None)
-
Retrieves a report which is a collection of properties / statistics for a specific customer.
-
-Args:
- date: string, Represents the date in yyyy-mm-dd format for which the data is to be fetched. (required)
- pageToken: string, Token to specify next page.
- parameters: string, Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
-
-Returns:
- An object of the form:
-
- { # JSON template for a collection of usage reports.
- "nextPageToken": "A String", # Token for retrieving the next page
- "kind": "admin#reports#usageReports", # The kind of object.
- "usageReports": [ # Various application parameter records.
- { # JSON template for a usage report.
- "date": "A String", # The date to which the record belongs.
- "kind": "admin#reports#usageReport", # The kind of object.
- "parameters": [ # Parameter value pairs for various applications.
- {
- "stringValue": "A String", # String value of the parameter.
- "boolValue": True or False, # Boolean value of the parameter.
- "datetimeValue": "A String", # RFC 3339 formatted value of the parameter.
- "intValue": "A String", # Integral value of the parameter.
- "name": "A String", # The name of the parameter.
- },
- ],
- "entity": { # Information about the type of the item.
- "profileId": "A String", # Obfuscated user id for the record.
- "userEmail": "A String", # user's email.
- "type": "A String", # The type of item, can be a customer or user.
- "customerId": "A String", # Obfuscated customer id for the record.
- },
- },
- ],
- "warnings": [ # Warnings if any.
- {
- "message": "A String", # Human readable message for the warning.
- "code": "A String", # Machine readable code / warning type.
- "data": [ # Key-Value pairs to give detailed information on the warning.
- {
- "value": "A String", # Value associated with a key-value pair to give detailed information on the warning.
- "key": "A String", # Key associated with a key-value pair to give detailed information on the warning.
- },
- ],
- },
- ],
- }
-
-
get_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- activities()
-
-Returns the activities Resource.
-
-
- customerUsageReports()
-
-Returns the customerUsageReports Resource.
-
-
- userUsageReport()
-
-Returns the userUsageReport Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/admin_reports_v1.userUsageReport.html b/docs/dyn/admin_reports_v1.userUsageReport.html
deleted file mode 100644
index fdeaf57..0000000
--- a/docs/dyn/admin_reports_v1.userUsageReport.html
+++ /dev/null
@@ -1,152 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(userKey, date, parameters=None, pageToken=None, filters=None, maxResults=None)
-Retrieves a report which is a collection of properties / statistics for a set of users.
-
- get_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(userKey, date, parameters=None, pageToken=None, filters=None, maxResults=None)
-
Retrieves a report which is a collection of properties / statistics for a set of users.
-
-Args:
- userKey: string, Represents the profile id or the user email for which the data should be filtered. (required)
- date: string, Represents the date in yyyy-mm-dd format for which the data is to be fetched. (required)
- parameters: string, Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
- pageToken: string, Token to specify next page.
- filters: string, Represents the set of filters including parameter operator value.
- maxResults: integer, Maximum number of results to return. Maximum allowed is 1000
-
-Returns:
- An object of the form:
-
- { # JSON template for a collection of usage reports.
- "nextPageToken": "A String", # Token for retrieving the next page
- "kind": "admin#reports#usageReports", # The kind of object.
- "usageReports": [ # Various application parameter records.
- { # JSON template for a usage report.
- "date": "A String", # The date to which the record belongs.
- "kind": "admin#reports#usageReport", # The kind of object.
- "parameters": [ # Parameter value pairs for various applications.
- {
- "stringValue": "A String", # String value of the parameter.
- "boolValue": True or False, # Boolean value of the parameter.
- "datetimeValue": "A String", # RFC 3339 formatted value of the parameter.
- "intValue": "A String", # Integral value of the parameter.
- "name": "A String", # The name of the parameter.
- },
- ],
- "entity": { # Information about the type of the item.
- "profileId": "A String", # Obfuscated user id for the record.
- "userEmail": "A String", # user's email.
- "type": "A String", # The type of item, can be a customer or user.
- "customerId": "A String", # Obfuscated customer id for the record.
- },
- },
- ],
- "warnings": [ # Warnings if any.
- {
- "message": "A String", # Human readable message for the warning.
- "code": "A String", # Machine readable code / warning type.
- "data": [ # Key-Value pairs to give detailed information on the warning.
- {
- "value": "A String", # Value associated with a key-value pair to give detailed information on the warning.
- "key": "A String", # Key associated with a key-value pair to give detailed information on the warning.
- },
- ],
- },
- ],
- }
-
-
get_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(accountId, pageToken=None, maxResults=None)
-List all ad clients in the specified account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(accountId, pageToken=None, maxResults=None)
-
List all ad clients in the specified account.
-
-Args:
- accountId: string, Account for which to list ad clients. (required)
- 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.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad clients returned in this list response.
- {
- "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
- "kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.
- "id": "A String", # Unique identifier of this ad client.
- "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
- "supportsReporting": True or False, # Whether this ad client supports being reported on.
- },
- ],
- "kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)
-List all custom channels which the specified ad unit belongs to.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)
-
List all custom channels which the specified ad unit belongs to.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client which contains the ad unit. (required)
- adUnitId: string, Ad unit for which to list custom channels. (required)
- 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.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- customchannels()
-
-Returns the customchannels Resource.
-
-
- get(accountId, adClientId, adUnitId)
-Gets the specified ad unit in the specified ad client for the specified account.
-
- list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)
-List all ad units in the specified ad client for the specified account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(accountId, adClientId, adUnitId)
-
Gets the specified ad unit in the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client for which to get the ad unit. (required)
- adUnitId: string, Ad unit to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "feedAdsSettings": { # Settings specific to feed ads (AFF).
- "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
- "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
- "adPosition": "A String", # The position of the ads relative to the feed entries.
- "type": "A String", # The type of ads which should appear.
- },
- "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- }
-
-
list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)
-
List all ad units in the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client for which to list ad units. (required)
- 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.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "feedAdsSettings": { # Settings specific to feed ads (AFF).
- "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
- "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
- "adPosition": "A String", # The position of the ads relative to the feed entries.
- "type": "A String", # The type of ads which should appear.
- },
- "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- },
- ],
- "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
-List all ad units in the specified custom channel.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
-
List all ad units in the specified custom channel.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel for which to list ad units. (required)
- 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.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "feedAdsSettings": { # Settings specific to feed ads (AFF).
- "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
- "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
- "adPosition": "A String", # The position of the ads relative to the feed entries.
- "type": "A String", # The type of ads which should appear.
- },
- "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- },
- ],
- "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- adunits()
-
-Returns the adunits Resource.
-
-
- get(accountId, adClientId, customChannelId)
-Get the specified custom channel from the specified ad client for the specified account.
-
- list(accountId, adClientId, pageToken=None, maxResults=None)
-List all custom channels in the specified ad client for the specified account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(accountId, adClientId, customChannelId)
-
Get the specified custom channel from the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
-
list(accountId, adClientId, pageToken=None, maxResults=None)
-
List all custom channels in the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client for which to list custom channels. (required)
- 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.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- adclients()
-
-Returns the adclients Resource.
-
-
- adunits()
-
-Returns the adunits Resource.
-
-
- customchannels()
-
-Returns the customchannels Resource.
-
-
- reports()
-
-Returns the reports Resource.
-
-
- savedadstyles()
-
-Returns the savedadstyles Resource.
-
-
- urlchannels()
-
-Returns the urlchannels Resource.
-
-
- get(accountId, tree=None)
-Get information about the selected AdSense account.
-
- list(pageToken=None, maxResults=None)
-List all accounts available to this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(accountId, tree=None)
-
Get information about the selected AdSense account.
-
-Args:
- accountId: string, Account to get information about. (required)
- tree: boolean, Whether the tree of sub accounts should be returned.
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#account", # Kind of resource this is, in this case adsense#account.
- "premium": True or False, # Whether this account is premium.
- "id": "A String", # Unique identifier of this account.
- "subAccounts": [ # Sub accounts of the this account.
- # Object with schema name: Account
- ],
- "name": "A String", # Name of this account.
- }
-
-
list(pageToken=None, maxResults=None)
-
List all accounts available to this AdSense account.
-
-Args:
- 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.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The accounts returned in this list response.
- {
- "kind": "adsense#account", # Kind of resource this is, in this case adsense#account.
- "premium": True or False, # Whether this account is premium.
- "id": "A String", # Unique identifier of this account.
- "subAccounts": [ # Sub accounts of the this account.
- # Object with schema name: Account
- ],
- "name": "A String", # Name of this account.
- },
- ],
- "kind": "adsense#accounts", # Kind of list this is, in this case adsense#accounts.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- saved()
-
-Returns the saved Resource.
-
-
- generate(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, sort=None, maxResults=None, filter=None, dimension=None)
-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.
-
- generate_media(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, sort=None, maxResults=None, filter=None, dimension=None)
-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.
-Method Details
-
-
generate(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, sort=None, maxResults=None, filter=None, dimension=None)
-
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:
- accountId: string, Account upon which to report. (required)
- 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)
- 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.
- 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)
- maxResults: integer, The maximum number of rows of report data to return.
- filter: string, Filters to be run on the report. (repeated)
- dimension: string, Dimensions to base the report on. (repeated)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#report", # Kind this is, in this case adsense#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-
-
generate_media(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, sort=None, maxResults=None, filter=None, dimension=None)
-
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:
- accountId: string, Account upon which to report. (required)
- 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)
- 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.
- 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)
- maxResults: integer, The maximum number of rows of report data to return.
- filter: string, Filters to be run on the report. (repeated)
- dimension: string, Dimensions to base the report on. (repeated)
-
-Returns:
- The media object as a string.
-
-
-
Instance Methods
-
- generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)
-Generate an AdSense report based on the saved report ID sent in the query parameters.
-
- list(accountId, pageToken=None, maxResults=None)
-List all saved reports in the specified AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)
-
Generate an AdSense report based on the saved report ID sent in the query parameters.
-
-Args:
- accountId: string, Account to which the saved reports belong. (required)
- savedReportId: string, The saved report to retrieve. (required)
- locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
- maxResults: integer, The maximum number of rows of report data to return.
- startIndex: integer, Index of the first row of report data to return.
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#report", # Kind this is, in this case adsense#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-
-
list(accountId, pageToken=None, maxResults=None)
-
List all saved reports in the specified AdSense account.
-
-Args:
- accountId: string, Account to which the saved reports belong. (required)
- pageToken: string, A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of saved reports to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The saved reports returned in this list response.
- {
- "kind": "adsense#savedReport", # Kind of resource this is, in this case adsense#savedReport.
- "id": "A String", # Unique identifier of this saved report.
- "name": "A String", # This saved report's name.
- },
- ],
- "kind": "adsense#savedReports", # Kind of list this is, in this case adsense#savedReports.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(accountId, savedAdStyleId)
-List a specific saved ad style for the specified account.
-
- list(accountId, pageToken=None, maxResults=None)
-List all saved ad styles in the specified account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(accountId, savedAdStyleId)
-
List a specific saved ad style for the specified account.
-
-Args:
- accountId: string, Account for which to get the saved ad style. (required)
- savedAdStyleId: string, Saved ad style to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
- "adStyle": { # The AdStyle itself.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- "name": "A String", # The user selected name of this SavedAdStyle.
- "id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- }
-
-
list(accountId, pageToken=None, maxResults=None)
-
List all saved ad styles in the specified account.
-
-Args:
- accountId: string, Account for which to list saved ad styles. (required)
- pageToken: string, A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of saved ad styles to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The saved ad styles returned in this list response.
- {
- "kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
- "adStyle": { # The AdStyle itself.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- "name": "A String", # The user selected name of this SavedAdStyle.
- "id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- },
- ],
- "kind": "adsense#savedAdStyles", # Kind of list this is, in this case adsense#savedAdStyles.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(accountId, adClientId, pageToken=None, maxResults=None)
-List all URL channels in the specified ad client for the specified account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(accountId, adClientId, pageToken=None, maxResults=None)
-
List all URL channels in the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client for which to list URL channels. (required)
- 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.
- maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The URL channels returned in this list response.
- {
- "kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.
- "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
- },
- ],
- "kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(pageToken=None, maxResults=None)
-List all ad clients in this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(pageToken=None, maxResults=None)
-
List all ad clients in this AdSense account.
-
-Args:
- pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad clients returned in this list response.
- {
- "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
- "kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.
- "id": "A String", # Unique identifier of this ad client.
- "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
- "supportsReporting": True or False, # Whether this ad client supports being reported on.
- },
- ],
- "kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(adClientId, adUnitId, pageToken=None, maxResults=None)
-List all custom channels which the specified ad unit belongs to.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(adClientId, adUnitId, pageToken=None, maxResults=None)
-
List all custom channels which the specified ad unit belongs to.
-
-Args:
- adClientId: string, Ad client which contains the ad unit. (required)
- adUnitId: string, Ad unit for which to list custom channels. (required)
- 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.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- customchannels()
-
-Returns the customchannels Resource.
-
-
- get(adClientId, adUnitId)
-Gets the specified ad unit in the specified ad client.
-
- list(adClientId, pageToken=None, includeInactive=None, maxResults=None)
-List all ad units in the specified ad client for this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(adClientId, adUnitId)
-
Gets the specified ad unit in the specified ad client.
-
-Args:
- adClientId: string, Ad client for which to get the ad unit. (required)
- adUnitId: string, Ad unit to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "feedAdsSettings": { # Settings specific to feed ads (AFF).
- "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
- "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
- "adPosition": "A String", # The position of the ads relative to the feed entries.
- "type": "A String", # The type of ads which should appear.
- },
- "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- }
-
-
list(adClientId, pageToken=None, includeInactive=None, maxResults=None)
-
List all ad units in the specified ad client for this AdSense account.
-
-Args:
- adClientId: string, Ad client for which to list ad units. (required)
- 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.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "feedAdsSettings": { # Settings specific to feed ads (AFF).
- "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
- "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
- "adPosition": "A String", # The position of the ads relative to the feed entries.
- "type": "A String", # The type of ads which should appear.
- },
- "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- },
- ],
- "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
-List all ad units in the specified custom channel.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
-
List all ad units in the specified custom channel.
-
-Args:
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel for which to list ad units. (required)
- 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.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "feedAdsSettings": { # Settings specific to feed ads (AFF).
- "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
- "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
- "adPosition": "A String", # The position of the ads relative to the feed entries.
- "type": "A String", # The type of ads which should appear.
- },
- "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- },
- ],
- "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- adunits()
-
-Returns the adunits Resource.
-
-
- get(adClientId, customChannelId)
-Get the specified custom channel from the specified ad client.
-
- list(adClientId, pageToken=None, maxResults=None)
-List all custom channels in the specified ad client for this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(adClientId, customChannelId)
-
Get the specified custom channel from the specified ad client.
-
-Args:
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
-
list(adClientId, pageToken=None, maxResults=None)
-
List all custom channels in the specified ad client for this AdSense account.
-
-Args:
- adClientId: string, Ad client for which to list custom channels. (required)
- 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.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- accounts()
-
-Returns the accounts Resource.
-
-
- adclients()
-
-Returns the adclients Resource.
-
-
- adunits()
-
-Returns the adunits Resource.
-
-
- customchannels()
-
-Returns the customchannels Resource.
-
-
- reports()
-
-Returns the reports Resource.
-
-
- savedadstyles()
-
-Returns the savedadstyles Resource.
-
-
- urlchannels()
-
-Returns the urlchannels Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_2.reports.html b/docs/dyn/adsense_v1_2.reports.html
deleted file mode 100644
index d5d6938..0000000
--- a/docs/dyn/adsense_v1_2.reports.html
+++ /dev/null
@@ -1,159 +0,0 @@
-
-
-
-
-Instance Methods
-
- saved()
-
-Returns the saved Resource.
-
-
- generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, sort=None, maxResults=None, filter=None, dimension=None)
-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.
-
- generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, sort=None, maxResults=None, filter=None, dimension=None)
-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.
-Method Details
-
-
generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, sort=None, maxResults=None, filter=None, dimension=None)
-
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:
- 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)
- 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)
- 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)
- maxResults: integer, The maximum number of rows of report data to return.
- filter: string, Filters to be run on the report. (repeated)
- dimension: string, Dimensions to base the report on. (repeated)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#report", # Kind this is, in this case adsense#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-
-
generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, sort=None, maxResults=None, filter=None, dimension=None)
-
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:
- 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)
- 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)
- 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)
- maxResults: integer, The maximum number of rows of report data to return.
- filter: string, Filters to be run on the report. (repeated)
- dimension: string, Dimensions to base the report on. (repeated)
-
-Returns:
- The media object as a string.
-
-
-
Instance Methods
-
- generate(savedReportId, locale=None, maxResults=None, startIndex=None)
-Generate an AdSense report based on the saved report ID sent in the query parameters.
-
- list(pageToken=None, maxResults=None)
-List all saved reports in this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
generate(savedReportId, locale=None, maxResults=None, startIndex=None)
-
Generate an AdSense report based on the saved report ID sent in the query parameters.
-
-Args:
- savedReportId: string, The saved report to retrieve. (required)
- locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
- maxResults: integer, The maximum number of rows of report data to return.
- startIndex: integer, Index of the first row of report data to return.
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#report", # Kind this is, in this case adsense#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-
-
list(pageToken=None, maxResults=None)
-
List all saved reports in this AdSense account.
-
-Args:
- pageToken: string, A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of saved reports to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The saved reports returned in this list response.
- {
- "kind": "adsense#savedReport", # Kind of resource this is, in this case adsense#savedReport.
- "id": "A String", # Unique identifier of this saved report.
- "name": "A String", # This saved report's name.
- },
- ],
- "kind": "adsense#savedReports", # Kind of list this is, in this case adsense#savedReports.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(savedAdStyleId)
-Get a specific saved ad style from the user's account.
-
- list(pageToken=None, maxResults=None)
-List all saved ad styles in the user's account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(savedAdStyleId)
-
Get a specific saved ad style from the user's account.
-
-Args:
- savedAdStyleId: string, Saved ad style to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
- "adStyle": { # The AdStyle itself.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- "name": "A String", # The user selected name of this SavedAdStyle.
- "id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- }
-
-
list(pageToken=None, maxResults=None)
-
List all saved ad styles in the user's account.
-
-Args:
- pageToken: string, A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of saved ad styles to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The saved ad styles returned in this list response.
- {
- "kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
- "adStyle": { # The AdStyle itself.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- "name": "A String", # The user selected name of this SavedAdStyle.
- "id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- },
- ],
- "kind": "adsense#savedAdStyles", # Kind of list this is, in this case adsense#savedAdStyles.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(adClientId, pageToken=None, maxResults=None)
-List all URL channels in the specified ad client for this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(adClientId, pageToken=None, maxResults=None)
-
List all URL channels in the specified ad client for this AdSense account.
-
-Args:
- adClientId: string, Ad client for which to list URL channels. (required)
- 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.
- maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The URL channels returned in this list response.
- {
- "kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.
- "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
- },
- ],
- "kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(accountId, pageToken=None, maxResults=None)
-List all ad clients in the specified account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(accountId, pageToken=None, maxResults=None)
-
List all ad clients in the specified account.
-
-Args:
- accountId: string, Account for which to list ad clients. (required)
- 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.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad clients returned in this list response.
- {
- "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
- "kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.
- "id": "A String", # Unique identifier of this ad client.
- "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
- "supportsReporting": True or False, # Whether this ad client supports being reported on.
- },
- ],
- "kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)
-List all custom channels which the specified ad unit belongs to.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)
-
List all custom channels which the specified ad unit belongs to.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client which contains the ad unit. (required)
- adUnitId: string, Ad unit for which to list custom channels. (required)
- 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.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- customchannels()
-
-Returns the customchannels Resource.
-
-
- get(accountId, adClientId, adUnitId)
-Gets the specified ad unit in the specified ad client for the specified account.
-
- getAdCode(accountId, adClientId, adUnitId)
-Get ad code for the specified ad unit.
-
- list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)
-List all ad units in the specified ad client for the specified account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(accountId, adClientId, adUnitId)
-
Gets the specified ad unit in the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client for which to get the ad unit. (required)
- adUnitId: string, Ad unit to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "feedAdsSettings": { # Settings specific to feed ads (AFF).
- "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
- "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
- "adPosition": "A String", # The position of the ads relative to the feed entries.
- "type": "A String", # The type of ads which should appear.
- },
- "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- }
-
-
getAdCode(accountId, adClientId, adUnitId)
-
Get ad code for the specified ad unit.
-
-Args:
- accountId: string, Account which contains the ad client. (required)
- adClientId: string, Ad client with contains the ad unit. (required)
- adUnitId: string, Ad unit to get the code for. (required)
-
-Returns:
- An object of the form:
-
- {
- "adCode": "A String", # The ad code snippet.
- "kind": "adsense#adCode", # Kind this is, in this case adsense#adCode.
- }
-
-
list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)
-
List all ad units in the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client for which to list ad units. (required)
- 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.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "feedAdsSettings": { # Settings specific to feed ads (AFF).
- "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
- "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
- "adPosition": "A String", # The position of the ads relative to the feed entries.
- "type": "A String", # The type of ads which should appear.
- },
- "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- },
- ],
- "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(accountId, locale=None)
-List the alerts for the specified AdSense account.
-Method Details
-
-
list(accountId, locale=None)
-
List the alerts for the specified AdSense account.
-
-Args:
- accountId: string, Account for which to retrieve the alerts. (required)
- locale: string, The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # The alerts returned in this list response.
- {
- "type": "A String", # Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.
- "kind": "adsense#alert", # Kind of resource this is, in this case adsense#alert.
- "message": "A String", # The localized alert message.
- "id": "A String", # Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "severity": "A String", # Severity of this alert. Possible values: INFO, WARNING, SEVERE.
- },
- ],
- "kind": "adsense#alerts", # Kind of list this is, in this case adsense#alerts.
- }
-
Instance Methods
-
- list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
-List all ad units in the specified custom channel.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
-
List all ad units in the specified custom channel.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel for which to list ad units. (required)
- 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.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "feedAdsSettings": { # Settings specific to feed ads (AFF).
- "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
- "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
- "adPosition": "A String", # The position of the ads relative to the feed entries.
- "type": "A String", # The type of ads which should appear.
- },
- "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- },
- ],
- "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- adunits()
-
-Returns the adunits Resource.
-
-
- get(accountId, adClientId, customChannelId)
-Get the specified custom channel from the specified ad client for the specified account.
-
- list(accountId, adClientId, pageToken=None, maxResults=None)
-List all custom channels in the specified ad client for the specified account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(accountId, adClientId, customChannelId)
-
Get the specified custom channel from the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
-
list(accountId, adClientId, pageToken=None, maxResults=None)
-
List all custom channels in the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client for which to list custom channels. (required)
- 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.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- adclients()
-
-Returns the adclients Resource.
-
-
- adunits()
-
-Returns the adunits Resource.
-
-
- alerts()
-
-Returns the alerts Resource.
-
-
- customchannels()
-
-Returns the customchannels Resource.
-
-
- reports()
-
-Returns the reports Resource.
-
-
- savedadstyles()
-
-Returns the savedadstyles Resource.
-
-
- urlchannels()
-
-Returns the urlchannels Resource.
-
-
- get(accountId, tree=None)
-Get information about the selected AdSense account.
-
- list(pageToken=None, maxResults=None)
-List all accounts available to this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(accountId, tree=None)
-
Get information about the selected AdSense account.
-
-Args:
- accountId: string, Account to get information about. (required)
- tree: boolean, Whether the tree of sub accounts should be returned.
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#account", # Kind of resource this is, in this case adsense#account.
- "premium": True or False, # Whether this account is premium.
- "id": "A String", # Unique identifier of this account.
- "subAccounts": [ # Sub accounts of the this account.
- # Object with schema name: Account
- ],
- "name": "A String", # Name of this account.
- }
-
-
list(pageToken=None, maxResults=None)
-
List all accounts available to this AdSense account.
-
-Args:
- 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.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The accounts returned in this list response.
- {
- "kind": "adsense#account", # Kind of resource this is, in this case adsense#account.
- "premium": True or False, # Whether this account is premium.
- "id": "A String", # Unique identifier of this account.
- "subAccounts": [ # Sub accounts of the this account.
- # Object with schema name: Account
- ],
- "name": "A String", # Name of this account.
- },
- ],
- "kind": "adsense#accounts", # Kind of list this is, in this case adsense#accounts.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- saved()
-
-Returns the saved Resource.
-
-
- generate(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)
-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.
-
- generate_media(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)
-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.
-Method Details
-
-
generate(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)
-
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:
- accountId: string, Account upon which to report. (required)
- 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)
- 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.
- useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
- 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)
- maxResults: integer, The maximum number of rows of report data to return.
- filter: string, Filters to be run on the report. (repeated)
- dimension: string, Dimensions to base the report on. (repeated)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#report", # Kind this is, in this case adsense#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-
-
generate_media(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)
-
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:
- accountId: string, Account upon which to report. (required)
- 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)
- 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.
- useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
- 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)
- maxResults: integer, The maximum number of rows of report data to return.
- filter: string, Filters to be run on the report. (repeated)
- dimension: string, Dimensions to base the report on. (repeated)
-
-Returns:
- The media object as a string.
-
-
-
Instance Methods
-
- generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)
-Generate an AdSense report based on the saved report ID sent in the query parameters.
-
- list(accountId, pageToken=None, maxResults=None)
-List all saved reports in the specified AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)
-
Generate an AdSense report based on the saved report ID sent in the query parameters.
-
-Args:
- accountId: string, Account to which the saved reports belong. (required)
- savedReportId: string, The saved report to retrieve. (required)
- locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
- maxResults: integer, The maximum number of rows of report data to return.
- startIndex: integer, Index of the first row of report data to return.
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#report", # Kind this is, in this case adsense#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-
-
list(accountId, pageToken=None, maxResults=None)
-
List all saved reports in the specified AdSense account.
-
-Args:
- accountId: string, Account to which the saved reports belong. (required)
- pageToken: string, A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of saved reports to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The saved reports returned in this list response.
- {
- "kind": "adsense#savedReport", # Kind of resource this is, in this case adsense#savedReport.
- "id": "A String", # Unique identifier of this saved report.
- "name": "A String", # This saved report's name.
- },
- ],
- "kind": "adsense#savedReports", # Kind of list this is, in this case adsense#savedReports.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(accountId, savedAdStyleId)
-List a specific saved ad style for the specified account.
-
- list(accountId, pageToken=None, maxResults=None)
-List all saved ad styles in the specified account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(accountId, savedAdStyleId)
-
List a specific saved ad style for the specified account.
-
-Args:
- accountId: string, Account for which to get the saved ad style. (required)
- savedAdStyleId: string, Saved ad style to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
- "adStyle": { # The AdStyle itself.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- "name": "A String", # The user selected name of this SavedAdStyle.
- "id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- }
-
-
list(accountId, pageToken=None, maxResults=None)
-
List all saved ad styles in the specified account.
-
-Args:
- accountId: string, Account for which to list saved ad styles. (required)
- pageToken: string, A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of saved ad styles to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The saved ad styles returned in this list response.
- {
- "kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
- "adStyle": { # The AdStyle itself.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- "name": "A String", # The user selected name of this SavedAdStyle.
- "id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- },
- ],
- "kind": "adsense#savedAdStyles", # Kind of list this is, in this case adsense#savedAdStyles.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(accountId, adClientId, pageToken=None, maxResults=None)
-List all URL channels in the specified ad client for the specified account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(accountId, adClientId, pageToken=None, maxResults=None)
-
List all URL channels in the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client for which to list URL channels. (required)
- 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.
- maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The URL channels returned in this list response.
- {
- "kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.
- "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
- },
- ],
- "kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(pageToken=None, maxResults=None)
-List all ad clients in this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(pageToken=None, maxResults=None)
-
List all ad clients in this AdSense account.
-
-Args:
- pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad clients returned in this list response.
- {
- "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
- "kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.
- "id": "A String", # Unique identifier of this ad client.
- "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
- "supportsReporting": True or False, # Whether this ad client supports being reported on.
- },
- ],
- "kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(adClientId, adUnitId, pageToken=None, maxResults=None)
-List all custom channels which the specified ad unit belongs to.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(adClientId, adUnitId, pageToken=None, maxResults=None)
-
List all custom channels which the specified ad unit belongs to.
-
-Args:
- adClientId: string, Ad client which contains the ad unit. (required)
- adUnitId: string, Ad unit for which to list custom channels. (required)
- 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.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- customchannels()
-
-Returns the customchannels Resource.
-
-
- get(adClientId, adUnitId)
-Gets the specified ad unit in the specified ad client.
-
- getAdCode(adClientId, adUnitId)
-Get ad code for the specified ad unit.
-
- list(adClientId, pageToken=None, includeInactive=None, maxResults=None)
-List all ad units in the specified ad client for this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(adClientId, adUnitId)
-
Gets the specified ad unit in the specified ad client.
-
-Args:
- adClientId: string, Ad client for which to get the ad unit. (required)
- adUnitId: string, Ad unit to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "feedAdsSettings": { # Settings specific to feed ads (AFF).
- "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
- "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
- "adPosition": "A String", # The position of the ads relative to the feed entries.
- "type": "A String", # The type of ads which should appear.
- },
- "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- }
-
-
getAdCode(adClientId, adUnitId)
-
Get ad code for the specified ad unit.
-
-Args:
- adClientId: string, Ad client with contains the ad unit. (required)
- adUnitId: string, Ad unit to get the code for. (required)
-
-Returns:
- An object of the form:
-
- {
- "adCode": "A String", # The ad code snippet.
- "kind": "adsense#adCode", # Kind this is, in this case adsense#adCode.
- }
-
-
list(adClientId, pageToken=None, includeInactive=None, maxResults=None)
-
List all ad units in the specified ad client for this AdSense account.
-
-Args:
- adClientId: string, Ad client for which to list ad units. (required)
- 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.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "feedAdsSettings": { # Settings specific to feed ads (AFF).
- "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
- "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
- "adPosition": "A String", # The position of the ads relative to the feed entries.
- "type": "A String", # The type of ads which should appear.
- },
- "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- },
- ],
- "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(locale=None)
-List the alerts for this AdSense account.
-Method Details
-
-
list(locale=None)
-
List the alerts for this AdSense account.
-
-Args:
- locale: string, The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # The alerts returned in this list response.
- {
- "type": "A String", # Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.
- "kind": "adsense#alert", # Kind of resource this is, in this case adsense#alert.
- "message": "A String", # The localized alert message.
- "id": "A String", # Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "severity": "A String", # Severity of this alert. Possible values: INFO, WARNING, SEVERE.
- },
- ],
- "kind": "adsense#alerts", # Kind of list this is, in this case adsense#alerts.
- }
-
Instance Methods
-
- list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
-List all ad units in the specified custom channel.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
-
List all ad units in the specified custom channel.
-
-Args:
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel for which to list ad units. (required)
- 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.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "feedAdsSettings": { # Settings specific to feed ads (AFF).
- "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
- "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
- "adPosition": "A String", # The position of the ads relative to the feed entries.
- "type": "A String", # The type of ads which should appear.
- },
- "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- },
- ],
- "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- adunits()
-
-Returns the adunits Resource.
-
-
- get(adClientId, customChannelId)
-Get the specified custom channel from the specified ad client.
-
- list(adClientId, pageToken=None, maxResults=None)
-List all custom channels in the specified ad client for this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(adClientId, customChannelId)
-
Get the specified custom channel from the specified ad client.
-
-Args:
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
-
list(adClientId, pageToken=None, maxResults=None)
-
List all custom channels in the specified ad client for this AdSense account.
-
-Args:
- adClientId: string, Ad client for which to list custom channels. (required)
- 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.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- accounts()
-
-Returns the accounts Resource.
-
-
- adclients()
-
-Returns the adclients Resource.
-
-
- adunits()
-
-Returns the adunits Resource.
-
-
- alerts()
-
-Returns the alerts Resource.
-
-
- customchannels()
-
-Returns the customchannels Resource.
-
-
- metadata()
-
-Returns the metadata Resource.
-
-
- reports()
-
-Returns the reports Resource.
-
-
- savedadstyles()
-
-Returns the savedadstyles Resource.
-
-
- urlchannels()
-
-Returns the urlchannels Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.metadata.dimensions.html b/docs/dyn/adsense_v1_3.metadata.dimensions.html
deleted file mode 100644
index e59c54f..0000000
--- a/docs/dyn/adsense_v1_3.metadata.dimensions.html
+++ /dev/null
@@ -1,116 +0,0 @@
-
-
-
-
-Instance Methods
-
- list()
-List the metadata for the dimensions available to this AdSense account.
-Method Details
-
-
list()
-
List the metadata for the dimensions available to this AdSense account.
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "requiredMetrics": [ # The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
- "A String",
- ],
- "kind": "adsense#reportingMetadataEntry", # Kind of resource this is, in this case adsense#reportingMetadataEntry.
- "compatibleMetrics": [ # The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.
- "A String",
- ],
- "requiredDimensions": [ # The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
- "A String",
- ],
- "compatibleDimensions": [ # For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.
- "A String",
- ],
- "id": "A String", # Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.
- "supportedProducts": [ # The codes of the projects supported by the dimension or metric this reporting metadata entry describes.
- "A String",
- ],
- },
- ],
- "kind": "adsense#metadata", # Kind of list this is, in this case adsense#metadata.
- }
-
Instance Methods
-
- dimensions()
-
-Returns the dimensions Resource.
-
-
- metrics()
-
-Returns the metrics Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/adsense_v1_3.metadata.metrics.html b/docs/dyn/adsense_v1_3.metadata.metrics.html
deleted file mode 100644
index 754349f..0000000
--- a/docs/dyn/adsense_v1_3.metadata.metrics.html
+++ /dev/null
@@ -1,116 +0,0 @@
-
-
-
-
-Instance Methods
-
- list()
-List the metadata for the metrics available to this AdSense account.
-Method Details
-
-
list()
-
List the metadata for the metrics available to this AdSense account.
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "requiredMetrics": [ # The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
- "A String",
- ],
- "kind": "adsense#reportingMetadataEntry", # Kind of resource this is, in this case adsense#reportingMetadataEntry.
- "compatibleMetrics": [ # The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.
- "A String",
- ],
- "requiredDimensions": [ # The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
- "A String",
- ],
- "compatibleDimensions": [ # For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.
- "A String",
- ],
- "id": "A String", # Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.
- "supportedProducts": [ # The codes of the projects supported by the dimension or metric this reporting metadata entry describes.
- "A String",
- ],
- },
- ],
- "kind": "adsense#metadata", # Kind of list this is, in this case adsense#metadata.
- }
-
Instance Methods
-
- saved()
-
-Returns the saved Resource.
-
-
- generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)
-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.
-
- generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)
-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.
-Method Details
-
-
generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)
-
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:
- 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)
- 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)
- useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
- 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)
- maxResults: integer, The maximum number of rows of report data to return.
- filter: string, Filters to be run on the report. (repeated)
- dimension: string, Dimensions to base the report on. (repeated)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#report", # Kind this is, in this case adsense#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-
-
generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)
-
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:
- 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)
- 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)
- useTimezoneReporting: boolean, Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.
- 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)
- maxResults: integer, The maximum number of rows of report data to return.
- filter: string, Filters to be run on the report. (repeated)
- dimension: string, Dimensions to base the report on. (repeated)
-
-Returns:
- The media object as a string.
-
-
-
Instance Methods
-
- generate(savedReportId, locale=None, maxResults=None, startIndex=None)
-Generate an AdSense report based on the saved report ID sent in the query parameters.
-
- list(pageToken=None, maxResults=None)
-List all saved reports in this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
generate(savedReportId, locale=None, maxResults=None, startIndex=None)
-
Generate an AdSense report based on the saved report ID sent in the query parameters.
-
-Args:
- savedReportId: string, The saved report to retrieve. (required)
- locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
- maxResults: integer, The maximum number of rows of report data to return.
- startIndex: integer, Index of the first row of report data to return.
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#report", # Kind this is, in this case adsense#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-
-
list(pageToken=None, maxResults=None)
-
List all saved reports in this AdSense account.
-
-Args:
- pageToken: string, A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of saved reports to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The saved reports returned in this list response.
- {
- "kind": "adsense#savedReport", # Kind of resource this is, in this case adsense#savedReport.
- "id": "A String", # Unique identifier of this saved report.
- "name": "A String", # This saved report's name.
- },
- ],
- "kind": "adsense#savedReports", # Kind of list this is, in this case adsense#savedReports.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(savedAdStyleId)
-Get a specific saved ad style from the user's account.
-
- list(pageToken=None, maxResults=None)
-List all saved ad styles in the user's account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(savedAdStyleId)
-
Get a specific saved ad style from the user's account.
-
-Args:
- savedAdStyleId: string, Saved ad style to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
- "adStyle": { # The AdStyle itself.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- "name": "A String", # The user selected name of this SavedAdStyle.
- "id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- }
-
-
list(pageToken=None, maxResults=None)
-
List all saved ad styles in the user's account.
-
-Args:
- pageToken: string, A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of saved ad styles to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The saved ad styles returned in this list response.
- {
- "kind": "adsense#savedAdStyle", # Kind of resource this is, in this case adsense#savedAdStyle.
- "adStyle": { # The AdStyle itself.
- "corners": "A String", # The style of the corners in the ad.
- "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font.
- "size": "A String", # The size of the font.
- },
- "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
- },
- "name": "A String", # The user selected name of this SavedAdStyle.
- "id": "A String", # Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- },
- ],
- "kind": "adsense#savedAdStyles", # Kind of list this is, in this case adsense#savedAdStyles.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(adClientId, pageToken=None, maxResults=None)
-List all URL channels in the specified ad client for this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(adClientId, pageToken=None, maxResults=None)
-
List all URL channels in the specified ad client for this AdSense account.
-
-Args:
- adClientId: string, Ad client for which to list URL channels. (required)
- 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.
- maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The URL channels returned in this list response.
- {
- "kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.
- "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
- },
- ],
- "kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(accountId, adClientId)
-Get information about one of the ad clients in the specified publisher's AdSense account.
-
- list(accountId, pageToken=None, maxResults=None)
-List all hosted ad clients in the specified hosted account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(accountId, adClientId)
-
Get information about one of the ad clients in the specified publisher's AdSense account.
-
-Args:
- accountId: string, Account which contains the ad client. (required)
- adClientId: string, Ad client to get. (required)
-
-Returns:
- An object of the form:
-
- {
- "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
- "kind": "adsensehost#adClient", # Kind of resource this is, in this case adsensehost#adClient.
- "id": "A String", # Unique identifier of this ad client.
- "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
- "supportsReporting": True or False, # Whether this ad client supports being reported on.
- }
-
-
list(accountId, pageToken=None, maxResults=None)
-
List all hosted ad clients in the specified hosted account.
-
-Args:
- accountId: string, Account for which to list ad clients. (required)
- 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.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad clients returned in this list response.
- {
- "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
- "kind": "adsensehost#adClient", # Kind of resource this is, in this case adsensehost#adClient.
- "id": "A String", # Unique identifier of this ad client.
- "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
- "supportsReporting": True or False, # Whether this ad client supports being reported on.
- },
- ],
- "kind": "adsensehost#adClients", # Kind of list this is, in this case adsensehost#adClients.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(accountId, adClientId, adUnitId)
-Delete the specified ad unit from the specified publisher AdSense account.
-
- get(accountId, adClientId, adUnitId)
-Get the specified host ad unit in this AdSense account.
-
- getAdCode(accountId, adClientId, adUnitId, hostCustomChannelId=None)
-Get ad code for the specified ad unit, attaching the specified host custom channels.
-
- insert(accountId, adClientId, body)
-Insert the supplied ad unit into the specified publisher AdSense account.
-
- list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)
-List all ad units in the specified publisher's AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(accountId, adClientId, adUnitId, body)
-Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.
-
- update(accountId, adClientId, body)
-Update the supplied ad unit in the specified publisher AdSense account.
-Method Details
-
-
delete(accountId, adClientId, adUnitId)
-
Delete the specified ad unit from the specified publisher AdSense account.
-
-Args:
- accountId: string, Account which contains the ad unit. (required)
- adClientId: string, Ad client for which to get ad unit. (required)
- adUnitId: string, Ad unit to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
- "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
- "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
- },
- "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
- },
- }
-
-
get(accountId, adClientId, adUnitId)
-
Get the specified host ad unit in this AdSense account.
-
-Args:
- accountId: string, Account which contains the ad unit. (required)
- adClientId: string, Ad client for which to get ad unit. (required)
- adUnitId: string, Ad unit to get. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
- "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
- "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
- },
- "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
- },
- }
-
-
getAdCode(accountId, adClientId, adUnitId, hostCustomChannelId=None)
-
Get ad code for the specified ad unit, attaching the specified host custom channels.
-
-Args:
- accountId: string, Account which contains the ad client. (required)
- adClientId: string, Ad client with contains the ad unit. (required)
- adUnitId: string, Ad unit to get the code for. (required)
- hostCustomChannelId: string, Host custom channel to attach to the ad code. (repeated)
-
-Returns:
- An object of the form:
-
- {
- "adCode": "A String", # The ad code snippet.
- "kind": "adsensehost#adCode", # Kind this is, in this case adsensehost#adCode.
- }
-
-
insert(accountId, adClientId, body)
-
Insert the supplied ad unit into the specified publisher AdSense account.
-
-Args:
- accountId: string, Account which will contain the ad unit. (required)
- adClientId: string, Ad client into which to insert the ad unit. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
- "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
- "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
- },
- "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
- "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
- "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
- },
- "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
- },
- }
-
-
list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)
-
List all ad units in the specified publisher's AdSense account.
-
-Args:
- accountId: string, Account which contains the ad client. (required)
- adClientId: string, Ad client for which to list ad units. (required)
- 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.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
- "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
- "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
- },
- "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
- },
- },
- ],
- "kind": "adsensehost#adUnits", # Kind of list this is, in this case adsensehost#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(accountId, adClientId, adUnitId, body)
-
Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.
-
-Args:
- accountId: string, Account which contains the ad client. (required)
- adClientId: string, Ad client which contains the ad unit. (required)
- adUnitId: string, Ad unit to get. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
- "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
- "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
- },
- "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
- "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
- "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
- },
- "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
- },
- }
-
-
update(accountId, adClientId, body)
-
Update the supplied ad unit in the specified publisher AdSense account.
-
-Args:
- accountId: string, Account which contains the ad client. (required)
- adClientId: string, Ad client which contains the ad unit. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
- "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
- "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
- },
- "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "name": "A String", # Name of this ad unit.
- "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
- "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
- "backupOption": { # The backup option to be used in instances where no ad is available.
- "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # URL to use when type is set to URL.
- "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
- },
- "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
- },
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
- "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
- "type": "A String", # Type of this ad unit.
- "markupLanguage": "A String", # The markup language to use for this ad unit.
- "size": "A String", # Size of this ad unit.
- },
- "customStyle": { # Custom style information specific to this ad unit.
- "corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
- "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
- "url": "A String", # The color of the ad url.
- "text": "A String", # The color of the ad text.
- "border": "A String", # The color of the ad border.
- "background": "A String", # The color of the ad background.
- "title": "A String", # The color of the ad title.
- },
- "font": { # The font which is included in the style.
- "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
- "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
- },
- "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
- },
- }
-
Instance Methods
-
- adclients()
-
-Returns the adclients Resource.
-
-
- adunits()
-
-Returns the adunits Resource.
-
-
- reports()
-
-Returns the reports Resource.
-
-
- get(accountId)
-Get information about the selected associated AdSense account.
-
- list(filterAdClientId)
-List hosted accounts associated with this AdSense account by ad client id.
-Method Details
-
-
get(accountId)
-
Get information about the selected associated AdSense account.
-
-Args:
- accountId: string, Account to get information about. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Approval status of this account. One of: PENDING, APPROVED, DISABLED.
- "kind": "adsensehost#account", # Kind of resource this is, in this case adsensehost#account.
- "id": "A String", # Unique identifier of this account.
- "name": "A String", # Name of this account.
- }
-
-
list(filterAdClientId)
-
List hosted accounts associated with this AdSense account by ad client id.
-
-Args:
- filterAdClientId: string, Ad clients to list accounts for. (required) (repeated)
-
-Returns:
- An object of the form:
-
- {
- "items": [ # The accounts returned in this list response.
- {
- "status": "A String", # Approval status of this account. One of: PENDING, APPROVED, DISABLED.
- "kind": "adsensehost#account", # Kind of resource this is, in this case adsensehost#account.
- "id": "A String", # Unique identifier of this account.
- "name": "A String", # Name of this account.
- },
- ],
- "kind": "adsensehost#accounts", # Kind of list this is, in this case adsensehost#accounts.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
Instance Methods
-
- generate(accountId, startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)
-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.
-Method Details
-
-
generate(accountId, startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)
-
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:
- accountId: string, Hosted account upon which to report. (required)
- 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)
- 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)
- 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)
- maxResults: integer, The maximum number of rows of report data to return.
- dimension: string, Dimensions to base the report on. (repeated)
- startIndex: integer, Index of the first row of report data to return.
- filter: string, Filters to be run on the report. (repeated)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsensehost#report", # Kind this is, in this case adsensehost#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-
Instance Methods
-
- get(adClientId)
-Get information about one of the ad clients in the Host AdSense account.
-
- list(pageToken=None, maxResults=None)
-List all host ad clients in this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(adClientId)
-
Get information about one of the ad clients in the Host AdSense account.
-
-Args:
- adClientId: string, Ad client to get. (required)
-
-Returns:
- An object of the form:
-
- {
- "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
- "kind": "adsensehost#adClient", # Kind of resource this is, in this case adsensehost#adClient.
- "id": "A String", # Unique identifier of this ad client.
- "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
- "supportsReporting": True or False, # Whether this ad client supports being reported on.
- }
-
-
list(pageToken=None, maxResults=None)
-
List all host ad clients in this AdSense account.
-
-Args:
- pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad clients returned in this list response.
- {
- "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
- "kind": "adsensehost#adClient", # Kind of resource this is, in this case adsensehost#adClient.
- "id": "A String", # Unique identifier of this ad client.
- "arcOptIn": True or False, # Whether this ad client is opted in to ARC.
- "supportsReporting": True or False, # Whether this ad client supports being reported on.
- },
- ],
- "kind": "adsensehost#adClients", # Kind of list this is, in this case adsensehost#adClients.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- start(productCode, websiteUrl, websiteLocale=None, userLocale=None)
-Create an association session for initiating an association with an AdSense user.
-
- verify(token)
-Verify an association session after the association callback returns from AdSense signup.
-Method Details
-
-
start(productCode, websiteUrl, websiteLocale=None, userLocale=None)
-
Create an association session for initiating an association with an AdSense user.
-
-Args:
- productCode: string, Products to associate with the user. (required) (repeated)
- Allowed values
- AFC - AdSense For Content
- AFG - AdSense For Games
- AFMC - AdSense For Mobile Content
- AFS - AdSense For Search
- AFV - AdSense For Video
- websiteUrl: string, The URL of the user's hosted website. (required)
- websiteLocale: string, The locale of the user's hosted website.
- userLocale: string, The preferred locale of the user.
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.
- "productCodes": [ # The products to associate with the user. Options: AFC, AFF, AFS, AFMC
- "A String",
- ],
- "kind": "adsensehost#associationSession", # Kind of resource this is, in this case adsensehost#associationSession.
- "userLocale": "A String", # The preferred locale of the user themselves when going through the AdSense association flow.
- "websiteLocale": "A String", # The locale of the user's hosted website.
- "redirectUrl": "A String", # Redirect URL of this association session. Used to redirect users into the AdSense association flow.
- "websiteUrl": "A String", # The URL of the user's hosted website.
- "id": "A String", # Unique identifier of this association session.
- "accountId": "A String", # Hosted account id of the associated publisher after association. Present if status is ACCEPTED.
- }
-
-
verify(token)
-
Verify an association session after the association callback returns from AdSense signup.
-
-Args:
- token: string, The token returned to the association callback URL. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.
- "productCodes": [ # The products to associate with the user. Options: AFC, AFF, AFS, AFMC
- "A String",
- ],
- "kind": "adsensehost#associationSession", # Kind of resource this is, in this case adsensehost#associationSession.
- "userLocale": "A String", # The preferred locale of the user themselves when going through the AdSense association flow.
- "websiteLocale": "A String", # The locale of the user's hosted website.
- "redirectUrl": "A String", # Redirect URL of this association session. Used to redirect users into the AdSense association flow.
- "websiteUrl": "A String", # The URL of the user's hosted website.
- "id": "A String", # Unique identifier of this association session.
- "accountId": "A String", # Hosted account id of the associated publisher after association. Present if status is ACCEPTED.
- }
-
Instance Methods
-
- delete(adClientId, customChannelId)
-Delete a specific custom channel from the host AdSense account.
-
- get(adClientId, customChannelId)
-Get a specific custom channel from the host AdSense account.
-
- insert(adClientId, body)
-Add a new custom channel to the host AdSense account.
-
- list(adClientId, pageToken=None, maxResults=None)
-List all host custom channels in this AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(adClientId, customChannelId, body)
-Update a custom channel in the host AdSense account. This method supports patch semantics.
-
- update(adClientId, body)
-Update a custom channel in the host AdSense account.
-Method Details
-
-
delete(adClientId, customChannelId)
-
Delete a specific custom channel from the host AdSense account.
-
-Args:
- adClientId: string, Ad client from which to delete the custom channel. (required)
- customChannelId: string, Custom channel to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
-
get(adClientId, customChannelId)
-
Get a specific custom channel from the host AdSense account.
-
-Args:
- adClientId: string, Ad client from which to get the custom channel. (required)
- customChannelId: string, Custom channel to get. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
-
insert(adClientId, body)
-
Add a new custom channel to the host AdSense account.
-
-Args:
- adClientId: string, Ad client to which the new custom channel will be added. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
-
list(adClientId, pageToken=None, maxResults=None)
-
List all host custom channels in this AdSense account.
-
-Args:
- adClientId: string, Ad client for which to list custom channels. (required)
- 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.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsensehost#customChannels", # Kind of list this is, in this case adsensehost#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(adClientId, customChannelId, body)
-
Update a custom channel in the host AdSense account. This method supports patch semantics.
-
-Args:
- adClientId: string, Ad client in which the custom channel will be updated. (required)
- customChannelId: string, Custom channel to get. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
-
update(adClientId, body)
-
Update a custom channel in the host AdSense account.
-
-Args:
- adClientId: string, Ad client in which the custom channel will be updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsensehost#customChannel", # Kind of resource this is, in this case adsensehost#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-
Instance Methods
-
- accounts()
-
-Returns the accounts Resource.
-
-
- adclients()
-
-Returns the adclients Resource.
-
-
- associationsessions()
-
-Returns the associationsessions Resource.
-
-
- customchannels()
-
-Returns the customchannels Resource.
-
-
- reports()
-
-Returns the reports Resource.
-
-
- urlchannels()
-
-Returns the urlchannels Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/adsensehost_v4_1.reports.html b/docs/dyn/adsensehost_v4_1.reports.html
deleted file mode 100644
index 6e9c039..0000000
--- a/docs/dyn/adsensehost_v4_1.reports.html
+++ /dev/null
@@ -1,126 +0,0 @@
-
-
-
-
-Instance Methods
-
- generate(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)
-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.
-Method Details
-
-
generate(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)
-
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:
- 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)
- 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)
- 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)
- maxResults: integer, The maximum number of rows of report data to return.
- dimension: string, Dimensions to base the report on. (repeated)
- startIndex: integer, Index of the first row of report data to return.
- filter: string, Filters to be run on the report. (repeated)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsensehost#report", # Kind this is, in this case adsensehost#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-
Instance Methods
-
- delete(adClientId, urlChannelId)
-Delete a URL channel from the host AdSense account.
-
- insert(adClientId, body)
-Add a new URL channel to the host AdSense account.
-
- list(adClientId, pageToken=None, maxResults=None)
-List all host URL channels in the host AdSense account.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(adClientId, urlChannelId)
-
Delete a URL channel from the host AdSense account.
-
-Args:
- adClientId: string, Ad client from which to delete the URL channel. (required)
- urlChannelId: string, URL channel to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsensehost#urlChannel", # Kind of resource this is, in this case adsensehost#urlChannel.
- "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
- }
-
-
insert(adClientId, body)
-
Add a new URL channel to the host AdSense account.
-
-Args:
- adClientId: string, Ad client to which the new URL channel will be added. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "adsensehost#urlChannel", # Kind of resource this is, in this case adsensehost#urlChannel.
- "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsensehost#urlChannel", # Kind of resource this is, in this case adsensehost#urlChannel.
- "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
- }
-
-
list(adClientId, pageToken=None, maxResults=None)
-
List all host URL channels in the host AdSense account.
-
-Args:
- adClientId: string, Ad client for which to list URL channels. (required)
- 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.
- maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The URL channels returned in this list response.
- {
- "kind": "adsensehost#urlChannel", # Kind of resource this is, in this case adsensehost#urlChannel.
- "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
- },
- ],
- "kind": "adsensehost#urlChannels", # Kind of list this is, in this case adsensehost#urlChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, segment=None, start_index=None)
-Returns Analytics data for a view (profile).
-Method Details
-
-
get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, segment=None, start_index=None)
-
Returns Analytics data for a view (profile).
-
-Args:
- ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. (required)
- start_date: string, Start date for fetching Analytics data. All requests should specify a start date formatted as YYYY-MM-DD. (required)
- end_date: string, End date for fetching Analytics data. All requests should specify an end date formatted as YYYY-MM-DD. (required)
- metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified. (required)
- sort: string, A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.
- dimensions: string, A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
- filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data.
- max_results: integer, The maximum number of entries to include in this feed.
- segment: string, An Analytics advanced segment to be applied to data.
- start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
-
-Returns:
- An object of the form:
-
- { # Analytics data for a given view (profile).
- "kind": "analytics#gaData", # Resource type.
- "rows": [ # Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
- [
- "A String",
- ],
- ],
- "containsSampledData": True or False, # Determines if Analytics data contains samples.
- "totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
- "itemsPerPage": 42, # The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "totalsForAllResults": { # Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.
- "a_key": "A String", # Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.
- },
- "nextLink": "A String", # Link to next page for this Analytics data query.
- "id": "A String", # Unique ID for this data response.
- "query": { # Analytics data request query parameters.
- "max-results": 42, # Maximum results per page.
- "sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
- "A String",
- ],
- "dimensions": "A String", # List of analytics dimensions.
- "start-date": "A String", # Start date.
- "start-index": 42, # Start index.
- "segment": "A String", # Analytics advanced segment.
- "ids": "A String", # Unique table ID.
- "metrics": [ # List of analytics metrics.
- "A String",
- ],
- "filters": "A String", # Comma-separated list of dimension or metric filters.
- "end-date": "A String", # End date.
- },
- "previousLink": "A String", # Link to previous page for this Analytics data query.
- "profileInfo": { # Information for the view (profile), for which the Analytics data was requested.
- "webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
- "tableId": "A String", # Table ID for view (profile).
- "profileId": "A String", # View (Profile) ID.
- "profileName": "A String", # View (Profile) name.
- "accountId": "A String", # Account ID to which this view (profile) belongs.
- },
- "columnHeaders": [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
- {
- "dataType": "A String", # Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.
- "columnType": "A String", # Column Type. Either DIMENSION or METRIC.
- "name": "A String", # Column name.
- },
- ],
- "selfLink": "A String", # Link to this page.
- }
-
Instance Methods
-
- ga()
-
-Returns the ga Resource.
-
-
- mcf()
-
-Returns the mcf Resource.
-
-
- realtime()
-
-Returns the realtime Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/analytics_v3.data.mcf.html b/docs/dyn/analytics_v3.data.mcf.html
deleted file mode 100644
index 176df06..0000000
--- a/docs/dyn/analytics_v3.data.mcf.html
+++ /dev/null
@@ -1,158 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)
-Returns Analytics Multi-Channel Funnels data for a view (profile).
-Method Details
-
-
get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)
-
Returns Analytics Multi-Channel Funnels data for a view (profile).
-
-Args:
- ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. (required)
- start_date: string, Start date for fetching Analytics data. All requests should specify a start date formatted as YYYY-MM-DD. (required)
- end_date: string, End date for fetching Analytics data. All requests should specify an end date formatted as YYYY-MM-DD. (required)
- metrics: string, A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified. (required)
- sort: string, A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.
- dimensions: string, A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.
- filters: string, A comma-separated list of dimension or metric filters to be applied to the Analytics data.
- max_results: integer, The maximum number of entries to include in this feed.
- start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
-
-Returns:
- An object of the form:
-
- { # Multi-Channel Funnels data for a given view (profile).
- "kind": "analytics#mcfData", # Resource type.
- "rows": [ # Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
- [
- { # A union object representing a dimension or metric value. Only one of "primitiveValue" or "conversionPathValue" attribute will be populated.
- "primitiveValue": "A String", # A primitive dimension value. A primitive metric value.
- "conversionPathValue": [ # A conversion path dimension value, containing a list of interactions with their attributes.
- {
- "nodeValue": "A String", # Node value of an interaction on conversion path. Such as source, medium etc.
- "interactionType": "A String", # Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc.
- },
- ],
- },
- ],
- ],
- "containsSampledData": True or False, # Determines if the Analytics data contains sampled data.
- "totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
- "itemsPerPage": 42, # The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "totalsForAllResults": { # Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.
- "a_key": "A String", # Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.
- },
- "nextLink": "A String", # Link to next page for this Analytics data query.
- "id": "A String", # Unique ID for this data response.
- "query": { # Analytics data request query parameters.
- "max-results": 42, # Maximum results per page.
- "sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
- "A String",
- ],
- "dimensions": "A String", # List of analytics dimensions.
- "start-date": "A String", # Start date.
- "start-index": 42, # Start index.
- "segment": "A String", # Analytics advanced segment.
- "ids": "A String", # Unique table ID.
- "metrics": [ # List of analytics metrics.
- "A String",
- ],
- "filters": "A String", # Comma-separated list of dimension or metric filters.
- "end-date": "A String", # End date.
- },
- "previousLink": "A String", # Link to previous page for this Analytics data query.
- "profileInfo": { # Information for the view (profile), for which the Analytics data was requested.
- "webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
- "tableId": "A String", # Table ID for view (profile).
- "profileId": "A String", # View (Profile) ID.
- "profileName": "A String", # View (Profile) name.
- "accountId": "A String", # Account ID to which this view (profile) belongs.
- },
- "columnHeaders": [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
- {
- "dataType": "A String", # Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.
- "columnType": "A String", # Column Type. Either DIMENSION or METRIC.
- "name": "A String", # Column name.
- },
- ],
- "selfLink": "A String", # Link to this page.
- }
-
Instance Methods
-
- get(ids, metrics, sort=None, dimensions=None, filters=None, max_results=None)
-Returns real-time data for a view (profile).
-Method Details
-
-
get(ids, metrics, sort=None, dimensions=None, filters=None, max_results=None)
-
Returns real-time data for a view (profile).
-
-Args:
- ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (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)
- sort: string, A comma-separated list of dimensions or metrics that determine the sort order for real-time data.
- dimensions: string, A comma-separated list of real-time dimensions. E.g., 'ga:medium,ga:city'.
- filters: string, A comma-separated list of dimension or metric filters to be applied to real-time data.
- max_results: integer, The maximum number of entries to include in this feed.
-
-Returns:
- An object of the form:
-
- { # Real time data for a given view (profile).
- "kind": "analytics#realtimeData", # Resource type.
- "rows": [ # Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
- [
- "A String",
- ],
- ],
- "totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
- "totalsForAllResults": { # Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.
- "a_key": "A String", # Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.
- },
- "id": "A String", # Unique ID for this data response.
- "query": { # Real time data request query parameters.
- "max-results": 42, # Maximum results per page.
- "sort": [ # List of dimensions or metrics based on which real time data is sorted.
- "A String",
- ],
- "dimensions": "A String", # List of real time dimensions.
- "ids": "A String", # Unique table ID.
- "metrics": [ # List of real time metrics.
- "A String",
- ],
- "filters": "A String", # Comma-separated list of dimension or metric filters.
- },
- "profileInfo": { # Information for the view (profile), for which the real time data was requested.
- "webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
- "tableId": "A String", # Table ID for view (profile).
- "profileId": "A String", # View (Profile) ID.
- "profileName": "A String", # View (Profile) name.
- "accountId": "A String", # Account ID to which this view (profile) belongs.
- },
- "columnHeaders": [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
- {
- "dataType": "A String", # Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.
- "columnType": "A String", # Column Type. Either DIMENSION or METRIC.
- "name": "A String", # Column name.
- },
- ],
- "selfLink": "A String", # Link to this page.
- }
-
Instance Methods
-
- data()
-
-Returns the data Resource.
-
-
- management()
-
-Returns the management Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/analytics_v3.management.accounts.html b/docs/dyn/analytics_v3.management.accounts.html
deleted file mode 100644
index eab83f2..0000000
--- a/docs/dyn/analytics_v3.management.accounts.html
+++ /dev/null
@@ -1,117 +0,0 @@
-
-
-
-
-Instance Methods
-
- list(max_results=None, start_index=None)
-Lists all accounts to which the user has access.
-Method Details
-
-
list(max_results=None, start_index=None)
-
Lists all accounts to which the user has access.
-
-Args:
- max_results: integer, The maximum number of accounts to include in this response.
- 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:
- An object of the form:
-
- { # An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account.
- "username": "A String", # Email ID of the authenticated user
- "kind": "analytics#accounts", # Collection type.
- "items": [ # A list of accounts.
- { # JSON template for Analytics account entry.
- "kind": "analytics#account", # Resource type for Analytics account.
- "name": "A String", # Account name.
- "created": "A String", # Time the account was created.
- "updated": "A String", # Time the account was last modified.
- "childLink": { # Child link for an account entry. Points to the list of web properties for this account.
- "href": "A String", # Link to the list of web properties for this account.
- "type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".
- },
- "id": "A String", # Account ID.
- "selfLink": "A String", # Link for this account.
- },
- ],
- "itemsPerPage": 42, # The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "previousLink": "A String", # Previous link for this account collection.
- "startIndex": 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.
- "nextLink": "A String", # Next link for this account collection.
- "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
- }
-
Instance Methods
-
- list(accountId, webPropertyId, max_results=None, start_index=None)
-List custom data sources to which the user has access.
-Method Details
-
-
list(accountId, webPropertyId, max_results=None, start_index=None)
-
List custom data sources to which the user has access.
-
-Args:
- accountId: string, Account Id for the custom data sources to retrieve. (required)
- webPropertyId: string, Web property Id for the custom data sources to retrieve. (required)
- max_results: integer, The maximum number of custom data sources to include in this response.
- start_index: integer, A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
-
-Returns:
- An object of the form:
-
- { # Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source.
- "username": "A String", # Email ID of the authenticated user
- "kind": "analytics#customDataSources", # Collection type.
- "items": [ # Collection of custom data sources.
- { # JSON template for an Analytics custom data source.
- "kind": "analytics#customDataSource", # Resource type for Analytics custom data source.
- "description": "A String", # Description of custom data source.
- "created": "A String", # Time this custom data source was created.
- "profilesLinked": [ # IDs of views (profiles) linked to the custom data source.
- "A String",
- ],
- "updated": "A String", # Time this custom data source was last modified.
- "name": "A String", # Name of this custom data source.
- "childLink": {
- "href": "A String", # Link to the list of daily uploads for this custom data source. Link to the list of uploads for this custom data source.
- "type": "A String", # Value is "analytics#dailyUploads". Value is "analytics#uploads".
- },
- "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this custom data source belongs.
- "parentLink": { # Parent link for this custom data source. Points to the web property to which this custom data source belongs.
- "href": "A String", # Link to the web property to which this custom data source belongs.
- "type": "analytics#webproperty", # Value is "analytics#webproperty".
- },
- "type": "A String", # Type of the custom data source.
- "id": "A String", # Custom data source ID.
- "selfLink": "A String", # Link for this Analytics custom data source.
- "accountId": "A String", # Account ID to which this custom data source belongs.
- },
- ],
- "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "previousLink": "A String", # Link to previous page for this custom data source collection.
- "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
- "nextLink": "A String", # Link to next page for this custom data source collection.
- "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
- }
-
Instance Methods
-
- delete(accountId, webPropertyId, customDataSourceId, date, type)
-Delete uploaded data for the given date.
-
- list(accountId, webPropertyId, customDataSourceId, start_date, end_date, max_results=None, start_index=None)
-List daily uploads to which the user has access.
-
- upload(accountId, webPropertyId, customDataSourceId, date, appendNumber, type, reset=None, media_body=None)
-Update/Overwrite data for a custom data source.
-Method Details
-
-
delete(accountId, webPropertyId, customDataSourceId, date, type)
-
Delete uploaded data for the given date.
-
-Args:
- accountId: string, Account Id associated with daily upload delete. (required)
- webPropertyId: string, Web property Id associated with daily upload delete. (required)
- customDataSourceId: string, Custom data source Id associated with daily upload delete. (required)
- date: string, Date for which data is to be deleted. Date should be formatted as YYYY-MM-DD. (required)
- type: string, Type of data for this delete. (required)
- Allowed values
- cost - Value for specifying cost data upload.
-
-
-
list(accountId, webPropertyId, customDataSourceId, start_date, end_date, max_results=None, start_index=None)
-
List daily uploads to which the user has access.
-
-Args:
- accountId: string, Account Id for the daily uploads to retrieve. (required)
- webPropertyId: string, Web property Id for the daily uploads to retrieve. (required)
- customDataSourceId: string, Custom data source Id for daily uploads to retrieve. (required)
- start_date: string, Start date of the form YYYY-MM-DD. (required)
- end_date: string, End date of the form YYYY-MM-DD. (required)
- max_results: integer, The maximum number of custom data sources to include in this response.
- start_index: integer, A 1-based index of the first daily upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
-
-Returns:
- An object of the form:
-
- { # A daily upload collection lists Analytics daily uploads to which the user has access. Each resource in the collection corresponds to a single Analytics daily upload.
- "username": "A String", # Email ID of the authenticated user
- "kind": "analytics#dailyUploads", # Collection type. Value is analytics#dailyUploads.
- "items": [ # A collection of daily uploads.
- { # Metadata for daily upload entity.
- "recentChanges": [ # Change log for last 10 changes in chronological order.
- {
- "change": "A String", # The type of change: APPEND, RESET, or DELETE.
- "time": "A String", # The time when the change occurred.
- },
- ],
- "kind": "analytics#dailyUpload", # Resource type for Analytics daily upload.
- "modifiedTime": "A String", # Time this daily upload was last modified.
- "appendCount": 42, # Number of appends for this date.
- "customDataSourceId": "A String", # Custom data source ID to which this daily upload belongs.
- "date": "A String", # Date associated with daily upload.
- "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this daily upload belongs.
- "createdTime": "A String", # Time this daily upload was created.
- "parentLink": { # Parent link for a daily upload. Points to the custom data source to which this daily upload belongs.
- "href": "A String", # Link to the custom data source to which this daily upload belongs.
- "type": "analytics#customDataSource", # Value is "analytics#customDataSource".
- },
- "selfLink": "A String", # Link for this daily upload.
- "accountId": "A String", # Account ID to which this daily upload belongs.
- },
- ],
- "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "previousLink": "A String", # Link to previous page for this daily upload collection.
- "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
- "nextLink": "A String", # Link to next page for this daily upload collection.
- "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
- }
-
-
upload(accountId, webPropertyId, customDataSourceId, date, appendNumber, type, reset=None, media_body=None)
-
Update/Overwrite data for a custom data source.
-
-Args:
- accountId: string, Account Id associated with daily upload. (required)
- webPropertyId: string, Web property Id associated with daily upload. (required)
- customDataSourceId: string, Custom data source Id to which the data being uploaded belongs. (required)
- date: string, Date for which data is uploaded. Date should be formatted as YYYY-MM-DD. (required)
- appendNumber: integer, Append number for this upload indexed from 1. (required)
- type: string, Type of data for this upload. (required)
- Allowed values
- cost - Value for specifying cost data upload.
- reset: boolean, Reset/Overwrite all previous appends for this date and start over with this file as the first upload.
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
-
-Returns:
- An object of the form:
-
- { # Metadata returned for a successful append operation.
- "kind": "analytics#dailyUploadAppend", # Resource type for Analytics daily upload append.
- "customDataSourceId": "A String", # Custom data source Id to which this daily upload append belongs.
- "appendNumber": 42, # Append number.
- "webPropertyId": "A String", # Web property Id of the form UA-XXXXX-YY to which this daily upload append belongs.
- "date": "A String", # Date associated with daily upload append.
- "nextAppendLink": "A String",
- "accountId": "A String", # Account Id to which this daily upload append belongs.
- }
-
Instance Methods
-
- delete(accountId, webPropertyId, profileId, experimentId)
-Delete an experiment.
-
- get(accountId, webPropertyId, profileId, experimentId)
-Returns an experiment to which the user has access.
-
- insert(accountId, webPropertyId, profileId, body)
-Create a new experiment.
-
- list(accountId, webPropertyId, profileId, max_results=None, start_index=None)
-Lists experiments to which the user has access.
-
- patch(accountId, webPropertyId, profileId, experimentId, body)
-Update an existing experiment. This method supports patch semantics.
-
- update(accountId, webPropertyId, profileId, experimentId, body)
-Update an existing experiment.
-Method Details
-
-
delete(accountId, webPropertyId, profileId, experimentId)
-
Delete an experiment.
-
-Args:
- accountId: string, Account ID to which the experiment belongs (required)
- webPropertyId: string, Web property ID to which the experiment belongs (required)
- profileId: string, View (Profile) ID to which the experiment belongs (required)
- experimentId: string, ID of the experiment to delete (required)
-
-
-
get(accountId, webPropertyId, profileId, experimentId)
-
Returns an experiment to which the user has access.
-
-Args:
- accountId: string, Account ID to retrieve the experiment for. (required)
- webPropertyId: string, Web property ID to retrieve the experiment for. (required)
- profileId: string, View (Profile) ID to retrieve the experiment for. (required)
- experimentId: string, Experiment ID to retrieve the experiment for. (required)
-
-Returns:
- An object of the form:
-
- { # JSON template for Analytics experiment resource.
- "trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
- "optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
- "objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
- "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
- "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
- "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
- "editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
- "rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
- "servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
- # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
- # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
- # - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
- "status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
- "updated": "A String", # Time the experiment was last modified. This field is read-only.
- "description": "A String", # Notes about this experiment.
- "reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
- "winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
- "startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
- "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
- "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
- "name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
- "created": "A String", # Time the experiment was created. This field is read-only.
- "variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
- {
- "status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
- "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
- "won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
- "name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
- "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
- },
- ],
- "minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
- "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
- "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
- "type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
- },
- "endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
- "selfLink": "A String", # Link for this experiment. This field is read-only.
- }
-
-
insert(accountId, webPropertyId, profileId, body)
-
Create a new experiment.
-
-Args:
- accountId: string, Account ID to create the experiment for. (required)
- webPropertyId: string, Web property ID to create the experiment for. (required)
- profileId: string, View (Profile) ID to create the experiment for. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # JSON template for Analytics experiment resource.
- "trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
- "optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
- "objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
- "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
- "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
- "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
- "editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
- "rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
- "servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
- # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
- # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
- # - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
- "status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
- "updated": "A String", # Time the experiment was last modified. This field is read-only.
- "description": "A String", # Notes about this experiment.
- "reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
- "winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
- "startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
- "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
- "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
- "name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
- "created": "A String", # Time the experiment was created. This field is read-only.
- "variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
- {
- "status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
- "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
- "won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
- "name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
- "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
- },
- ],
- "minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
- "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
- "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
- "type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
- },
- "endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
- "selfLink": "A String", # Link for this experiment. This field is read-only.
- }
-
-
-Returns:
- An object of the form:
-
- { # JSON template for Analytics experiment resource.
- "trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
- "optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
- "objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
- "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
- "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
- "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
- "editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
- "rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
- "servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
- # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
- # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
- # - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
- "status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
- "updated": "A String", # Time the experiment was last modified. This field is read-only.
- "description": "A String", # Notes about this experiment.
- "reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
- "winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
- "startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
- "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
- "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
- "name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
- "created": "A String", # Time the experiment was created. This field is read-only.
- "variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
- {
- "status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
- "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
- "won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
- "name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
- "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
- },
- ],
- "minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
- "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
- "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
- "type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
- },
- "endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
- "selfLink": "A String", # Link for this experiment. This field is read-only.
- }
-
-
list(accountId, webPropertyId, profileId, max_results=None, start_index=None)
-
Lists experiments to which the user has access.
-
-Args:
- accountId: string, Account ID to retrieve experiments for. (required)
- webPropertyId: string, Web property ID to retrieve experiments for. (required)
- profileId: string, View (Profile) ID to retrieve experiments for. (required)
- max_results: integer, The maximum number of experiments to include in this response.
- start_index: integer, An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
-
-Returns:
- An object of the form:
-
- { # An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment.
- "username": "A String", # Email ID of the authenticated user
- "kind": "analytics#experiments", # Collection type.
- "items": [ # A list of experiments.
- { # JSON template for Analytics experiment resource.
- "trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
- "optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
- "objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
- "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
- "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
- "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
- "editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
- "rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
- "servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
- # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
- # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
- # - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
- "status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
- "updated": "A String", # Time the experiment was last modified. This field is read-only.
- "description": "A String", # Notes about this experiment.
- "reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
- "winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
- "startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
- "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
- "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
- "name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
- "created": "A String", # Time the experiment was created. This field is read-only.
- "variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
- {
- "status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
- "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
- "won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
- "name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
- "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
- },
- ],
- "minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
- "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
- "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
- "type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
- },
- "endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
- "selfLink": "A String", # Link for this experiment. This field is read-only.
- },
- ],
- "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "previousLink": "A String", # Link to previous page for this experiment collection.
- "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
- "nextLink": "A String", # Link to next page for this experiment collection.
- "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
- }
-
-
patch(accountId, webPropertyId, profileId, experimentId, body)
-
Update an existing experiment. This method supports patch semantics.
-
-Args:
- accountId: string, Account ID of the experiment to update. (required)
- webPropertyId: string, Web property ID of the experiment to update. (required)
- profileId: string, View (Profile) ID of the experiment to update. (required)
- experimentId: string, Experiment ID of the experiment to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # JSON template for Analytics experiment resource.
- "trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
- "optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
- "objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
- "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
- "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
- "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
- "editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
- "rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
- "servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
- # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
- # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
- # - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
- "status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
- "updated": "A String", # Time the experiment was last modified. This field is read-only.
- "description": "A String", # Notes about this experiment.
- "reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
- "winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
- "startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
- "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
- "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
- "name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
- "created": "A String", # Time the experiment was created. This field is read-only.
- "variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
- {
- "status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
- "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
- "won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
- "name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
- "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
- },
- ],
- "minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
- "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
- "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
- "type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
- },
- "endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
- "selfLink": "A String", # Link for this experiment. This field is read-only.
- }
-
-
-Returns:
- An object of the form:
-
- { # JSON template for Analytics experiment resource.
- "trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
- "optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
- "objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
- "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
- "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
- "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
- "editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
- "rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
- "servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
- # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
- # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
- # - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
- "status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
- "updated": "A String", # Time the experiment was last modified. This field is read-only.
- "description": "A String", # Notes about this experiment.
- "reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
- "winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
- "startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
- "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
- "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
- "name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
- "created": "A String", # Time the experiment was created. This field is read-only.
- "variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
- {
- "status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
- "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
- "won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
- "name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
- "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
- },
- ],
- "minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
- "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
- "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
- "type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
- },
- "endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
- "selfLink": "A String", # Link for this experiment. This field is read-only.
- }
-
-
update(accountId, webPropertyId, profileId, experimentId, body)
-
Update an existing experiment.
-
-Args:
- accountId: string, Account ID of the experiment to update. (required)
- webPropertyId: string, Web property ID of the experiment to update. (required)
- profileId: string, View (Profile) ID of the experiment to update. (required)
- experimentId: string, Experiment ID of the experiment to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # JSON template for Analytics experiment resource.
- "trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
- "optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
- "objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
- "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
- "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
- "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
- "editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
- "rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
- "servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
- # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
- # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
- # - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
- "status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
- "updated": "A String", # Time the experiment was last modified. This field is read-only.
- "description": "A String", # Notes about this experiment.
- "reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
- "winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
- "startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
- "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
- "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
- "name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
- "created": "A String", # Time the experiment was created. This field is read-only.
- "variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
- {
- "status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
- "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
- "won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
- "name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
- "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
- },
- ],
- "minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
- "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
- "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
- "type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
- },
- "endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
- "selfLink": "A String", # Link for this experiment. This field is read-only.
- }
-
-
-Returns:
- An object of the form:
-
- { # JSON template for Analytics experiment resource.
- "trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
- "optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
- "objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
- "id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
- "accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
- "snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
- "editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
- "rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
- "servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
- # - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
- # - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
- # - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
- "status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
- "updated": "A String", # Time the experiment was last modified. This field is read-only.
- "description": "A String", # Notes about this experiment.
- "reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
- "winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
- "startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
- "winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
- "kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
- "name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
- "created": "A String", # Time the experiment was created. This field is read-only.
- "variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
- {
- "status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
- "url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
- "won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
- "name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
- "weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
- },
- ],
- "minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
- "profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
- "parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
- "href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
- "type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
- },
- "endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
- "selfLink": "A String", # Link for this experiment. This field is read-only.
- }
-
Instance Methods
-
- list(accountId, webPropertyId, profileId, max_results=None, start_index=None)
-Lists goals to which the user has access.
-Method Details
-
-
list(accountId, webPropertyId, profileId, max_results=None, start_index=None)
-
Lists goals to which the user has access.
-
-Args:
- 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)
- 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)
- profileId: string, View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. (required)
- max_results: integer, The maximum number of goals to include in this response.
- start_index: integer, An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
-
-Returns:
- An object of the form:
-
- { # A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.
- "username": "A String", # Email ID of the authenticated user
- "kind": "analytics#goals", # Collection type.
- "items": [ # A list of goals.
- { # JSON template for Analytics goal resource.
- "kind": "analytics#goal", # Resource type for an Analytics goal.
- "visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
- "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
- "comparisonValue": "A String", # Value used for this comparison.
- },
- "name": "A String", # Goal name.
- "created": "A String", # Time this goal was created.
- "urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
- "url": "A String", # URL for this goal.
- "caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
- "matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
- "steps": [ # List of steps configured for this goal funnel.
- {
- "url": "A String", # URL for this step.
- "name": "A String", # Step name.
- "number": 42, # Step number.
- },
- ],
- "firstStepRequired": True or False, # Determines if the first step in this goal is required.
- },
- "updated": "A String", # Time this goal was last modified.
- "value": 3.14, # Goal value.
- "visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.
- "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.
- "comparisonValue": "A String", # Value used for this comparison.
- },
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.
- "eventDetails": { # Details for the goal of the type EVENT.
- "eventConditions": [ # List of event conditions.
- {
- "type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.
- "matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.
- "expression": "A String", # Expression used for this match.
- "comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.
- "comparisonValue": "A String", # Value used for this comparison.
- },
- ],
- "useEventValue": True or False, # Determines if the event value should be used as the value for this goal.
- },
- "webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.
- "active": True or False, # Determines whether this goal is active.
- "profileId": "A String", # View (Profile) ID to which this goal belongs.
- "parentLink": { # Parent link for a goal. Points to the view (profile) to which this goal belongs.
- "href": "A String", # Link to the view (profile) to which this goal belongs.
- "type": "analytics#profile", # Value is "analytics#profile".
- },
- "type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
- "id": "A String", # Goal ID.
- "selfLink": "A String", # Link for this goal.
- "accountId": "A String", # Account ID to which this goal belongs.
- },
- ],
- "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "previousLink": "A String", # Link to previous page for this goal collection.
- "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
- "nextLink": "A String", # Link to next page for this goal collection.
- "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
- }
-
Instance Methods
-
- accounts()
-
-Returns the accounts Resource.
-
-
- customDataSources()
-
-Returns the customDataSources Resource.
-
-
- dailyUploads()
-
-Returns the dailyUploads Resource.
-
-
- experiments()
-
-Returns the experiments Resource.
-
-
- goals()
-
-Returns the goals Resource.
-
-
- profiles()
-
-Returns the profiles Resource.
-
-
- segments()
-
-Returns the segments Resource.
-
-
- webproperties()
-
-Returns the webproperties Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/analytics_v3.management.profiles.html b/docs/dyn/analytics_v3.management.profiles.html
deleted file mode 100644
index 9891fed..0000000
--- a/docs/dyn/analytics_v3.management.profiles.html
+++ /dev/null
@@ -1,135 +0,0 @@
-
-
-
-
-Instance Methods
-
- list(accountId, webPropertyId, max_results=None, start_index=None)
-Lists views (profiles) to which the user has access.
-Method Details
-
-
list(accountId, webPropertyId, max_results=None, start_index=None)
-
Lists views (profiles) to which the user has access.
-
-Args:
- accountId: string, Account ID for the view (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)
- webPropertyId: string, Web property ID for the views (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)
- max_results: integer, The maximum number of views (profiles) to include in this response.
- start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
-
-Returns:
- An object of the form:
-
- { # A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile).
- "username": "A String", # Email ID of the authenticated user
- "kind": "analytics#profiles", # Collection type.
- "items": [ # A list of views (profiles).
- { # JSON template for an Analytics view (profile).
- "defaultPage": "A String", # Default page for this view (profile).
- "kind": "analytics#profile", # Resource type for Analytics profile.
- "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
- "name": "A String", # Name of this view (profile).
- "created": "A String", # Time this view (profile) was created.
- "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
- "updated": "A String", # Time this view (profile) was last modified.
- "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
- "websiteUrl": "A String", # Website URL for this view (profile).
- "currency": "A String", # The currency type associated with this view (profile).
- "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
- "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
- "href": "A String", # Link to the list of goals for this view (profile).
- "type": "analytics#goals", # Value is "analytics#goals".
- },
- "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
- "timezone": "A String", # Time zone for which this profile has been configured.
- "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
- "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
- "href": "A String", # Link to the web property to which this view (profile) belongs.
- "type": "analytics#webproperty", # Value is "analytics#webproperty".
- },
- "type": "A String", # View (Profile) type. Supported types: WEB or APP.
- "id": "A String", # View (Profile) ID.
- "selfLink": "A String", # Link for this view (profile).
- "accountId": "A String", # Account ID to which this view (profile) belongs.
- },
- ],
- "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "previousLink": "A String", # Link to previous page for this view (profile) collection.
- "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
- "nextLink": "A String", # Link to next page for this view (profile) collection.
- "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
- }
-
Instance Methods
-
- list(max_results=None, start_index=None)
-Lists advanced segments to which the user has access.
-Method Details
-
-
list(max_results=None, start_index=None)
-
Lists advanced segments to which the user has access.
-
-Args:
- max_results: integer, The maximum number of advanced segments to include in this response.
- 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:
- An object of the form:
-
- { # An advanced segment collection lists Analytics advanced segments that the user has access to. Each resource in the collection corresponds to a single Analytics advanced segment.
- "username": "A String", # Email ID of the authenticated user
- "kind": "analytics#segments", # Collection type for advanced segments.
- "items": [ # A list of advanced segments.
- { # JSON template for an Analytics advanced segment.
- "definition": "A String", # Advanced segment definition.
- "kind": "analytics#segment", # Resource type for Analytics advanced segment.
- "segmentId": "A String", # Segment ID. Can be used with the 'segment' parameter in Data Feed.
- "created": "A String", # Time the advanced segment was created.
- "updated": "A String", # Time the advanced segment was last modified.
- "id": "A String", # Advanced segment ID.
- "selfLink": "A String", # Link for this advanced segment.
- "name": "A String", # Advanced segment name.
- },
- ],
- "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "previousLink": "A String", # Link to previous page for this advanced segment collection.
- "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
- "nextLink": "A String", # Link to next page for this advanced segment collection.
- "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
- }
-
Instance Methods
-
- list(accountId, max_results=None, start_index=None)
-Lists web properties to which the user has access.
-Method Details
-
-
list(accountId, max_results=None, start_index=None)
-
Lists web properties to which the user has access.
-
-Args:
- 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)
- max_results: integer, The maximum number of web properties to include in this response.
- start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
-
-Returns:
- An object of the form:
-
- { # A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property.
- "username": "A String", # Email ID of the authenticated user
- "kind": "analytics#webproperties", # Collection type.
- "items": [ # A list of web properties.
- { # JSON template for an Analytics web property.
- "websiteUrl": "A String", # Website url for this web property.
- "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
- "name": "A String", # Name of this web property.
- "created": "A String", # Time this web property was created.
- "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
- "updated": "A String", # Time this web property was last modified.
- "profileCount": 42, # View (Profile) count for this web property.
- "internalWebPropertyId": "A String", # Internal ID for this web property.
- "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
- "href": "A String", # Link to the list of views (profiles) for this web property.
- "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
- },
- "industryVertical": "A String", # The industry vertical/category selected for this web property.
- "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
- "href": "A String", # Link to the account for this web property.
- "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
- },
- "id": "A String", # Web property ID of the form UA-XXXXX-YY.
- "selfLink": "A String", # Link for this web property.
- "accountId": "A String", # Account ID to which this web property belongs.
- },
- ],
- "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
- "previousLink": "A String", # Link to previous page for this web property collection.
- "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
- "nextLink": "A String", # Link to next page for this web property collection.
- "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
- }
-
Instance Methods
-
- purchases()
-
-Returns the purchases Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/androidpublisher_v1.purchases.html b/docs/dyn/androidpublisher_v1.purchases.html
deleted file mode 100644
index f791d79..0000000
--- a/docs/dyn/androidpublisher_v1.purchases.html
+++ /dev/null
@@ -1,115 +0,0 @@
-
-
-
-
-Instance Methods
-
- cancel(packageName, subscriptionId, token)
-Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
-
- get(packageName, subscriptionId, token)
-Checks whether a user's subscription purchase is valid and returns its expiry time.
-Method Details
-
-
cancel(packageName, subscriptionId, token)
-
Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
-
-Args:
- packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
- subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
- token: string, The token provided to the user's device when the subscription was purchased. (required)
-
-
-
get(packageName, subscriptionId, token)
-
Checks whether a user's subscription purchase is valid and returns its expiry time.
-
-Args:
- packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
- subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
- token: string, The token provided to the user's device when the subscription was purchased. (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.
- }
-
Instance Methods
-
- inapppurchases()
-
-Returns the inapppurchases Resource.
-
-
- purchases()
-
-Returns the purchases Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/androidpublisher_v1_1.inapppurchases.html b/docs/dyn/androidpublisher_v1_1.inapppurchases.html
deleted file mode 100644
index e358f3c..0000000
--- a/docs/dyn/androidpublisher_v1_1.inapppurchases.html
+++ /dev/null
@@ -1,106 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(packageName, productId, token)
-Checks the purchase and consumption status of an inapp item.
-Method Details
-
-
get(packageName, productId, token)
-
Checks the purchase and consumption status of an inapp item.
-
-Args:
- packageName: string, The package name of the application the inapp product was sold in (for example, 'com.some.thing'). (required)
- productId: string, The inapp product SKU (for example, 'com.some.thing.inapp1'). (required)
- token: string, The token provided to the user's device when the inapp product was purchased. (required)
-
-Returns:
- An object of the form:
-
- { # A Purchase resource indicates the status of a user's subscription purchase.
- "consumptionState": 42, # The consumption state of the inapp product. Possible values are:
- # - - Consumed
- # - - Yet to be consumed
- "developerPayload": "A String", # A developer-specified string that contains supplemental information about an order.
- "kind": "androidpublisher#inappPurchase", # This kind represents a inappPurchase object in the androidpublisher service.
- "purchaseTime": "A String", # The time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).
- "purchaseState": 42, # The purchase state of the order. Possible values are:
- # - - Purchased
- # - - Cancelled
- }
-
Instance Methods
-
- cancel(packageName, subscriptionId, token)
-Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
-
- get(packageName, subscriptionId, token)
-Checks whether a user's subscription purchase is valid and returns its expiry time.
-Method Details
-
-
cancel(packageName, subscriptionId, token)
-
Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
-
-Args:
- packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
- subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
- token: string, The token provided to the user's device when the subscription was purchased. (required)
-
-
-
get(packageName, subscriptionId, token)
-
Checks whether a user's subscription purchase is valid and returns its expiry time.
-
-Args:
- packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
- subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
- token: string, The token provided to the user's device when the subscription was purchased. (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.
- }
-
Instance Methods
-
- states()
-
-Returns the states Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/appstate_v1.states.html b/docs/dyn/appstate_v1.states.html
deleted file mode 100644
index 62656aa..0000000
--- a/docs/dyn/appstate_v1.states.html
+++ /dev/null
@@ -1,188 +0,0 @@
-
-
-
-
-Instance Methods
-
- clear(stateKey, currentDataVersion=None)
-Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.
-
- delete(stateKey)
-Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption.
-
- get(stateKey)
-Retrieves the data corresponding to the passed key.
-
- list(includeData=None)
-Lists all the states keys, and optionally the state data.
-
- update(stateKey, body, currentStateVersion=None)
-Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB.
-Method Details
-
-
clear(stateKey, currentDataVersion=None)
-
Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch.
-
-Args:
- stateKey: integer, The key for the data to be retrieved. (required)
- currentDataVersion: string, The version of the data to be cleared. Version strings are returned by the server.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for an app state write result.
- "kind": "appstate#writeResult", # Uniquely identifies the type of this resource. Value is always the fixed string appstate#writeResult.
- "stateKey": 42, # The written key.
- "currentStateVersion": "A String", # The version of the data for this key on the server.
- }
-
-
delete(stateKey)
-
Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption.
-
-Args:
- stateKey: integer, The key for the data to be retrieved. (required)
-
-
-
get(stateKey)
-
Retrieves the data corresponding to the passed key.
-
-Args:
- stateKey: integer, The key for the data to be retrieved. (required)
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for an app state resource.
- "stateKey": 42, # The key for the data.
- "kind": "appstate#getResponse", # Uniquely identifies the type of this resource. Value is always the fixed string appstate#getResponse.
- "data": "A String", # The requested data.
- "currentStateVersion": "A String", # The current app state version.
- }
-
-
list(includeData=None)
-
Lists all the states keys, and optionally the state data.
-
-Args:
- includeData: boolean, Whether to include the full data in addition to the version number
-
-Returns:
- An object of the form:
-
- { # This is a JSON template to convert a list-response for app state.
- "items": [ # The app state data.
- { # This is a JSON template for an app state resource.
- "stateKey": 42, # The key for the data.
- "kind": "appstate#getResponse", # Uniquely identifies the type of this resource. Value is always the fixed string appstate#getResponse.
- "data": "A String", # The requested data.
- "currentStateVersion": "A String", # The current app state version.
- },
- ],
- "kind": "appstate#listResponse", # Uniquely identifies the type of this resource. Value is always the fixed string appstate#listResponse.
- "maximumKeyCount": 42, # The maximum number of keys allowed for this user.
- }
-
-
update(stateKey, body, currentStateVersion=None)
-
Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB.
-
-Args:
- stateKey: integer, The key for the data to be retrieved. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # This is a JSON template for a requests which update app state
- "kind": "appstate#updateRequest", # Uniquely identifies the type of this resource. Value is always the fixed string appstate#updateRequest.
- "data": "A String", # The new app state data that your application is trying to update with.
- }
-
- currentStateVersion: string, The version of the app state your application is attempting to update. If this does not match the current version, this method will return a conflict error. If there is no data stored on the server for this key, the update will succeed irrespective of the value of this parameter.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for an app state write result.
- "kind": "appstate#writeResult", # Uniquely identifies the type of this resource. Value is always the fixed string appstate#writeResult.
- "stateKey": 42, # The written key.
- "currentStateVersion": "A String", # The version of the data for this key on the server.
- }
-
Instance Methods
-
- list(customerId, applicationId, caller=None, startTime=None, actorIpAddress=None, eventName=None, actorApplicationId=None, continuationToken=None, maxResults=None, actorEmail=None, endTime=None)
-Retrieves a list of activities for a specific customer and application.
-Method Details
-
-
list(customerId, applicationId, caller=None, startTime=None, actorIpAddress=None, eventName=None, actorApplicationId=None, continuationToken=None, maxResults=None, actorEmail=None, endTime=None)
-
Retrieves a list of activities for a specific customer and application.
-
-Args:
- customerId: string, Represents the customer who is the owner of target object on which action was performed. (required)
- applicationId: string, Application ID of the application on which the event was performed. (required)
- caller: string, Type of the caller.
- Allowed values
- application_owner - Caller is an application owner.
- customer - Caller is a customer.
- startTime: string, Return events which occured at or after this time.
- actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
- eventName: string, Name of the event being queried.
- actorApplicationId: string, Application ID of the application which interacted on behalf of the user while performing the event.
- continuationToken: string, Next page URL.
- maxResults: integer, Number of activity records to be shown in each page.
- actorEmail: string, Email address of the user who performed the action.
- endTime: string, Return events which occured at or before this time.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # Each record in read response.
- {
- "kind": "audit#activity", # Kind of resource this is.
- "ownerDomain": "A String", # Domain of source customer.
- "actor": { # User doing the action.
- "applicationId": "A String", # ID of application which interacted on behalf of the user.
- "email": "A String", # Email address of the user.
- "key": "A String", # For OAuth 2LO API requests, consumer_key of the requestor.
- "callerType": "A String", # User or OAuth 2LO request.
- },
- "id": { # Unique identifier for each activity record.
- "uniqQualifier": "A String", # Unique qualifier if multiple events have the same time.
- "applicationId": "A String", # Application ID of the source application.
- "customerId": "A String", # Obfuscated customer ID of the source customer.
- "time": "A String", # Time of occurrence of the activity.
- },
- "ipAddress": "A String", # IP Address of the user doing the action.
- "events": [ # Activity events.
- {
- "eventType": "A String", # Type of event.
- "name": "A String", # Name of event.
- "parameters": [ # Event parameters.
- {
- "name": "A String", # Name of the parameter.
- "value": "A String", # Value of the parameter.
- },
- ],
- },
- ],
- },
- ],
- "kind": "audit#activities", # Kind of list response this is.
- "next": "A String", # Next page URL.
- }
-
Instance Methods
-
- activities()
-
-Returns the activities Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html
deleted file mode 100644
index f188188..0000000
--- a/docs/dyn/bigquery_v2.datasets.html
+++ /dev/null
@@ -1,406 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(projectId, datasetId, deleteContents=None)
-Deletes the dataset specified by datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.
-
- get(projectId, datasetId)
-Returns the dataset specified by datasetID.
-
- insert(projectId, body)
-Creates a new empty dataset.
-
- list(projectId, pageToken=None, maxResults=None)
-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.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(projectId, datasetId, body)
-Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset. This method supports patch semantics.
-
- update(projectId, datasetId, body)
-Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset.
-Method Details
-
-
delete(projectId, datasetId, deleteContents=None)
-
Deletes the dataset specified by datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.
-
-Args:
- projectId: string, Project ID of the dataset being deleted (required)
- datasetId: string, Dataset ID of dataset being deleted (required)
- 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
-
-
-
get(projectId, datasetId)
-
Returns the dataset specified by datasetID.
-
-Args:
- projectId: string, Project ID of the requested dataset (required)
- datasetId: string, Dataset ID of the requested dataset (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "bigquery#dataset", # [Output-only] The resource type.
- "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
- "datasetReference": { # [Required] Reference identifying dataset.
- "projectId": "A String", # [Optional] The ID of the container project.
- "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
- },
- "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
- "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
- # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
- # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
- # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
- # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
- {
- "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
- "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
- "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
- "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
- "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
- },
- ],
- "etag": "A String", # [Output-only] A hash of this resource.
- "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
- "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
- "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
- "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.
- }
-
-
insert(projectId, body)
-
Creates a new empty dataset.
-
-Args:
- projectId: string, Project ID of the new dataset (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "bigquery#dataset", # [Output-only] The resource type.
- "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
- "datasetReference": { # [Required] Reference identifying dataset.
- "projectId": "A String", # [Optional] The ID of the container project.
- "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
- },
- "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
- "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
- # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
- # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
- # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
- # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
- {
- "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
- "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
- "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
- "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
- "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
- },
- ],
- "etag": "A String", # [Output-only] A hash of this resource.
- "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
- "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
- "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
- "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.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "bigquery#dataset", # [Output-only] The resource type.
- "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
- "datasetReference": { # [Required] Reference identifying dataset.
- "projectId": "A String", # [Optional] The ID of the container project.
- "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
- },
- "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
- "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
- # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
- # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
- # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
- # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
- {
- "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
- "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
- "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
- "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
- "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
- },
- ],
- "etag": "A String", # [Output-only] A hash of this resource.
- "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
- "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
- "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
- "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.
- }
-
-
list(projectId, pageToken=None, maxResults=None)
-
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:
- projectId: string, Project ID of the datasets to be listed (required)
- 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
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token that can be used to request the next results page. This property is omitted on the final results page.
- "kind": "bigquery#datasetList", # The list type. This property always returns the value "bigquery#datasetList".
- "datasets": [ # An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.
- {
- "friendlyName": "A String", # A descriptive name for the dataset, if one exists.
- "kind": "bigquery#dataset", # The resource type. This property always returns the value "bigquery#dataset".
- "id": "A String", # The fully-qualified, unique, opaque ID of the dataset.
- "datasetReference": { # The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID.
- "projectId": "A String", # [Optional] The ID of the container project.
- "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
- },
- },
- ],
- "etag": "A String", # A hash value of the results page. You can use this property to determine if the page has changed since the last request.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(projectId, datasetId, body)
-
Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset. This method supports patch semantics.
-
-Args:
- projectId: string, Project ID of the dataset being updated (required)
- datasetId: string, Dataset ID of the dataset being updated (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "bigquery#dataset", # [Output-only] The resource type.
- "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
- "datasetReference": { # [Required] Reference identifying dataset.
- "projectId": "A String", # [Optional] The ID of the container project.
- "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
- },
- "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
- "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
- # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
- # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
- # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
- # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
- {
- "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
- "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
- "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
- "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
- "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
- },
- ],
- "etag": "A String", # [Output-only] A hash of this resource.
- "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
- "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
- "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
- "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.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "bigquery#dataset", # [Output-only] The resource type.
- "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
- "datasetReference": { # [Required] Reference identifying dataset.
- "projectId": "A String", # [Optional] The ID of the container project.
- "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
- },
- "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
- "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
- # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
- # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
- # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
- # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
- {
- "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
- "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
- "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
- "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
- "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
- },
- ],
- "etag": "A String", # [Output-only] A hash of this resource.
- "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
- "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
- "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
- "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.
- }
-
-
update(projectId, datasetId, body)
-
Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset.
-
-Args:
- projectId: string, Project ID of the dataset being updated (required)
- datasetId: string, Dataset ID of the dataset being updated (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "bigquery#dataset", # [Output-only] The resource type.
- "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
- "datasetReference": { # [Required] Reference identifying dataset.
- "projectId": "A String", # [Optional] The ID of the container project.
- "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
- },
- "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
- "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
- # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
- # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
- # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
- # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
- {
- "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
- "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
- "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
- "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
- "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
- },
- ],
- "etag": "A String", # [Output-only] A hash of this resource.
- "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
- "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
- "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
- "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.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "bigquery#dataset", # [Output-only] The resource type.
- "description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
- "datasetReference": { # [Required] Reference identifying dataset.
- "projectId": "A String", # [Optional] The ID of the container project.
- "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
- },
- "creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
- "access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
- # Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READER - Project readers WRITER - Project writers
- # See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
- # To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
- # Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
- {
- "specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
- "domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
- "role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER - User can call any list() or get() method on any collection or resource. WRITER - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
- "groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
- "userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
- },
- ],
- "etag": "A String", # [Output-only] A hash of this resource.
- "friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
- "lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
- "id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
- "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.
- }
-
Instance Methods
-
- datasets()
-
-Returns the datasets Resource.
-
-
- jobs()
-
-Returns the jobs Resource.
-
-
- projects()
-
-Returns the projects Resource.
-
-
- tabledata()
-
-Returns the tabledata Resource.
-
-
- tables()
-
-Returns the tables Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html
deleted file mode 100644
index e252020..0000000
--- a/docs/dyn/bigquery_v2.jobs.html
+++ /dev/null
@@ -1,834 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(projectId, jobId)
-Retrieves the specified job by ID.
-
- getQueryResults(projectId, jobId, timeoutMs=None, pageToken=None, maxResults=None, startIndex=None)
-Retrieves the results of a query job.
-
- insert(projectId, body=None, media_body=None)
-Starts a new asynchronous job.
-
- list(projectId, projection=None, stateFilter=None, pageToken=None, allUsers=None, maxResults=None)
-Lists all the Jobs in the specified project that were started by the user.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- query(projectId, body)
-Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.
-Method Details
-
-
get(projectId, jobId)
-
Retrieves the specified job by ID.
-
-Args:
- projectId: string, Project ID of the requested job (required)
- jobId: string, Job ID of the requested job (required)
-
-Returns:
- An object of the form:
-
- {
- "status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- "state": "A String", # [Output-only] Running state of the job.
- "errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
- {
- "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
- "message": "A String", # A human-readable description of the error.
- "reason": "A String", # A short error code that summarizes the error.
- "location": "A String", # Specifies where the error occurred, if present.
- },
- ],
- "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
- "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
- "message": "A String", # A human-readable description of the error.
- "reason": "A String", # A short error code that summarizes the error.
- "location": "A String", # Specifies where the error occurred, if present.
- },
- },
- "kind": "bigquery#job", # [Output-only] The type of the resource.
- "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
- "load": { # [Output-only] Statistics for a load job.
- "outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
- "inputFiles": "A String", # [Output-only] Number of source files in a load job.
- "inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a joad job.
- "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
- },
- "query": { # [Output-only] Statistics for a query job.
- "completionRatio": 3.14, # [Output-Only] Approximate fraction of data processed for this query. This will be 1.0 unless min_completion_ratio for the query was set to something other than 1.0.
- "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
- "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
- },
- "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
- "totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
- "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.
- },
- "jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
- "projectId": "A String", # [Required] Project ID being billed for the job.
- "jobId": "A String", # [Required] ID of the job.
- },
- "etag": "A String", # [Output-only] A hash of this resource.
- "configuration": { # [Required] Describes the job configuration.
- "load": { # [Pick one] Configures a load job.
- "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- "sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
- "destinationTable": { # [Required] The destination table to load the data into.
- "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.
- },
- "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
- "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
- "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
- "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- "sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
- "A String",
- ],
- "quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
- "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- "allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- },
- "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- "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": [ # [Required] URI of source table to link.
- "A String",
- ],
- },
- "query": { # [Pick one] Configures a query job.
- "useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
- "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.
- },
- "priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
- "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.
- "allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
- "query": "A String", # [Required] BigQuery SQL query to execute.
- "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.
- "minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
- "preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
- },
- "copy": { # [Pick one] Copies a table.
- "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
- "writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.
- "destinationTable": { # [Required] The destination table
- "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.
- },
- "sourceTable": { # [Required] Source table to copy.
- "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.
- },
- },
- "extract": { # [Pick one] Configures an extract job.
- "destinationFormat": "A String", # [Experimental] Optional and defaults to CSV. Format with which files should be exported. To export to CSV, specify "CSV". Tables with nested or repeated fields cannot be exported as CSV. To export to newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
- "destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- "printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
- "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.
- },
- "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
- },
- },
- "id": "A String", # [Output-only] Opaque ID field of the job
- "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
- }
-
-
getQueryResults(projectId, jobId, timeoutMs=None, pageToken=None, maxResults=None, startIndex=None)
-
Retrieves the results of a query job.
-
-Args:
- projectId: string, Project ID of the query job (required)
- jobId: string, Job ID of the query job (required)
- 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
- pageToken: string, Page token, returned by a previous call, to request the next page of results
- maxResults: integer, Maximum number of results to read
- startIndex: string, Zero-based index of the starting row
-
-Returns:
- An object of the form:
-
- {
- "kind": "bigquery#getQueryResultsResponse", # The resource type of the response.
- "rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.
- { # Represents a single row in the result set, consisting of one or more fields.
- "f": [
- { # Represents a single cell in the result set. Users of the java client can detect whether their value result is null by calling 'com.google.api.client.util.Data.isNull(cell.getV())'.
- "v": "",
- },
- ],
- },
- ],
- "jobReference": { # Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
- "projectId": "A String", # [Required] Project ID being billed for the job.
- "jobId": "A String", # [Required] ID of the job.
- },
- "pageToken": "A String", # A token used for paging results.
- "jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
- "totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.
- "cacheHit": True or False, # Whether the query result was fetched from the query cache.
- "etag": "A String", # A hash of this response.
- "schema": { # The schema of the results. Present only when the query completes successfully.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- }
-
-
insert(projectId, body=None, media_body=None)
-
Starts a new asynchronous job.
-
-Args:
- projectId: string, Project ID of the project that will be billed for the job (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- "state": "A String", # [Output-only] Running state of the job.
- "errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
- {
- "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
- "message": "A String", # A human-readable description of the error.
- "reason": "A String", # A short error code that summarizes the error.
- "location": "A String", # Specifies where the error occurred, if present.
- },
- ],
- "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
- "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
- "message": "A String", # A human-readable description of the error.
- "reason": "A String", # A short error code that summarizes the error.
- "location": "A String", # Specifies where the error occurred, if present.
- },
- },
- "kind": "bigquery#job", # [Output-only] The type of the resource.
- "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
- "load": { # [Output-only] Statistics for a load job.
- "outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
- "inputFiles": "A String", # [Output-only] Number of source files in a load job.
- "inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a joad job.
- "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
- },
- "query": { # [Output-only] Statistics for a query job.
- "completionRatio": 3.14, # [Output-Only] Approximate fraction of data processed for this query. This will be 1.0 unless min_completion_ratio for the query was set to something other than 1.0.
- "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
- "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
- },
- "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
- "totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
- "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.
- },
- "jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
- "projectId": "A String", # [Required] Project ID being billed for the job.
- "jobId": "A String", # [Required] ID of the job.
- },
- "etag": "A String", # [Output-only] A hash of this resource.
- "configuration": { # [Required] Describes the job configuration.
- "load": { # [Pick one] Configures a load job.
- "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- "sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
- "destinationTable": { # [Required] The destination table to load the data into.
- "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.
- },
- "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
- "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
- "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
- "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- "sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
- "A String",
- ],
- "quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
- "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- "allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- },
- "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- "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": [ # [Required] URI of source table to link.
- "A String",
- ],
- },
- "query": { # [Pick one] Configures a query job.
- "useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
- "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.
- },
- "priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
- "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.
- "allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
- "query": "A String", # [Required] BigQuery SQL query to execute.
- "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.
- "minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
- "preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
- },
- "copy": { # [Pick one] Copies a table.
- "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
- "writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.
- "destinationTable": { # [Required] The destination table
- "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.
- },
- "sourceTable": { # [Required] Source table to copy.
- "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.
- },
- },
- "extract": { # [Pick one] Configures an extract job.
- "destinationFormat": "A String", # [Experimental] Optional and defaults to CSV. Format with which files should be exported. To export to CSV, specify "CSV". Tables with nested or repeated fields cannot be exported as CSV. To export to newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
- "destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- "printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
- "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.
- },
- "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
- },
- },
- "id": "A String", # [Output-only] Opaque ID field of the job
- "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
- }
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
-
-Returns:
- An object of the form:
-
- {
- "status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- "state": "A String", # [Output-only] Running state of the job.
- "errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
- {
- "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
- "message": "A String", # A human-readable description of the error.
- "reason": "A String", # A short error code that summarizes the error.
- "location": "A String", # Specifies where the error occurred, if present.
- },
- ],
- "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
- "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
- "message": "A String", # A human-readable description of the error.
- "reason": "A String", # A short error code that summarizes the error.
- "location": "A String", # Specifies where the error occurred, if present.
- },
- },
- "kind": "bigquery#job", # [Output-only] The type of the resource.
- "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
- "load": { # [Output-only] Statistics for a load job.
- "outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
- "inputFiles": "A String", # [Output-only] Number of source files in a load job.
- "inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a joad job.
- "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
- },
- "query": { # [Output-only] Statistics for a query job.
- "completionRatio": 3.14, # [Output-Only] Approximate fraction of data processed for this query. This will be 1.0 unless min_completion_ratio for the query was set to something other than 1.0.
- "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
- "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
- },
- "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
- "totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
- "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.
- },
- "jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
- "projectId": "A String", # [Required] Project ID being billed for the job.
- "jobId": "A String", # [Required] ID of the job.
- },
- "etag": "A String", # [Output-only] A hash of this resource.
- "configuration": { # [Required] Describes the job configuration.
- "load": { # [Pick one] Configures a load job.
- "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- "sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
- "destinationTable": { # [Required] The destination table to load the data into.
- "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.
- },
- "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
- "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
- "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
- "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- "sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
- "A String",
- ],
- "quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
- "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- "allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- },
- "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- "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": [ # [Required] URI of source table to link.
- "A String",
- ],
- },
- "query": { # [Pick one] Configures a query job.
- "useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
- "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.
- },
- "priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
- "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.
- "allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
- "query": "A String", # [Required] BigQuery SQL query to execute.
- "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.
- "minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
- "preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
- },
- "copy": { # [Pick one] Copies a table.
- "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
- "writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.
- "destinationTable": { # [Required] The destination table
- "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.
- },
- "sourceTable": { # [Required] Source table to copy.
- "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.
- },
- },
- "extract": { # [Pick one] Configures an extract job.
- "destinationFormat": "A String", # [Experimental] Optional and defaults to CSV. Format with which files should be exported. To export to CSV, specify "CSV". Tables with nested or repeated fields cannot be exported as CSV. To export to newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
- "destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- "printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
- "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.
- },
- "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
- },
- },
- "id": "A String", # [Output-only] Opaque ID field of the job
- "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
- }
-
-
list(projectId, projection=None, stateFilter=None, pageToken=None, allUsers=None, maxResults=None)
-
Lists all the Jobs in the specified project that were started by the user.
-
-Args:
- projectId: string, Project ID of the jobs to list (required)
- projection: string, Restrict information returned to a set of selected fields
- Allowed values
- full - Includes all job data
- minimal - Does not include the job configuration
- stateFilter: string, Filter for job state (repeated)
- Allowed values
- done - Finished jobs
- pending - Pending jobs
- running - Running jobs
- pageToken: string, Page token, returned by a previous call, to request the next page of results
- allUsers: boolean, Whether to display jobs owned by all users in the project. Default false
- maxResults: integer, Maximum number of results to return
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token to request the next page of results.
- "totalItems": 42, # Total number of jobs in this collection.
- "kind": "bigquery#jobList", # The resource type of the response.
- "etag": "A String", # A hash of this page of results.
- "jobs": [ # List of jobs that were requested.
- {
- "status": { # [Full-projection-only] Describes the state of the job.
- "state": "A String", # [Output-only] Running state of the job.
- "errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
- {
- "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
- "message": "A String", # A human-readable description of the error.
- "reason": "A String", # A short error code that summarizes the error.
- "location": "A String", # Specifies where the error occurred, if present.
- },
- ],
- "errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
- "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
- "message": "A String", # A human-readable description of the error.
- "reason": "A String", # A short error code that summarizes the error.
- "location": "A String", # Specifies where the error occurred, if present.
- },
- },
- "kind": "bigquery#job", # The resource type.
- "statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
- "load": { # [Output-only] Statistics for a load job.
- "outputRows": "A String", # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
- "inputFiles": "A String", # [Output-only] Number of source files in a load job.
- "inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a joad job.
- "outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while an import job is in the running state, this value may change.
- },
- "query": { # [Output-only] Statistics for a query job.
- "completionRatio": 3.14, # [Output-Only] Approximate fraction of data processed for this query. This will be 1.0 unless min_completion_ratio for the query was set to something other than 1.0.
- "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
- "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
- },
- "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
- "totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
- "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.
- },
- "jobReference": { # Job reference uniquely identifying the job.
- "projectId": "A String", # [Required] Project ID being billed for the job.
- "jobId": "A String", # [Required] ID of the job.
- },
- "state": "A String", # Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.
- "configuration": { # [Full-projection-only] Specifies the job configuration.
- "load": { # [Pick one] Configures a load job.
- "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- "sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.
- "destinationTable": { # [Required] The destination table to load the data into.
- "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.
- },
- "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion.
- "maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an 'invalid' error is returned in the job result and the job fails. The default value is 0, which requires that all records are valid.
- "allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats.
- "skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- "sourceUris": [ # [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
- "A String",
- ],
- "quote": "A String", # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
- "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- "allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- },
- "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- "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": [ # [Required] URI of source table to link.
- "A String",
- ],
- },
- "query": { # [Pick one] Configures a query job.
- "useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
- "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.
- },
- "priority": "A String", # [Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.
- "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.
- "allowLargeResults": True or False, # [Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set.
- "query": "A String", # [Required] BigQuery SQL query to execute.
- "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.
- "minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
- "preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
- },
- "copy": { # [Pick one] Copies a table.
- "createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
- "writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.
- "destinationTable": { # [Required] The destination table
- "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.
- },
- "sourceTable": { # [Required] Source table to copy.
- "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.
- },
- },
- "extract": { # [Pick one] Configures an extract job.
- "destinationFormat": "A String", # [Experimental] Optional and defaults to CSV. Format with which files should be exported. To export to CSV, specify "CSV". Tables with nested or repeated fields cannot be exported as CSV. To export to newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON".
- "destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- "printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
- "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.
- },
- "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
- },
- },
- "id": "A String", # Unique opaque ID of the job.
- "errorResult": { # A result object that will be present only if the job has failed.
- "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
- "message": "A String", # A human-readable description of the error.
- "reason": "A String", # A short error code that summarizes the error.
- "location": "A String", # Specifies where the error occurred, if present.
- },
- },
- ],
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
query(projectId, body)
-
Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.
-
-Args:
- projectId: string, Project ID of the project billed for the query (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "timeoutMs": 42, # [Optional] 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.
- "kind": "bigquery#queryRequest", # The resource type of the request.
- "dryRun": True or False, # [Optional] If set, don't actually run the query. A valid query will return an empty response, while an invalid query will return the same error it would if it wasn't a dry run.
- "useQueryCache": True or False, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified.
- "defaultDataset": { # [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be fully-qualified in the format projectId:datasetId.tableid.
- "projectId": "A String", # [Optional] The ID of the container project.
- "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
- },
- "maxResults": 42, # [Optional] The maximum number of results to return per page of results. If the response list exceeds the maximum response size for a single response, you will have to page through the results. Default is to return the maximum response size.
- "query": "A String", # [Required] A query string, following the BigQuery query syntax of the query to execute. Table names should be qualified by dataset name in the format projectId:datasetId.tableId unless you specify the defaultDataset value. If the table is in the same project as the job, you can omit the project ID. Example: SELECT f1 FROM myProjectId:myDatasetId.myTableId.
- "minCompletionRatio": 3.14, # [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0.
- "preserveNulls": True or False, # [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "bigquery#queryResponse", # The resource type.
- "rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.
- { # Represents a single row in the result set, consisting of one or more fields.
- "f": [
- { # Represents a single cell in the result set. Users of the java client can detect whether their value result is null by calling 'com.google.api.client.util.Data.isNull(cell.getV())'.
- "v": "",
- },
- ],
- },
- ],
- "jobReference": { # Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
- "projectId": "A String", # [Required] Project ID being billed for the job.
- "jobId": "A String", # [Required] ID of the job.
- },
- "pageToken": "A String", # A token used for paging results.
- "jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
- "totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.
- "totalBytesProcessed": "A String", # The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.
- "cacheHit": True or False, # Whether the query result was fetched from the query cache.
- "schema": { # The schema of the results. Present only when the query completes successfully.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- }
-
Instance Methods
-
- list(pageToken=None, maxResults=None)
-Lists the projects to which you have at least read access.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(pageToken=None, maxResults=None)
-
Lists the projects to which you have at least read access.
-
-Args:
- pageToken: string, Page token, returned by a previous call, to request the next page of results
- maxResults: integer, Maximum number of results to return
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token to request the next page of results.
- "totalItems": 42, # The total number of projects in the list.
- "kind": "bigquery#projectList", # The type of list.
- "etag": "A String", # A hash of the page of results
- "projects": [ # Projects to which you have at least READ access.
- {
- "friendlyName": "A String", # A descriptive name for this project.
- "kind": "bigquery#project", # The resource type.
- "numericId": "A String", # The numeric ID of this project.
- "id": "A String", # An opaque ID of this project.
- "projectReference": { # A unique reference to this project.
- "projectId": "A String", # [Required] ID of the project. Can be either the numeric ID or the assigned ID of the project.
- },
- },
- ],
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(projectId, datasetId, tableId, pageToken=None, maxResults=None, startIndex=None)
-Retrieves table data from a specified set of rows.
-Method Details
-
-
list(projectId, datasetId, tableId, pageToken=None, maxResults=None, startIndex=None)
-
Retrieves table data from a specified set of rows.
-
-Args:
- projectId: string, Project ID of the table to read (required)
- datasetId: string, Dataset ID of the table to read (required)
- tableId: string, Table ID of the table to read (required)
- pageToken: string, Page token, returned by a previous call, identifying the result set
- maxResults: integer, Maximum number of results to return
- startIndex: string, Zero-based index of the starting row to read
-
-Returns:
- An object of the form:
-
- {
- "pageToken": "A String", # A token used for paging results. Providing this token instead of the startRow parameter can help you retrieve stable results when an underlying table is changing.
- "kind": "bigquery#tableDataList", # The resource type of the response.
- "etag": "A String", # A hash of this page of results.
- "rows": [ # Rows of results.
- { # Represents a single row in the result set, consisting of one or more fields.
- "f": [
- { # Represents a single cell in the result set. Users of the java client can detect whether their value result is null by calling 'com.google.api.client.util.Data.isNull(cell.getV())'.
- "v": "",
- },
- ],
- },
- ],
- "totalRows": "A String", # The total number of rows in the complete table.
- }
-
Instance Methods
-
- delete(projectId, datasetId, tableId)
-Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.
-
- get(projectId, datasetId, tableId)
-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.
-
- insert(projectId, datasetId, body)
-Creates a new, empty table in the dataset.
-
- list(projectId, datasetId, pageToken=None, maxResults=None)
-Lists all tables in the specified dataset.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(projectId, datasetId, tableId, body)
-Updates information in an existing table, specified by tableId. This method supports patch semantics.
-
- update(projectId, datasetId, tableId, body)
-Updates information in an existing table, specified by tableId.
-Method Details
-
-
delete(projectId, datasetId, tableId)
-
Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.
-
-Args:
- projectId: string, Project ID of the table to delete (required)
- datasetId: string, Dataset ID of the table to delete (required)
- tableId: string, Table ID of the table to delete (required)
-
-
-
get(projectId, datasetId, tableId)
-
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:
- projectId: string, Project ID of the requested table (required)
- datasetId: string, Dataset ID of the requested table (required)
- tableId: string, Table ID of the requested table (required)
-
-Returns:
- An object of the form:
-
- {
- "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.
- "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.
- },
- "numRows": "A String", # [Output-only] The number of rows of data in this table.
- "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.
- "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.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- }
-
-
insert(projectId, datasetId, body)
-
Creates a new, empty table in the dataset.
-
-Args:
- projectId: string, Project ID of the new table (required)
- datasetId: string, Dataset ID of the new table (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "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.
- "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.
- },
- "numRows": "A String", # [Output-only] The number of rows of data in this table.
- "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.
- "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.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "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.
- "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.
- },
- "numRows": "A String", # [Output-only] The number of rows of data in this table.
- "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.
- "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.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- }
-
-
list(projectId, datasetId, pageToken=None, maxResults=None)
-
Lists all tables in the specified dataset.
-
-Args:
- projectId: string, Project ID of the tables to list (required)
- datasetId: string, Dataset ID of the tables to list (required)
- pageToken: string, Page token, returned by a previous call, to request the next page of results
- maxResults: integer, Maximum number of results to return
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token to request the next page of results.
- "tables": [ # Tables in the requested dataset.
- {
- "friendlyName": "A String", # The user-friendly name for this table.
- "kind": "bigquery#table", # The resource type.
- "id": "A String", # An opaque ID of the table
- "tableReference": { # A reference uniquely identifying the table.
- "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.
- },
- },
- ],
- "kind": "bigquery#tableList", # The type of list.
- "etag": "A String", # A hash of this page of results.
- "totalItems": 42, # The total number of tables in the dataset.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(projectId, datasetId, tableId, body)
-
Updates information in an existing table, specified by tableId. This method supports patch semantics.
-
-Args:
- projectId: string, Project ID of the table to update (required)
- datasetId: string, Dataset ID of the table to update (required)
- tableId: string, Table ID of the table to update (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "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.
- "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.
- },
- "numRows": "A String", # [Output-only] The number of rows of data in this table.
- "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.
- "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.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "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.
- "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.
- },
- "numRows": "A String", # [Output-only] The number of rows of data in this table.
- "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.
- "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.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- }
-
-
update(projectId, datasetId, tableId, body)
-
Updates information in an existing table, specified by tableId.
-
-Args:
- projectId: string, Project ID of the table to update (required)
- datasetId: string, Dataset ID of the table to update (required)
- tableId: string, Table ID of the table to update (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "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.
- "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.
- },
- "numRows": "A String", # [Output-only] The number of rows of data in this table.
- "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.
- "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.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "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.
- "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.
- },
- "numRows": "A String", # [Output-only] The number of rows of data in this table.
- "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.
- "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.
- "fields": [ # Describes the fields in a table.
- {
- "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
- # Object with schema name: TableFieldSchema
- ],
- "type": "A String", # [Required] The field data type. Possible values include STRING, INTEGER, FLOAT, BOOLEAN, TIMESTAMP or RECORD (where RECORD indicates that the field contains a nested schema).
- "mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- "name": "A String", # [Required] The field name.
- },
- ],
- },
- }
-
Instance Methods
-
- get(userId, blogId, maxPosts=None)
-Gets one blog and user info pair by blogId and userId.
-Method Details
-
-
get(userId, blogId, maxPosts=None)
-
Gets one blog and user info pair by blogId and userId.
-
-Args:
- 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)
- blogId: string, The ID of the blog to get. (required)
- maxPosts: integer, Maximum number of posts to pull back with the blog.
-
-Returns:
- An object of the form:
-
- {
- "blog": {
- "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
- "description": "A String", # The description of this blog. This is displayed underneath the title.
- "locale": { # The locale this Blog is set to.
- "country": "A String", # The country this blog's locale is set to.
- "variant": "A String", # The language variant this blog is authored in.
- "language": "A String", # The language this blog is authored in.
- },
- "posts": { # The container of posts in this blog.
- "totalItems": 42, # The count of posts in this blog.
- "items": [ # The List of Posts for this Blog.
- {
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the container for posts in this blog.
- },
- "customMetaData": "A String", # The JSON custom meta-data for the Blog
- "updated": "A String", # RFC 3339 date-time when this blog was last updated.
- "pages": { # The container of pages in this blog.
- "totalItems": 42, # The count of pages in this blog.
- "selfLink": "A String", # The URL of the container for pages in this blog.
- },
- "url": "A String", # The URL where this blog is published.
- "published": "A String", # RFC 3339 date-time when this blog was published.
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- "name": "A String", # The name of this blog. This is displayed as the title.
- },
- "kind": "blogger#blogUserInfo",
- "user": {
- "kind": "blogger#blogPerUserInfo",
- "userId": "A String",
- "blogId": "A String",
- "photosAlbumKey": "A String",
- },
- }
-
Instance Methods
-
- get(blogId, maxPosts=None)
-Gets one blog by id.
-
- getByUrl(url)
-Retrieve a Blog by URL.
-
- listByUser(userId)
-Retrieves a list of blogs, possibly filtered.
-Method Details
-
-
get(blogId, maxPosts=None)
-
Gets one blog by id.
-
-Args:
- blogId: string, The ID of the blog to get. (required)
- maxPosts: integer, Maximum number of posts to pull back with the blog.
-
-Returns:
- An object of the form:
-
- {
- "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
- "description": "A String", # The description of this blog. This is displayed underneath the title.
- "locale": { # The locale this Blog is set to.
- "country": "A String", # The country this blog's locale is set to.
- "variant": "A String", # The language variant this blog is authored in.
- "language": "A String", # The language this blog is authored in.
- },
- "posts": { # The container of posts in this blog.
- "totalItems": 42, # The count of posts in this blog.
- "items": [ # The List of Posts for this Blog.
- {
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the container for posts in this blog.
- },
- "customMetaData": "A String", # The JSON custom meta-data for the Blog
- "updated": "A String", # RFC 3339 date-time when this blog was last updated.
- "pages": { # The container of pages in this blog.
- "totalItems": 42, # The count of pages in this blog.
- "selfLink": "A String", # The URL of the container for pages in this blog.
- },
- "url": "A String", # The URL where this blog is published.
- "published": "A String", # RFC 3339 date-time when this blog was published.
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- "name": "A String", # The name of this blog. This is displayed as the title.
- }
-
-
getByUrl(url)
-
Retrieve a Blog by URL.
-
-Args:
- url: string, The URL of the blog to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
- "description": "A String", # The description of this blog. This is displayed underneath the title.
- "locale": { # The locale this Blog is set to.
- "country": "A String", # The country this blog's locale is set to.
- "variant": "A String", # The language variant this blog is authored in.
- "language": "A String", # The language this blog is authored in.
- },
- "posts": { # The container of posts in this blog.
- "totalItems": 42, # The count of posts in this blog.
- "items": [ # The List of Posts for this Blog.
- {
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the container for posts in this blog.
- },
- "customMetaData": "A String", # The JSON custom meta-data for the Blog
- "updated": "A String", # RFC 3339 date-time when this blog was last updated.
- "pages": { # The container of pages in this blog.
- "totalItems": 42, # The count of pages in this blog.
- "selfLink": "A String", # The URL of the container for pages in this blog.
- },
- "url": "A String", # The URL where this blog is published.
- "published": "A String", # RFC 3339 date-time when this blog was published.
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- "name": "A String", # The name of this blog. This is displayed as the title.
- }
-
-
listByUser(userId)
-
Retrieves a list of blogs, possibly filtered.
-
-Args:
- 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)
-
-Returns:
- An object of the form:
-
- {
- "items": [ # The list of Blogs this user has Authorship or Admin rights over.
- {
- "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
- "description": "A String", # The description of this blog. This is displayed underneath the title.
- "locale": { # The locale this Blog is set to.
- "country": "A String", # The country this blog's locale is set to.
- "variant": "A String", # The language variant this blog is authored in.
- "language": "A String", # The language this blog is authored in.
- },
- "posts": { # The container of posts in this blog.
- "totalItems": 42, # The count of posts in this blog.
- "items": [ # The List of Posts for this Blog.
- {
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the container for posts in this blog.
- },
- "customMetaData": "A String", # The JSON custom meta-data for the Blog
- "updated": "A String", # RFC 3339 date-time when this blog was last updated.
- "pages": { # The container of pages in this blog.
- "totalItems": 42, # The count of pages in this blog.
- "selfLink": "A String", # The URL of the container for pages in this blog.
- },
- "url": "A String", # The URL where this blog is published.
- "published": "A String", # RFC 3339 date-time when this blog was published.
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- "name": "A String", # The name of this blog. This is displayed as the title.
- },
- ],
- "kind": "blogger#blogList", # The kind of this entity. Always blogger#blogList
- }
-
Instance Methods
-
- get(blogId, postId, commentId)
-Gets one comment by id.
-
- list(blogId, postId, startDate=None, fetchBodies=None, endDate=None, pageToken=None, maxResults=None)
-Retrieves the comments for a blog, possibly filtered.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(blogId, postId, commentId)
-
Gets one comment by id.
-
-Args:
- blogId: string, ID of the blog to containing the comment. (required)
- postId: string, ID of the post to fetch posts from. (required)
- commentId: string, The ID of the comment to get. (required)
-
-Returns:
- An object of the form:
-
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- }
-
-
list(blogId, postId, startDate=None, fetchBodies=None, endDate=None, pageToken=None, maxResults=None)
-
Retrieves the comments for a blog, possibly filtered.
-
-Args:
- blogId: string, ID of the blog to fetch comments from. (required)
- postId: string, ID of the post to fetch posts from. (required)
- startDate: string, Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
- fetchBodies: boolean, Whether the body content of the comments is included.
- endDate: string, Latest date of comment to fetch, a date-time with RFC 3339 formatting.
- pageToken: string, Continuation token if request is paged.
- maxResults: integer, Maximum number of comments to include in the result.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
- "items": [ # The List of Comments for a Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
- "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- blogUserInfos()
-
-Returns the blogUserInfos Resource.
-
-
- blogs()
-
-Returns the blogs Resource.
-
-
- comments()
-
-Returns the comments Resource.
-
-
- pages()
-
-Returns the pages Resource.
-
-
- posts()
-
-Returns the posts Resource.
-
-
- users()
-
-Returns the users Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/blogger_v3.pages.html b/docs/dyn/blogger_v3.pages.html
deleted file mode 100644
index cb588f1..0000000
--- a/docs/dyn/blogger_v3.pages.html
+++ /dev/null
@@ -1,157 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(blogId, pageId)
-Gets one blog page by id.
-
- list(blogId, fetchBodies=None)
-Retrieves pages for a blog, possibly filtered.
-Method Details
-
-
get(blogId, pageId)
-
Gets one blog page by id.
-
-Args:
- blogId: string, ID of the blog containing the page. (required)
- pageId: string, The ID of the page to get. (required)
-
-Returns:
- An object of the form:
-
- {
- "content": "A String", # The body content of this Page, in HTML.
- "kind": "blogger#page", # The kind of this entity. Always blogger#page
- "author": { # The author of this Page.
- "url": "A String", # The URL of the Page creator's Profile page.
- "image": { # The page author's avatar.
- "url": "A String", # The page author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Page creator.
- },
- "url": "A String", # The URL that this Page is displayed at.
- "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
- "updated": "A String", # RFC 3339 date-time when this Page was last updated.
- "blog": { # Data about the blog containing this Page.
- "id": "A String", # The identifier of the blog containing this page.
- },
- "published": "A String", # RFC 3339 date-time when this Page was published.
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- }
-
-
list(blogId, fetchBodies=None)
-
Retrieves pages for a blog, possibly filtered.
-
-Args:
- blogId: string, ID of the blog to fetch pages from. (required)
- fetchBodies: boolean, Whether to retrieve the Page bodies.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # The list of Pages for a Blog.
- {
- "content": "A String", # The body content of this Page, in HTML.
- "kind": "blogger#page", # The kind of this entity. Always blogger#page
- "author": { # The author of this Page.
- "url": "A String", # The URL of the Page creator's Profile page.
- "image": { # The page author's avatar.
- "url": "A String", # The page author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Page creator.
- },
- "url": "A String", # The URL that this Page is displayed at.
- "title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
- "updated": "A String", # RFC 3339 date-time when this Page was last updated.
- "blog": { # Data about the blog containing this Page.
- "id": "A String", # The identifier of the blog containing this page.
- },
- "published": "A String", # RFC 3339 date-time when this Page was published.
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "kind": "blogger#pageList", # The kind of this entity. Always blogger#pageList
- }
-
Instance Methods
-
- delete(blogId, postId)
-Delete a post by id.
-
- get(blogId, postId, maxComments=None)
-Get a post by id.
-
- getByPath(blogId, path, maxComments=None)
-Retrieve a Post by Path.
-
- insert(blogId, body)
-Add a post.
-
- list(blogId, startDate=None, endDate=None, pageToken=None, labels=None, maxResults=None, fetchBodies=None)
-Retrieves a list of posts, possibly filtered.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(blogId, postId, body)
-Update a post. This method supports patch semantics.
-
- search(blogId, q)
-Search for a post.
-
- update(blogId, postId, body)
-Update a post.
-Method Details
-
-
delete(blogId, postId)
-
Delete a post by id.
-
-Args:
- blogId: string, The Id of the Blog. (required)
- postId: string, The ID of the Post. (required)
-
-
-
get(blogId, postId, maxComments=None)
-
Get a post by id.
-
-Args:
- blogId: string, ID of the blog to fetch the post from. (required)
- postId: string, The ID of the post (required)
- maxComments: integer, Maximum number of comments to pull back on a post.
-
-Returns:
- An object of the form:
-
- {
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- }
-
-
getByPath(blogId, path, maxComments=None)
-
Retrieve a Post by Path.
-
-Args:
- blogId: string, ID of the blog to fetch the post from. (required)
- path: string, Path of the Post to retrieve. (required)
- maxComments: integer, Maximum number of comments to pull back on a post.
-
-Returns:
- An object of the form:
-
- {
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- }
-
-
insert(blogId, body)
-
Add a post.
-
-Args:
- blogId: string, ID of the blog to add the post to. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
-}
-
-
-Returns:
- An object of the form:
-
- {
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- }
-
-
list(blogId, startDate=None, endDate=None, pageToken=None, labels=None, maxResults=None, fetchBodies=None)
-
Retrieves a list of posts, possibly filtered.
-
-Args:
- blogId: string, ID of the blog to fetch posts from. (required)
- startDate: string, Earliest post date to fetch, a date-time with RFC 3339 formatting.
- endDate: string, Latest post date to fetch, a date-time with RFC 3339 formatting.
- pageToken: string, Continuation token if the request is paged.
- labels: string, Comma-separated list of labels to search for.
- maxResults: integer, Maximum number of posts to fetch.
- fetchBodies: boolean, Whether the body content of posts is included.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
- "items": [ # The list of Posts for this Blog.
- {
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "kind": "blogger#postList", # The kind of this entity. Always blogger#postList
- "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(blogId, postId, body)
-
Update a post. This method supports patch semantics.
-
-Args:
- blogId: string, The ID of the Blog. (required)
- postId: string, The ID of the Post. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
-}
-
-
-Returns:
- An object of the form:
-
- {
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- }
-
-
search(blogId, q)
-
Search for a post.
-
-Args:
- blogId: string, ID of the blog to fetch the post from. (required)
- q: string, Query terms to search this blog for matching posts. (required)
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
- "items": [ # The list of Posts for this Blog.
- {
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "kind": "blogger#postList", # The kind of this entity. Always blogger#postList
- "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
- }
-
-
update(blogId, postId, body)
-
Update a post.
-
-Args:
- blogId: string, The ID of the Blog. (required)
- postId: string, The ID of the Post. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
-}
-
-
-Returns:
- An object of the form:
-
- {
- "content": "A String", # The content of the Post. May contain HTML markup.
- "kind": "blogger#post", # The kind of this entity. Always blogger#post
- "author": { # The author of this Post.
- "url": "A String", # The URL of the Post creator's Profile page.
- "image": { # The Post author's avatar.
- "url": "A String", # The Post author's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Post creator.
- },
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
- {
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
- },
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the Comment creator's Profile page.
- "image": { # The comment creator's avatar.
- "url": "A String", # The comment creator's avatar URL.
- },
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the Comment creator.
- },
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
- },
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- },
- ],
- "selfLink": "A String", # The URL of the comments on this post.
- },
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "url": "A String", # The URL where this Post is displayed.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
- },
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- }
-
Instance Methods
-
- get(userId)
-Gets one user by id.
-Method Details
-
-
get(userId)
-
Gets one user by id.
-
-Args:
- userId: string, The ID of the user to get. (required)
-
-Returns:
- An object of the form:
-
- {
- "about": "A String", # Profile summary information.
- "displayName": "A String", # The display name.
- "created": "A String", # The timestamp of when this profile was created, in seconds since epoch.
- "locale": { # This user's locale
- "country": "A String", # The user's country setting.
- "variant": "A String", # The user's language variant setting.
- "language": "A String", # The user's language setting.
- },
- "blogs": { # The container of blogs for this user.
- "selfLink": "A String", # The URL of the Blogs for this user.
- },
- "kind": "blogger#user", # The kind of this entity. Always blogger#user
- "url": "A String", # The user's profile page.
- "id": "A String", # The identifier for this User.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
- }
-
Instance Methods
-
- volumes()
-
-Returns the volumes Resource.
-
-
- get(userId, shelf, source=None)
-Retrieves metadata for a specific bookshelf for the specified user.
-
- list(userId, source=None)
-Retrieves a list of public bookshelves for the specified user.
-Method Details
-
-
get(userId, shelf, source=None)
-
Retrieves metadata for a specific bookshelf for the specified user.
-
-Args:
- userId: string, ID of user for whom to retrieve bookshelves. (required)
- shelf: string, ID of bookshelf to retrieve. (required)
- source: string, String to identify the originator of this request.
-
-Returns:
- An object of the form:
-
- {
- "kind": "books#bookshelf", # Resource type for bookshelf metadata.
- "description": "A String", # Description of this bookshelf.
- "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
- "volumeCount": 42, # Number of volumes in this bookshelf.
- "title": "A String", # Title of this bookshelf.
- "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
- "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
- "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
- "id": 42, # Id of this bookshelf, only unique by user.
- "selfLink": "A String", # URL to this resource.
- }
-
-
list(userId, source=None)
-
Retrieves a list of public bookshelves for the specified user.
-
-Args:
- userId: string, ID of user for whom to retrieve bookshelves. (required)
- source: string, String to identify the originator of this request.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # A list of bookshelves.
- {
- "kind": "books#bookshelf", # Resource type for bookshelf metadata.
- "description": "A String", # Description of this bookshelf.
- "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
- "volumeCount": 42, # Number of volumes in this bookshelf.
- "title": "A String", # Title of this bookshelf.
- "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
- "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
- "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
- "id": 42, # Id of this bookshelf, only unique by user.
- "selfLink": "A String", # URL to this resource.
- },
- ],
- "kind": "books#bookshelves", # Resource type.
- }
-
Instance Methods
-
- list(userId, shelf, source=None, showPreorders=None, maxResults=None, startIndex=None)
-Retrieves volumes in a specific bookshelf for the specified user.
-Method Details
-
-
list(userId, shelf, source=None, showPreorders=None, maxResults=None, startIndex=None)
-
Retrieves volumes in a specific bookshelf for the specified user.
-
-Args:
- userId: string, ID of user for whom to retrieve bookshelf volumes. (required)
- shelf: string, ID of bookshelf to retrieve volumes. (required)
- source: string, String to identify the originator of this request.
- showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.
- maxResults: integer, Maximum number of results to return
- startIndex: integer, Index of the first element to return (starts at 0)
-
-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).
- "offers": [ # Offers available for this volume (sales and rentals).
- {
- "rentalDuration": { # The rental duration (for rental offers only).
- "count": 3.14,
- "unit": "A String",
- },
- "retailPrice": { # Offer retail (=discounted) price in Micros
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "listPrice": { # Offer list (=undiscounted) price in Micros.
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
- },
- ],
- "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, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, 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)
- "selfLink": "A String", # URL to this resource. (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)
- },
- "recommendedInfo": { # Recommendation related information for this volume.
- "explanation": "A String", # A text explaining why this volume is recommended.
- },
- "id": "A String", # Unique identifier for a volume. (In LITE projection.)
- "layerInfo": { # What layers exist in this volume and high level information about them.
- "layers": [ # A layer should appear here if and only if the layer exists for this book.
- {
- "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
- "layerId": "A String", # The layer id of this layer (e.g. "geo").
- },
- ],
- },
- "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."
- "rentalPeriod": { # Period during this book is/was a valid rental.
- "startUtcSec": "A String",
- "endUtcSec": "A String",
- },
- "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).
- "userUploadedVolumeInfo": {
- "processingState": "A String",
- },
- "rentalState": "A String", # Whether this book is an active or an expired rental.
- "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
- "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
- "kind": "books#readingPosition", # Resource type for a reading position.
- "gbImagePosition": "A String", # Position in a volume for image-based content.
- "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
- "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
- "volumeId": "A String", # Volume id associated with this reading position.
- "pdfPosition": "A String", # Position in a PDF file.
- "gbTextPosition": "A String", # Position in a volume for text-based content.
- },
- "review": { # This user's review of this volume, if one exists.
- "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
- "kind": "books#review", # Resource type for a review.
- "author": { # Author of this review.
- "displayName": "A String", # Name of this person.
- },
- "title": "A String", # Title for this review.
- "volumeId": "A String", # Volume that this review is for.
- "content": "A String", # Review text.
- "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
- "extraDescription": "A String", # Extra text about the source of the review.
- "url": "A String", # URL of the source of the review.
- "description": "A String", # Name of the source.
- },
- "date": "A String", # Date of this review.
- "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
- "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
- },
- "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
- "copy": { # Copy/Paste accounting information.
- "limitType": "A String",
- "remainingCharacterCount": 42,
- "updated": "A String",
- "allowedCharacterCount": 42,
- },
- "isUploaded": True or False, # Whether or not this volume was user uploaded.
- },
- },
- ],
- "kind": "books#volumes", # Resource type.
- }
-
Instance Methods
-
- addBook(upload_client_token=None, name=None, drive_document_id=None, mime_type=None)
-
-
- deleteBook(volumeId)
-Remove the book and its contents
-
- updateBook(body)
-
-Method Details
-
-
addBook(upload_client_token=None, name=None, drive_document_id=None, mime_type=None)
-
-
-Args:
- upload_client_token: string, A parameter
- name: string, The document name. It can be set only if the drive_document_id is set.
- drive_document_id: string, A drive document id. The upload_client_token must not be set.
- mime_type: string, The document MIME type. It can be set only if the drive_document_id is set.
-
-Returns:
- An object of the form:
-
- {
- "title": "A String",
- "processingState": "A String",
- "volumeId": "A String",
- "author": "A String",
- }
-
-
deleteBook(volumeId)
-
Remove the book and its contents
-
-Args:
- volumeId: string, The id of the book to be removed. (required)
-
-
-
updateBook(body)
-
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "title": "A String",
- "processingState": "A String",
- "volumeId": "A String",
- "author": "A String",
-}
-
-
-Returns:
- An object of the form:
-
- {
- "title": "A String",
- "processingState": "A String",
- "volumeId": "A String",
- "author": "A String",
- }
-
Instance Methods
-
- bookshelves()
-
-Returns the bookshelves Resource.
-
-
- cloudloading()
-
-Returns the cloudloading Resource.
-
-
- layers()
-
-Returns the layers Resource.
-
-
- myconfig()
-
-Returns the myconfig Resource.
-
-
- mylibrary()
-
-Returns the mylibrary Resource.
-
-
- volumes()
-
-Returns the volumes Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/books_v1.layers.annotationData.html b/docs/dyn/books_v1.layers.annotationData.html
deleted file mode 100644
index e0772aa..0000000
--- a/docs/dyn/books_v1.layers.annotationData.html
+++ /dev/null
@@ -1,174 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(volumeId, layerId, annotationDataId, contentVersion, scale=None, source=None, locale=None, h=None, w=None)
-Gets the annotation data.
-
- list(volumeId, layerId, contentVersion, locale=None, scale=None, pageToken=None, updatedMin=None, source=None, updatedMax=None, maxResults=None, annotationDataId=None, w=None, h=None)
-Gets the annotation data for a volume and layer.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(volumeId, layerId, annotationDataId, contentVersion, scale=None, source=None, locale=None, h=None, w=None)
-
Gets the annotation data.
-
-Args:
- volumeId: string, The volume to retrieve annotations for. (required)
- layerId: string, The ID for the layer to get the annotations. (required)
- annotationDataId: string, The ID of the annotation data to retrieve. (required)
- contentVersion: string, The content version for the volume you are trying to retrieve. (required)
- scale: integer, The requested scale for the image.
- 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'.
- 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.
-
-Returns:
- An object of the form:
-
- {
- "annotationType": "A String", # The type of annotation this data is for.
- "kind": "books#annotationdata", # Resource Type
- "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
- "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": "",
- "id": "A String", # Unique id for this annotation data.
- "selfLink": "A String", # URL for this resource. *
- }
-
-
list(volumeId, layerId, contentVersion, locale=None, scale=None, pageToken=None, updatedMin=None, source=None, updatedMax=None, maxResults=None, annotationDataId=None, w=None, h=None)
-
Gets the annotation data for a volume and layer.
-
-Args:
- volumeId: string, The volume to retrieve annotation data for. (required)
- layerId: string, The ID for the layer to get the annotation data. (required)
- contentVersion: string, The content version for the requested volume. (required)
- locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
- scale: integer, The requested scale for the image.
- 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.
- updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
- 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)
- w: integer, The requested pixel width for any images. If width is provided height must also be provided.
- h: integer, The requested pixel height for any images. If height is provided width must also be provided.
-
-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 Annotation Data.
- {
- "annotationType": "A String", # The type of annotation this data is for.
- "kind": "books#annotationdata", # Resource Type
- "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
- "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": "",
- "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(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- annotationData()
-
-Returns the annotationData Resource.
-
-
- volumeAnnotations()
-
-Returns the volumeAnnotations Resource.
-
-
- get(volumeId, summaryId, source=None, contentVersion=None)
-Gets the layer summary for a volume.
-
- list(volumeId, pageToken=None, maxResults=None, source=None, contentVersion=None)
-List the layer summaries for a volume.
-Method Details
-
-
get(volumeId, summaryId, source=None, contentVersion=None)
-
Gets the layer summary for a volume.
-
-Args:
- volumeId: string, The volume to retrieve layers for. (required)
- summaryId: string, The ID for the layer to get the summary for. (required)
- source: string, String to identify the originator of this request.
- contentVersion: string, The content version for the requested volume.
-
-Returns:
- An object of the form:
-
- {
- "kind": "books#layersummary", # Resource Type
- "annotationCount": 42, # The number of annotations for this layer.
- "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).
- "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.
- "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
- "annotationsDataLink": "A String", # Link to get data for this annotation.
- "selfLink": "A String", # URL to this resource.
- }
-
-
list(volumeId, pageToken=None, maxResults=None, source=None, contentVersion=None)
-
List the layer summaries for a volume.
-
-Args:
- volumeId: string, The volume to retrieve layers for. (required)
- pageToken: string, The value of the nextToken from the previous page.
- maxResults: integer, Maximum number of results to return
- source: string, String to identify the originator of this request.
- contentVersion: string, The content version for the requested volume.
-
-Returns:
- An object of the form:
-
- {
- "totalItems": 42, # The total number of layer summaries found.
- "items": [ # A list of layer summary items.
- {
- "kind": "books#layersummary", # Resource Type
- "annotationCount": 42, # The number of annotations for this layer.
- "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).
- "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.
- "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
- "annotationsDataLink": "A String", # Link to get data for this annotation.
- "selfLink": "A String", # URL to this resource.
- },
- ],
- "kind": "books#layersummaries", # Resource type.
- }
-
Instance Methods
-
- get(volumeId, layerId, annotationId, source=None, locale=None)
-Gets the volume annotation.
-
- list(volumeId, layerId, contentVersion, endPosition=None, locale=None, startOffset=None, volumeAnnotationsVersion=None, pageToken=None, updatedMin=None, endOffset=None, showDeleted=None, updatedMax=None, maxResults=None, startPosition=None, source=None)
-Gets the volume annotations for a volume and layer.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(volumeId, layerId, annotationId, source=None, locale=None)
-
Gets the volume annotation.
-
-Args:
- volumeId: string, The volume to retrieve annotations for. (required)
- layerId: string, The ID for the layer to get the annotations. (required)
- annotationId: string, The ID of the volume annotation to retrieve. (required)
- 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'.
-
-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(volumeId, layerId, contentVersion, endPosition=None, locale=None, startOffset=None, volumeAnnotationsVersion=None, pageToken=None, updatedMin=None, endOffset=None, showDeleted=None, updatedMax=None, maxResults=None, startPosition=None, source=None)
-
Gets the volume annotations for a volume and layer.
-
-Args:
- volumeId: string, The volume to retrieve annotations for. (required)
- layerId: string, The ID for the layer to get the annotations. (required)
- contentVersion: string, The content version for the requested volume. (required)
- 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.
- volumeAnnotationsVersion: string, The version of the volume annotations that you are requesting.
- 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.
- updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
- 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.
-
-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
- "version": "A String", # The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book).
- "totalItems": 42, # The total number of volume annotations found.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- releaseDownloadAccess(volumeIds, cpksver, source=None, locale=None)
-Release downloaded content access restriction.
-
- requestAccess(source, volumeId, nonce, cpksver, locale=None)
-Request concurrent and download access restrictions.
-
- syncVolumeLicenses(source, nonce, cpksver, features=None, locale=None, showPreorders=None, volumeIds=None)
-Request downloaded content access for specified volumes on the My eBooks shelf.
-Method Details
-
-
releaseDownloadAccess(volumeIds, cpksver, source=None, locale=None)
-
Release downloaded content access restriction.
-
-Args:
- volumeIds: string, The volume(s) to release restrictions for. (required) (repeated)
- cpksver: string, The device/version ID from which to release the restriction. (required)
- 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.
-
-Returns:
- An object of the form:
-
- {
- "downloadAccessList": [ # A list of download access responses.
- {
- "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.
- },
- ],
- "kind": "books#downloadAccesses", # Resource type.
- }
-
-
requestAccess(source, volumeId, nonce, cpksver, locale=None)
-
Request concurrent and download access restrictions.
-
-Args:
- source: string, String to identify the originator of this request. (required)
- volumeId: string, The volume to request concurrent/download restrictions for. (required)
- nonce: string, The client nonce value. (required)
- cpksver: string, The device/version ID from which to request the restrictions. (required)
- locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
-
-Returns:
- An object of the form:
-
- {
- "downloadAccess": { # A download access response.
- "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.
- },
- "kind": "books#requestAccess", # Resource type.
- "concurrentAccess": { # A concurrent access response.
- "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
- "kind": "books#concurrentAccessRestriction", # Resource type.
- "restricted": True or False, # Whether this volume has any concurrent access restrictions.
- "volumeId": "A String", # Identifies the volume for which this entry applies.
- "maxConcurrentDevices": 42, # The maximum number of concurrent access licenses for this volume.
- "deviceAllowed": True or False, # Whether access is granted for this (user, device, volume).
- "source": "A String", # Client app identifier for verification. Download access and client-validation only.
- "timeWindowSeconds": 42, # Time in seconds for license auto-expiration.
- "signature": "A String", # Response signature.
- "reasonCode": "A String", # Error/warning reason code.
- "message": "A String", # Error/warning message.
- },
- }
-
-
syncVolumeLicenses(source, nonce, cpksver, features=None, locale=None, showPreorders=None, volumeIds=None)
-
Request downloaded content access for specified volumes on the My eBooks shelf.
-
-Args:
- source: string, String to identify the originator of this request. (required)
- nonce: string, The client nonce value. (required)
- cpksver: string, The device/version ID from which to release the restriction. (required)
- features: string, List of features supported by the client, i.e., 'RENTALS' (repeated)
- Allowed values
- RENTALS - Client supports rentals.
- locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
- showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.
- volumeIds: string, The volume(s) to request download restrictions for. (repeated)
-
-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).
- "offers": [ # Offers available for this volume (sales and rentals).
- {
- "rentalDuration": { # The rental duration (for rental offers only).
- "count": 3.14,
- "unit": "A String",
- },
- "retailPrice": { # Offer retail (=discounted) price in Micros
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "listPrice": { # Offer list (=undiscounted) price in Micros.
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
- },
- ],
- "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, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, 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)
- "selfLink": "A String", # URL to this resource. (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)
- },
- "recommendedInfo": { # Recommendation related information for this volume.
- "explanation": "A String", # A text explaining why this volume is recommended.
- },
- "id": "A String", # Unique identifier for a volume. (In LITE projection.)
- "layerInfo": { # What layers exist in this volume and high level information about them.
- "layers": [ # A layer should appear here if and only if the layer exists for this book.
- {
- "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
- "layerId": "A String", # The layer id of this layer (e.g. "geo").
- },
- ],
- },
- "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."
- "rentalPeriod": { # Period during this book is/was a valid rental.
- "startUtcSec": "A String",
- "endUtcSec": "A String",
- },
- "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).
- "userUploadedVolumeInfo": {
- "processingState": "A String",
- },
- "rentalState": "A String", # Whether this book is an active or an expired rental.
- "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
- "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
- "kind": "books#readingPosition", # Resource type for a reading position.
- "gbImagePosition": "A String", # Position in a volume for image-based content.
- "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
- "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
- "volumeId": "A String", # Volume id associated with this reading position.
- "pdfPosition": "A String", # Position in a PDF file.
- "gbTextPosition": "A String", # Position in a volume for text-based content.
- },
- "review": { # This user's review of this volume, if one exists.
- "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
- "kind": "books#review", # Resource type for a review.
- "author": { # Author of this review.
- "displayName": "A String", # Name of this person.
- },
- "title": "A String", # Title for this review.
- "volumeId": "A String", # Volume that this review is for.
- "content": "A String", # Review text.
- "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
- "extraDescription": "A String", # Extra text about the source of the review.
- "url": "A String", # URL of the source of the review.
- "description": "A String", # Name of the source.
- },
- "date": "A String", # Date of this review.
- "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
- "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
- },
- "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
- "copy": { # Copy/Paste accounting information.
- "limitType": "A String",
- "remainingCharacterCount": 42,
- "updated": "A String",
- "allowedCharacterCount": 42,
- },
- "isUploaded": True or False, # Whether or not this volume was user uploaded.
- },
- },
- ],
- "kind": "books#volumes", # Resource type.
- }
-
Instance Methods
-
- delete(annotationId, source=None)
-Deletes an annotation.
-
- get(annotationId, source=None)
-Gets an annotation by its ID.
-
- insert(body, source=None, showOnlySummaryInResponse=None)
-Inserts a new annotation.
-
- list(pageToken=None, updatedMax=None, layerId=None, volumeId=None, maxResults=None, showDeleted=None, pageIds=None, contentVersion=None, source=None, updatedMin=None)
-Retrieves a list of annotations, possibly filtered.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- summary(layerIds, volumeId)
-Gets the summary of specified layers.
-
- update(annotationId, body, source=None)
-Updates an existing annotation.
-Method Details
-
-
delete(annotationId, source=None)
-
Deletes an annotation.
-
-Args:
- annotationId: string, The ID for the annotation to delete. (required)
- source: string, String to identify the originator of this request.
-
-
-
get(annotationId, source=None)
-
Gets an annotation by its ID.
-
-Args:
- annotationId: string, The ID for the annotation to retrieve. (required)
- source: string, String to identify the originator of this request.
-
-Returns:
- An object of the form:
-
- {
- "kind": "books#annotation", # Resource type.
- "updated": "A String", # Timestamp for the last time this annotation was modified.
- "created": "A String", # Timestamp for the created time of this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "currentVersionRanges": { # Selection ranges for the most recent content version.
- "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.
- },
- "imageCfiRange": { # Range in image 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.
- },
- },
- "afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "clientVersionRanges": { # Selection ranges sent from the client.
- "contentVersion": "A String", # Content version the client sent in.
- "gbTextRange": { # Range in GB text format for this annotation sent by client.
- "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 sent by client.
- "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.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
- "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 sent by client.
- "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.
- },
- },
- "layerSummary": {
- "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
- "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
- "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
- },
- "volumeId": "A String", # The volume that this annotation belongs to.
- "pageIds": [ # Pages that this annotation spans.
- "A String",
- ],
- "layerId": "A String", # The layer this annotation is for.
- "selectedText": "A String", # Excerpt from the volume.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "data": "A String", # User-created data for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "selfLink": "A String", # URL to this resource.
- }
-
-
insert(body, source=None, showOnlySummaryInResponse=None)
-
Inserts a new annotation.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "books#annotation", # Resource type.
- "updated": "A String", # Timestamp for the last time this annotation was modified.
- "created": "A String", # Timestamp for the created time of this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "currentVersionRanges": { # Selection ranges for the most recent content version.
- "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.
- },
- "imageCfiRange": { # Range in image 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.
- },
- },
- "afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "clientVersionRanges": { # Selection ranges sent from the client.
- "contentVersion": "A String", # Content version the client sent in.
- "gbTextRange": { # Range in GB text format for this annotation sent by client.
- "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 sent by client.
- "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.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
- "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 sent by client.
- "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.
- },
- },
- "layerSummary": {
- "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
- "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
- "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
- },
- "volumeId": "A String", # The volume that this annotation belongs to.
- "pageIds": [ # Pages that this annotation spans.
- "A String",
- ],
- "layerId": "A String", # The layer this annotation is for.
- "selectedText": "A String", # Excerpt from the volume.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "data": "A String", # User-created data for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "selfLink": "A String", # URL to this resource.
- }
-
- source: string, String to identify the originator of this request.
- showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.
-
-Returns:
- An object of the form:
-
- {
- "kind": "books#annotation", # Resource type.
- "updated": "A String", # Timestamp for the last time this annotation was modified.
- "created": "A String", # Timestamp for the created time of this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "currentVersionRanges": { # Selection ranges for the most recent content version.
- "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.
- },
- "imageCfiRange": { # Range in image 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.
- },
- },
- "afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "clientVersionRanges": { # Selection ranges sent from the client.
- "contentVersion": "A String", # Content version the client sent in.
- "gbTextRange": { # Range in GB text format for this annotation sent by client.
- "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 sent by client.
- "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.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
- "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 sent by client.
- "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.
- },
- },
- "layerSummary": {
- "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
- "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
- "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
- },
- "volumeId": "A String", # The volume that this annotation belongs to.
- "pageIds": [ # Pages that this annotation spans.
- "A String",
- ],
- "layerId": "A String", # The layer this annotation is for.
- "selectedText": "A String", # Excerpt from the volume.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "data": "A String", # User-created data for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "selfLink": "A String", # URL to this resource.
- }
-
-
list(pageToken=None, updatedMax=None, layerId=None, volumeId=None, maxResults=None, showDeleted=None, pageIds=None, contentVersion=None, source=None, updatedMin=None)
-
Retrieves a list of annotations, possibly filtered.
-
-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).
- layerId: string, The layer ID to limit annotation by.
- volumeId: string, The volume to restrict annotations to.
- maxResults: integer, Maximum number of results to return
- showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
- 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.
- updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
-
-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 annotations.
- {
- "kind": "books#annotation", # Resource type.
- "updated": "A String", # Timestamp for the last time this annotation was modified.
- "created": "A String", # Timestamp for the created time of this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "currentVersionRanges": { # Selection ranges for the most recent content version.
- "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.
- },
- "imageCfiRange": { # Range in image 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.
- },
- },
- "afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "clientVersionRanges": { # Selection ranges sent from the client.
- "contentVersion": "A String", # Content version the client sent in.
- "gbTextRange": { # Range in GB text format for this annotation sent by client.
- "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 sent by client.
- "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.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
- "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 sent by client.
- "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.
- },
- },
- "layerSummary": {
- "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
- "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
- "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
- },
- "volumeId": "A String", # The volume that this annotation belongs to.
- "pageIds": [ # Pages that this annotation spans.
- "A String",
- ],
- "layerId": "A String", # The layer this annotation is for.
- "selectedText": "A String", # Excerpt from the volume.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "data": "A String", # User-created data for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "selfLink": "A String", # URL to this resource.
- },
- ],
- "kind": "books#annotations", # Resource type.
- "totalItems": 42, # Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
summary(layerIds, volumeId)
-
Gets the summary of specified layers.
-
-Args:
- layerIds: string, Array of layer IDs to get the summary for. (required) (repeated)
- volumeId: string, Volume id to get the summary for. (required)
-
-Returns:
- An object of the form:
-
- {
- "layers": [
- {
- "limitType": "A String",
- "remainingCharacterCount": 42,
- "updated": "A String",
- "layerId": "A String",
- "allowedCharacterCount": 42,
- },
- ],
- "kind": "books#annotationsSummary",
- }
-
-
update(annotationId, body, source=None)
-
Updates an existing annotation.
-
-Args:
- annotationId: string, The ID for the annotation to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "books#annotation", # Resource type.
- "updated": "A String", # Timestamp for the last time this annotation was modified.
- "created": "A String", # Timestamp for the created time of this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "currentVersionRanges": { # Selection ranges for the most recent content version.
- "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.
- },
- "imageCfiRange": { # Range in image 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.
- },
- },
- "afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "clientVersionRanges": { # Selection ranges sent from the client.
- "contentVersion": "A String", # Content version the client sent in.
- "gbTextRange": { # Range in GB text format for this annotation sent by client.
- "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 sent by client.
- "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.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
- "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 sent by client.
- "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.
- },
- },
- "layerSummary": {
- "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
- "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
- "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
- },
- "volumeId": "A String", # The volume that this annotation belongs to.
- "pageIds": [ # Pages that this annotation spans.
- "A String",
- ],
- "layerId": "A String", # The layer this annotation is for.
- "selectedText": "A String", # Excerpt from the volume.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "data": "A String", # User-created data for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "selfLink": "A String", # URL to this resource.
- }
-
- source: string, String to identify the originator of this request.
-
-Returns:
- An object of the form:
-
- {
- "kind": "books#annotation", # Resource type.
- "updated": "A String", # Timestamp for the last time this annotation was modified.
- "created": "A String", # Timestamp for the created time of this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
- "beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "currentVersionRanges": { # Selection ranges for the most recent content version.
- "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.
- },
- "imageCfiRange": { # Range in image 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.
- },
- },
- "afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
- "clientVersionRanges": { # Selection ranges sent from the client.
- "contentVersion": "A String", # Content version the client sent in.
- "gbTextRange": { # Range in GB text format for this annotation sent by client.
- "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 sent by client.
- "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.
- },
- "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
- "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 sent by client.
- "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.
- },
- },
- "layerSummary": {
- "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
- "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
- "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
- },
- "volumeId": "A String", # The volume that this annotation belongs to.
- "pageIds": [ # Pages that this annotation spans.
- "A String",
- ],
- "layerId": "A String", # The layer this annotation is for.
- "selectedText": "A String", # Excerpt from the volume.
- "highlightStyle": "A String", # The highlight style for this annotation.
- "data": "A String", # User-created data for this annotation.
- "id": "A String", # Id of this annotation, in the form of a GUID.
- "selfLink": "A String", # URL to this resource.
- }
-
Instance Methods
-
- volumes()
-
-Returns the volumes Resource.
-
-
- addVolume(shelf, volumeId, source=None)
-Adds a volume to a bookshelf.
-
- clearVolumes(shelf, source=None)
-Clears all volumes from a bookshelf.
-
- get(shelf, source=None)
-Retrieves metadata for a specific bookshelf belonging to the authenticated user.
-
- list(source=None)
-Retrieves a list of bookshelves belonging to the authenticated user.
-
- moveVolume(shelf, volumeId, volumePosition, source=None)
-Moves a volume within a bookshelf.
-
- removeVolume(shelf, volumeId, source=None)
-Removes a volume from a bookshelf.
-Method Details
-
-
addVolume(shelf, volumeId, source=None)
-
Adds a volume to a bookshelf.
-
-Args:
- shelf: string, ID of bookshelf to which to add a volume. (required)
- volumeId: string, ID of volume to add. (required)
- source: string, String to identify the originator of this request.
-
-
-
clearVolumes(shelf, source=None)
-
Clears all volumes from a bookshelf.
-
-Args:
- shelf: string, ID of bookshelf from which to remove a volume. (required)
- source: string, String to identify the originator of this request.
-
-
-
get(shelf, source=None)
-
Retrieves metadata for a specific bookshelf belonging to the authenticated user.
-
-Args:
- shelf: string, ID of bookshelf to retrieve. (required)
- source: string, String to identify the originator of this request.
-
-Returns:
- An object of the form:
-
- {
- "kind": "books#bookshelf", # Resource type for bookshelf metadata.
- "description": "A String", # Description of this bookshelf.
- "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
- "volumeCount": 42, # Number of volumes in this bookshelf.
- "title": "A String", # Title of this bookshelf.
- "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
- "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
- "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
- "id": 42, # Id of this bookshelf, only unique by user.
- "selfLink": "A String", # URL to this resource.
- }
-
-
list(source=None)
-
Retrieves a list of bookshelves belonging to the authenticated user.
-
-Args:
- source: string, String to identify the originator of this request.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # A list of bookshelves.
- {
- "kind": "books#bookshelf", # Resource type for bookshelf metadata.
- "description": "A String", # Description of this bookshelf.
- "created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
- "volumeCount": 42, # Number of volumes in this bookshelf.
- "title": "A String", # Title of this bookshelf.
- "updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
- "access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
- "volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
- "id": 42, # Id of this bookshelf, only unique by user.
- "selfLink": "A String", # URL to this resource.
- },
- ],
- "kind": "books#bookshelves", # Resource type.
- }
-
-
moveVolume(shelf, volumeId, volumePosition, source=None)
-
Moves a volume within a bookshelf.
-
-Args:
- shelf: string, ID of bookshelf with the volume. (required)
- volumeId: string, ID of volume to move. (required)
- 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)
- source: string, String to identify the originator of this request.
-
-
-
removeVolume(shelf, volumeId, source=None)
-
Removes a volume from a bookshelf.
-
-Args:
- shelf: string, ID of bookshelf from which to remove a volume. (required)
- volumeId: string, ID of volume to remove. (required)
- source: string, String to identify the originator of this request.
-
-
Instance Methods
-
- list(shelf, q=None, projection=None, source=None, country=None, showPreorders=None, startIndex=None, maxResults=None)
-Gets volume information for volumes on a bookshelf.
-Method Details
-
-
list(shelf, q=None, projection=None, source=None, country=None, showPreorders=None, startIndex=None, maxResults=None)
-
Gets volume information for volumes on a bookshelf.
-
-Args:
- shelf: string, The bookshelf ID or name retrieve volumes for. (required)
- q: string, Full-text search query string in this bookshelf.
- 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.
- 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.
- startIndex: integer, Index of the first element to return (starts at 0)
- maxResults: integer, Maximum number of results to return
-
-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).
- "offers": [ # Offers available for this volume (sales and rentals).
- {
- "rentalDuration": { # The rental duration (for rental offers only).
- "count": 3.14,
- "unit": "A String",
- },
- "retailPrice": { # Offer retail (=discounted) price in Micros
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "listPrice": { # Offer list (=undiscounted) price in Micros.
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
- },
- ],
- "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, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, 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)
- "selfLink": "A String", # URL to this resource. (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)
- },
- "recommendedInfo": { # Recommendation related information for this volume.
- "explanation": "A String", # A text explaining why this volume is recommended.
- },
- "id": "A String", # Unique identifier for a volume. (In LITE projection.)
- "layerInfo": { # What layers exist in this volume and high level information about them.
- "layers": [ # A layer should appear here if and only if the layer exists for this book.
- {
- "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
- "layerId": "A String", # The layer id of this layer (e.g. "geo").
- },
- ],
- },
- "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."
- "rentalPeriod": { # Period during this book is/was a valid rental.
- "startUtcSec": "A String",
- "endUtcSec": "A String",
- },
- "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).
- "userUploadedVolumeInfo": {
- "processingState": "A String",
- },
- "rentalState": "A String", # Whether this book is an active or an expired rental.
- "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
- "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
- "kind": "books#readingPosition", # Resource type for a reading position.
- "gbImagePosition": "A String", # Position in a volume for image-based content.
- "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
- "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
- "volumeId": "A String", # Volume id associated with this reading position.
- "pdfPosition": "A String", # Position in a PDF file.
- "gbTextPosition": "A String", # Position in a volume for text-based content.
- },
- "review": { # This user's review of this volume, if one exists.
- "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
- "kind": "books#review", # Resource type for a review.
- "author": { # Author of this review.
- "displayName": "A String", # Name of this person.
- },
- "title": "A String", # Title for this review.
- "volumeId": "A String", # Volume that this review is for.
- "content": "A String", # Review text.
- "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
- "extraDescription": "A String", # Extra text about the source of the review.
- "url": "A String", # URL of the source of the review.
- "description": "A String", # Name of the source.
- },
- "date": "A String", # Date of this review.
- "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
- "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
- },
- "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
- "copy": { # Copy/Paste accounting information.
- "limitType": "A String",
- "remainingCharacterCount": 42,
- "updated": "A String",
- "allowedCharacterCount": 42,
- },
- "isUploaded": True or False, # Whether or not this volume was user uploaded.
- },
- },
- ],
- "kind": "books#volumes", # Resource type.
- }
-
Instance Methods
-
- annotations()
-
-Returns the annotations Resource.
-
-
- bookshelves()
-
-Returns the bookshelves Resource.
-
-
- readingpositions()
-
-Returns the readingpositions Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/books_v1.mylibrary.readingpositions.html b/docs/dyn/books_v1.mylibrary.readingpositions.html
deleted file mode 100644
index af47982..0000000
--- a/docs/dyn/books_v1.mylibrary.readingpositions.html
+++ /dev/null
@@ -1,129 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(volumeId, source=None, contentVersion=None)
-Retrieves my reading position information for a volume.
-
- setPosition(volumeId, timestamp, position, deviceCookie=None, source=None, contentVersion=None, action=None)
-Sets my reading position information for a volume.
-Method Details
-
-
get(volumeId, source=None, contentVersion=None)
-
Retrieves my reading position information for a volume.
-
-Args:
- volumeId: string, ID of volume for which to retrieve a reading position. (required)
- source: string, String to identify the originator of this request.
- contentVersion: string, Volume content version for which this reading position is requested.
-
-Returns:
- An object of the form:
-
- {
- "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.
- }
-
-
setPosition(volumeId, timestamp, position, deviceCookie=None, source=None, contentVersion=None, action=None)
-
Sets my reading position information for a volume.
-
-Args:
- volumeId: string, ID of volume for which to update the reading position. (required)
- timestamp: string, RFC 3339 UTC format timestamp associated with this reading position. (required)
- position: string, Position string for the new volume reading position. (required)
- deviceCookie: string, Random persistent device cookie optional on set position.
- source: string, String to identify the originator of this request.
- contentVersion: string, Volume content version for which this reading position applies.
- action: string, Action that caused this reading position to be set.
- Allowed values
- bookmark - User chose bookmark within volume.
- chapter - User selected chapter from list.
- next-page - Next page event.
- prev-page - Previous page event.
- scroll - User navigated to page.
- search - User chose search results within volume.
-
-
Instance Methods
-
- list(volumeId, source=None, locale=None, association=None)
-Return a list of associated books.
-Method Details
-
-
list(volumeId, source=None, locale=None, association=None)
-
Return a list of associated books.
-
-Args:
- volumeId: string, ID of the source volume. (required)
- source: string, String to identify the originator of this request.
- locale: string, ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
- association: string, Association type.
- Allowed values
- end-of-sample - Recommendations for display end-of-sample.
- end-of-volume - Recommendations for display end-of-volume.
-
-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).
- "offers": [ # Offers available for this volume (sales and rentals).
- {
- "rentalDuration": { # The rental duration (for rental offers only).
- "count": 3.14,
- "unit": "A String",
- },
- "retailPrice": { # Offer retail (=discounted) price in Micros
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "listPrice": { # Offer list (=undiscounted) price in Micros.
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
- },
- ],
- "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, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, 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)
- "selfLink": "A String", # URL to this resource. (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)
- },
- "recommendedInfo": { # Recommendation related information for this volume.
- "explanation": "A String", # A text explaining why this volume is recommended.
- },
- "id": "A String", # Unique identifier for a volume. (In LITE projection.)
- "layerInfo": { # What layers exist in this volume and high level information about them.
- "layers": [ # A layer should appear here if and only if the layer exists for this book.
- {
- "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
- "layerId": "A String", # The layer id of this layer (e.g. "geo").
- },
- ],
- },
- "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."
- "rentalPeriod": { # Period during this book is/was a valid rental.
- "startUtcSec": "A String",
- "endUtcSec": "A String",
- },
- "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).
- "userUploadedVolumeInfo": {
- "processingState": "A String",
- },
- "rentalState": "A String", # Whether this book is an active or an expired rental.
- "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
- "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
- "kind": "books#readingPosition", # Resource type for a reading position.
- "gbImagePosition": "A String", # Position in a volume for image-based content.
- "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
- "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
- "volumeId": "A String", # Volume id associated with this reading position.
- "pdfPosition": "A String", # Position in a PDF file.
- "gbTextPosition": "A String", # Position in a volume for text-based content.
- },
- "review": { # This user's review of this volume, if one exists.
- "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
- "kind": "books#review", # Resource type for a review.
- "author": { # Author of this review.
- "displayName": "A String", # Name of this person.
- },
- "title": "A String", # Title for this review.
- "volumeId": "A String", # Volume that this review is for.
- "content": "A String", # Review text.
- "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
- "extraDescription": "A String", # Extra text about the source of the review.
- "url": "A String", # URL of the source of the review.
- "description": "A String", # Name of the source.
- },
- "date": "A String", # Date of this review.
- "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
- "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
- },
- "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
- "copy": { # Copy/Paste accounting information.
- "limitType": "A String",
- "remainingCharacterCount": 42,
- "updated": "A String",
- "allowedCharacterCount": 42,
- },
- "isUploaded": True or False, # Whether or not this volume was user uploaded.
- },
- },
- ],
- "kind": "books#volumes", # Resource type.
- }
-
Instance Methods
-
- associated()
-
-Returns the associated Resource.
-
-
- mybooks()
-
-Returns the mybooks Resource.
-
-
- recommended()
-
-Returns the recommended Resource.
-
-
- useruploaded()
-
-Returns the useruploaded Resource.
-
-
- get(volumeId, projection=None, source=None, country=None, partner=None)
-Gets volume information for a single volume.
-
- list(q, orderBy=None, projection=None, showPreorders=None, download=None, startIndex=None, partner=None, source=None, maxResults=None, libraryRestrict=None, langRestrict=None, printType=None, filter=None)
-Performs a book search.
-Method Details
-
-
get(volumeId, projection=None, source=None, country=None, partner=None)
-
Gets volume information for a single volume.
-
-Args:
- volumeId: string, ID of volume to retrieve. (required)
- 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.
- country: string, ISO-3166-1 code to override the IP-based location.
- partner: string, Brand results for partner ID.
-
-Returns:
- An object of the form:
-
- {
- "kind": "books#volume", # Resource type for a volume. (In LITE projection.)
- "accessInfo": { # Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).
- "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).
- "offers": [ # Offers available for this volume (sales and rentals).
- {
- "rentalDuration": { # The rental duration (for rental offers only).
- "count": 3.14,
- "unit": "A String",
- },
- "retailPrice": { # Offer retail (=discounted) price in Micros
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "listPrice": { # Offer list (=undiscounted) price in Micros.
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
- },
- ],
- "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, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, 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)
- "selfLink": "A String", # URL to this resource. (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)
- },
- "recommendedInfo": { # Recommendation related information for this volume.
- "explanation": "A String", # A text explaining why this volume is recommended.
- },
- "id": "A String", # Unique identifier for a volume. (In LITE projection.)
- "layerInfo": { # What layers exist in this volume and high level information about them.
- "layers": [ # A layer should appear here if and only if the layer exists for this book.
- {
- "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
- "layerId": "A String", # The layer id of this layer (e.g. "geo").
- },
- ],
- },
- "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."
- "rentalPeriod": { # Period during this book is/was a valid rental.
- "startUtcSec": "A String",
- "endUtcSec": "A String",
- },
- "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).
- "userUploadedVolumeInfo": {
- "processingState": "A String",
- },
- "rentalState": "A String", # Whether this book is an active or an expired rental.
- "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
- "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
- "kind": "books#readingPosition", # Resource type for a reading position.
- "gbImagePosition": "A String", # Position in a volume for image-based content.
- "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
- "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
- "volumeId": "A String", # Volume id associated with this reading position.
- "pdfPosition": "A String", # Position in a PDF file.
- "gbTextPosition": "A String", # Position in a volume for text-based content.
- },
- "review": { # This user's review of this volume, if one exists.
- "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
- "kind": "books#review", # Resource type for a review.
- "author": { # Author of this review.
- "displayName": "A String", # Name of this person.
- },
- "title": "A String", # Title for this review.
- "volumeId": "A String", # Volume that this review is for.
- "content": "A String", # Review text.
- "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
- "extraDescription": "A String", # Extra text about the source of the review.
- "url": "A String", # URL of the source of the review.
- "description": "A String", # Name of the source.
- },
- "date": "A String", # Date of this review.
- "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
- "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
- },
- "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
- "copy": { # Copy/Paste accounting information.
- "limitType": "A String",
- "remainingCharacterCount": 42,
- "updated": "A String",
- "allowedCharacterCount": 42,
- },
- "isUploaded": True or False, # Whether or not this volume was user uploaded.
- },
- }
-
-
list(q, orderBy=None, projection=None, showPreorders=None, download=None, startIndex=None, partner=None, source=None, maxResults=None, libraryRestrict=None, langRestrict=None, printType=None, filter=None)
-
Performs a book search.
-
-Args:
- q: string, Full-text search query string. (required)
- orderBy: string, Sort search results.
- 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.
- source: string, String to identify the originator of this request.
- 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.
- 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.
-
-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).
- "offers": [ # Offers available for this volume (sales and rentals).
- {
- "rentalDuration": { # The rental duration (for rental offers only).
- "count": 3.14,
- "unit": "A String",
- },
- "retailPrice": { # Offer retail (=discounted) price in Micros
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "listPrice": { # Offer list (=undiscounted) price in Micros.
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
- },
- ],
- "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, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, 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)
- "selfLink": "A String", # URL to this resource. (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)
- },
- "recommendedInfo": { # Recommendation related information for this volume.
- "explanation": "A String", # A text explaining why this volume is recommended.
- },
- "id": "A String", # Unique identifier for a volume. (In LITE projection.)
- "layerInfo": { # What layers exist in this volume and high level information about them.
- "layers": [ # A layer should appear here if and only if the layer exists for this book.
- {
- "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
- "layerId": "A String", # The layer id of this layer (e.g. "geo").
- },
- ],
- },
- "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."
- "rentalPeriod": { # Period during this book is/was a valid rental.
- "startUtcSec": "A String",
- "endUtcSec": "A String",
- },
- "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).
- "userUploadedVolumeInfo": {
- "processingState": "A String",
- },
- "rentalState": "A String", # Whether this book is an active or an expired rental.
- "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
- "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
- "kind": "books#readingPosition", # Resource type for a reading position.
- "gbImagePosition": "A String", # Position in a volume for image-based content.
- "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
- "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
- "volumeId": "A String", # Volume id associated with this reading position.
- "pdfPosition": "A String", # Position in a PDF file.
- "gbTextPosition": "A String", # Position in a volume for text-based content.
- },
- "review": { # This user's review of this volume, if one exists.
- "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
- "kind": "books#review", # Resource type for a review.
- "author": { # Author of this review.
- "displayName": "A String", # Name of this person.
- },
- "title": "A String", # Title for this review.
- "volumeId": "A String", # Volume that this review is for.
- "content": "A String", # Review text.
- "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
- "extraDescription": "A String", # Extra text about the source of the review.
- "url": "A String", # URL of the source of the review.
- "description": "A String", # Name of the source.
- },
- "date": "A String", # Date of this review.
- "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
- "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
- },
- "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
- "copy": { # Copy/Paste accounting information.
- "limitType": "A String",
- "remainingCharacterCount": 42,
- "updated": "A String",
- "allowedCharacterCount": 42,
- },
- "isUploaded": True or False, # Whether or not this volume was user uploaded.
- },
- },
- ],
- "kind": "books#volumes", # Resource type.
- }
-
Instance Methods
-
- list(source=None, locale=None, acquireMethod=None, maxResults=None, startIndex=None, processingState=None)
-Return a list of books in My Library.
-Method Details
-
-
list(source=None, locale=None, acquireMethod=None, maxResults=None, startIndex=None, processingState=None)
-
Return a list of books in My Library.
-
-Args:
- source: string, String to identify the originator of this request.
- locale: string, ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.
- acquireMethod: string, How the book was aquired (repeated)
- Allowed values
- PREORDERED - Preordered books (not yet available)
- PREVIOUSLY_RENTED - User-rented books past their expiration time
- PUBLIC_DOMAIN - Public domain books
- PURCHASED - Purchased books
- RENTED - User-rented books
- SAMPLE - Sample books
- UPLOADED - User uploaded books
- maxResults: integer, Maximum number of results to return.
- startIndex: integer, Index of the first result to return (starts at 0)
- processingState: string, The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod. (repeated)
- Allowed values
- COMPLETED_FAILED - The volume processing hase failed.
- COMPLETED_SUCCESS - The volume processing was completed.
- RUNNING - The volume processing is not completed.
-
-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).
- "offers": [ # Offers available for this volume (sales and rentals).
- {
- "rentalDuration": { # The rental duration (for rental offers only).
- "count": 3.14,
- "unit": "A String",
- },
- "retailPrice": { # Offer retail (=discounted) price in Micros
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "listPrice": { # Offer list (=undiscounted) price in Micros.
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
- },
- ],
- "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, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, 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)
- "selfLink": "A String", # URL to this resource. (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)
- },
- "recommendedInfo": { # Recommendation related information for this volume.
- "explanation": "A String", # A text explaining why this volume is recommended.
- },
- "id": "A String", # Unique identifier for a volume. (In LITE projection.)
- "layerInfo": { # What layers exist in this volume and high level information about them.
- "layers": [ # A layer should appear here if and only if the layer exists for this book.
- {
- "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
- "layerId": "A String", # The layer id of this layer (e.g. "geo").
- },
- ],
- },
- "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."
- "rentalPeriod": { # Period during this book is/was a valid rental.
- "startUtcSec": "A String",
- "endUtcSec": "A String",
- },
- "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).
- "userUploadedVolumeInfo": {
- "processingState": "A String",
- },
- "rentalState": "A String", # Whether this book is an active or an expired rental.
- "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
- "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
- "kind": "books#readingPosition", # Resource type for a reading position.
- "gbImagePosition": "A String", # Position in a volume for image-based content.
- "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
- "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
- "volumeId": "A String", # Volume id associated with this reading position.
- "pdfPosition": "A String", # Position in a PDF file.
- "gbTextPosition": "A String", # Position in a volume for text-based content.
- },
- "review": { # This user's review of this volume, if one exists.
- "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
- "kind": "books#review", # Resource type for a review.
- "author": { # Author of this review.
- "displayName": "A String", # Name of this person.
- },
- "title": "A String", # Title for this review.
- "volumeId": "A String", # Volume that this review is for.
- "content": "A String", # Review text.
- "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
- "extraDescription": "A String", # Extra text about the source of the review.
- "url": "A String", # URL of the source of the review.
- "description": "A String", # Name of the source.
- },
- "date": "A String", # Date of this review.
- "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
- "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
- },
- "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
- "copy": { # Copy/Paste accounting information.
- "limitType": "A String",
- "remainingCharacterCount": 42,
- "updated": "A String",
- "allowedCharacterCount": 42,
- },
- "isUploaded": True or False, # Whether or not this volume was user uploaded.
- },
- },
- ],
- "kind": "books#volumes", # Resource type.
- }
-
Instance Methods
-
- list(source=None, locale=None)
-Return a list of recommended books for the current user.
-Method Details
-
-
list(source=None, locale=None)
-
Return a list of recommended books for the current user.
-
-Args:
- source: string, String to identify the originator of this request.
- locale: string, ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
-
-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).
- "offers": [ # Offers available for this volume (sales and rentals).
- {
- "rentalDuration": { # The rental duration (for rental offers only).
- "count": 3.14,
- "unit": "A String",
- },
- "retailPrice": { # Offer retail (=discounted) price in Micros
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "listPrice": { # Offer list (=undiscounted) price in Micros.
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
- },
- ],
- "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, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, 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)
- "selfLink": "A String", # URL to this resource. (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)
- },
- "recommendedInfo": { # Recommendation related information for this volume.
- "explanation": "A String", # A text explaining why this volume is recommended.
- },
- "id": "A String", # Unique identifier for a volume. (In LITE projection.)
- "layerInfo": { # What layers exist in this volume and high level information about them.
- "layers": [ # A layer should appear here if and only if the layer exists for this book.
- {
- "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
- "layerId": "A String", # The layer id of this layer (e.g. "geo").
- },
- ],
- },
- "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."
- "rentalPeriod": { # Period during this book is/was a valid rental.
- "startUtcSec": "A String",
- "endUtcSec": "A String",
- },
- "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).
- "userUploadedVolumeInfo": {
- "processingState": "A String",
- },
- "rentalState": "A String", # Whether this book is an active or an expired rental.
- "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
- "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
- "kind": "books#readingPosition", # Resource type for a reading position.
- "gbImagePosition": "A String", # Position in a volume for image-based content.
- "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
- "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
- "volumeId": "A String", # Volume id associated with this reading position.
- "pdfPosition": "A String", # Position in a PDF file.
- "gbTextPosition": "A String", # Position in a volume for text-based content.
- },
- "review": { # This user's review of this volume, if one exists.
- "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
- "kind": "books#review", # Resource type for a review.
- "author": { # Author of this review.
- "displayName": "A String", # Name of this person.
- },
- "title": "A String", # Title for this review.
- "volumeId": "A String", # Volume that this review is for.
- "content": "A String", # Review text.
- "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
- "extraDescription": "A String", # Extra text about the source of the review.
- "url": "A String", # URL of the source of the review.
- "description": "A String", # Name of the source.
- },
- "date": "A String", # Date of this review.
- "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
- "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
- },
- "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
- "copy": { # Copy/Paste accounting information.
- "limitType": "A String",
- "remainingCharacterCount": 42,
- "updated": "A String",
- "allowedCharacterCount": 42,
- },
- "isUploaded": True or False, # Whether or not this volume was user uploaded.
- },
- },
- ],
- "kind": "books#volumes", # Resource type.
- }
-
Instance Methods
-
- list(source=None, locale=None, volumeId=None, maxResults=None, startIndex=None, processingState=None)
-Return a list of books uploaded by the current user.
-Method Details
-
-
list(source=None, locale=None, volumeId=None, maxResults=None, startIndex=None, processingState=None)
-
Return a list of books uploaded by the current user.
-
-Args:
- source: string, String to identify the originator of this request.
- locale: string, ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
- volumeId: string, The ids of the volumes to be returned. If not specified all that match the processingState are returned. (repeated)
- maxResults: integer, Maximum number of results to return.
- startIndex: integer, Index of the first result to return (starts at 0)
- processingState: string, The processing state of the user uploaded volumes to be returned. (repeated)
- Allowed values
- COMPLETED_FAILED - The volume processing hase failed.
- COMPLETED_SUCCESS - The volume processing was completed.
- RUNNING - The volume processing is not completed.
-
-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).
- "offers": [ # Offers available for this volume (sales and rentals).
- {
- "rentalDuration": { # The rental duration (for rental offers only).
- "count": 3.14,
- "unit": "A String",
- },
- "retailPrice": { # Offer retail (=discounted) price in Micros
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "listPrice": { # Offer list (=undiscounted) price in Micros.
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
- },
- ],
- "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, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, 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)
- "selfLink": "A String", # URL to this resource. (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)
- },
- "recommendedInfo": { # Recommendation related information for this volume.
- "explanation": "A String", # A text explaining why this volume is recommended.
- },
- "id": "A String", # Unique identifier for a volume. (In LITE projection.)
- "layerInfo": { # What layers exist in this volume and high level information about them.
- "layers": [ # A layer should appear here if and only if the layer exists for this book.
- {
- "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
- "layerId": "A String", # The layer id of this layer (e.g. "geo").
- },
- ],
- },
- "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."
- "rentalPeriod": { # Period during this book is/was a valid rental.
- "startUtcSec": "A String",
- "endUtcSec": "A String",
- },
- "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).
- "userUploadedVolumeInfo": {
- "processingState": "A String",
- },
- "rentalState": "A String", # Whether this book is an active or an expired rental.
- "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
- "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
- "kind": "books#readingPosition", # Resource type for a reading position.
- "gbImagePosition": "A String", # Position in a volume for image-based content.
- "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
- "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
- "volumeId": "A String", # Volume id associated with this reading position.
- "pdfPosition": "A String", # Position in a PDF file.
- "gbTextPosition": "A String", # Position in a volume for text-based content.
- },
- "review": { # This user's review of this volume, if one exists.
- "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
- "kind": "books#review", # Resource type for a review.
- "author": { # Author of this review.
- "displayName": "A String", # Name of this person.
- },
- "title": "A String", # Title for this review.
- "volumeId": "A String", # Volume that this review is for.
- "content": "A String", # Review text.
- "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
- "extraDescription": "A String", # Extra text about the source of the review.
- "url": "A String", # URL of the source of the review.
- "description": "A String", # Name of the source.
- },
- "date": "A String", # Date of this review.
- "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
- "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
- },
- "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
- "copy": { # Copy/Paste accounting information.
- "limitType": "A String",
- "remainingCharacterCount": 42,
- "updated": "A String",
- "allowedCharacterCount": 42,
- },
- "isUploaded": True or False, # Whether or not this volume was user uploaded.
- },
- },
- ],
- "kind": "books#volumes", # Resource type.
- }
-
Instance Methods
-
- delete(calendarId, ruleId)
-Deletes an access control rule.
-
- get(calendarId, ruleId)
-Returns an access control rule.
-
- insert(calendarId, body)
-Creates an access control rule.
-
- list(calendarId)
-Returns the rules in the access control list for the calendar.
-
- patch(calendarId, ruleId, body)
-Updates an access control rule. This method supports patch semantics.
-
- update(calendarId, ruleId, body)
-Updates an access control rule.
-Method Details
-
-
delete(calendarId, ruleId)
-
Deletes an access control rule.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- ruleId: string, ACL rule identifier. (required)
-
-
-
get(calendarId, ruleId)
-
Returns an access control rule.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- ruleId: string, ACL rule identifier. (required)
-
-Returns:
- An object of the form:
-
- {
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }
-
-
insert(calendarId, body)
-
Creates an access control rule.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }
-
-
list(calendarId)
-
Returns the rules in the access control list for the calendar.
-
-Args:
- calendarId: string, Calendar identifier. (required)
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.
- "items": [ # List of rules on the access control list.
- {
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- },
- ],
- "kind": "calendar#acl", # Type of the collection ("calendar#acl").
- "etag": "A String", # ETag of the collection.
- }
-
-
patch(calendarId, ruleId, body)
-
Updates an access control rule. This method supports patch semantics.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- ruleId: string, ACL rule identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }
-
-
update(calendarId, ruleId, body)
-
Updates an access control rule.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- ruleId: string, ACL rule identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- "etag": "A String", # ETag of the resource.
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- }
-
Instance Methods
-
- delete(calendarId)
-Deletes an entry on the user's calendar list.
-
- get(calendarId)
-Returns an entry on the user's calendar list.
-
- insert(body, colorRgbFormat=None)
-Adds an entry to the user's calendar list.
-
- list(minAccessRole=None, maxResults=None, pageToken=None, showHidden=None)
-Returns entries on the user's calendar list.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(calendarId, body, colorRgbFormat=None)
-Updates an entry on the user's calendar list. This method supports patch semantics.
-
- update(calendarId, body, colorRgbFormat=None)
-Updates an entry on the user's calendar list.
-Method Details
-
-
delete(calendarId)
-
Deletes an entry on the user's calendar list.
-
-Args:
- calendarId: string, Calendar identifier. (required)
-
-
-
get(calendarId)
-
Returns an entry on the user's calendar list.
-
-Args:
- calendarId: string, Calendar identifier. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
- "foregroundColor": "A String", # The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property. Optional.
- "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "description": "A String", # Description of the calendar. Optional. Read-only.
- "colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
- "selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
- "primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
- "summary": "A String", # Title of the calendar. Read-only.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
- "backgroundColor": "A String", # The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property. Optional.
- "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
- "hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
- "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the calendar.
- }
-
-
insert(body, colorRgbFormat=None)
-
Adds an entry to the user's calendar list.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
- "foregroundColor": "A String", # The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property. Optional.
- "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "description": "A String", # Description of the calendar. Optional. Read-only.
- "colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
- "selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
- "primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
- "summary": "A String", # Title of the calendar. Read-only.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
- "backgroundColor": "A String", # The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property. Optional.
- "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
- "hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
- "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the calendar.
- }
-
- colorRgbFormat: boolean, Whether to use the 'foregroundColor' and 'backgroundColor' fields to write the calendar colors (RGB). If this feature is used, the index-based 'colorId' field will be set to the best matching option automatically. Optional. The default is False.
-
-Returns:
- An object of the form:
-
- {
- "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
- "foregroundColor": "A String", # The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property. Optional.
- "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "description": "A String", # Description of the calendar. Optional. Read-only.
- "colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
- "selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
- "primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
- "summary": "A String", # Title of the calendar. Read-only.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
- "backgroundColor": "A String", # The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property. Optional.
- "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
- "hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
- "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the calendar.
- }
-
-
list(minAccessRole=None, maxResults=None, pageToken=None, showHidden=None)
-
Returns entries on the user's calendar list.
-
-Args:
- 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.
- owner - The user can read and modify events and access control lists.
- reader - The user can read events that are not private.
- writer - The user can read and modify events.
- 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.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Token used to access the next page of this result.
- "items": [ # Calendars that are present on the user's calendar list.
- {
- "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
- "foregroundColor": "A String", # The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property. Optional.
- "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "description": "A String", # Description of the calendar. Optional. Read-only.
- "colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
- "selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
- "primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
- "summary": "A String", # Title of the calendar. Read-only.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
- "backgroundColor": "A String", # The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property. Optional.
- "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
- "hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
- "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the calendar.
- },
- ],
- "kind": "calendar#calendarList", # Type of the collection ("calendar#calendarList").
- "etag": "A String", # ETag of the collection.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(calendarId, body, colorRgbFormat=None)
-
Updates an entry on the user's calendar list. This method supports patch semantics.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
- "foregroundColor": "A String", # The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property. Optional.
- "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "description": "A String", # Description of the calendar. Optional. Read-only.
- "colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
- "selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
- "primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
- "summary": "A String", # Title of the calendar. Read-only.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
- "backgroundColor": "A String", # The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property. Optional.
- "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
- "hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
- "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the calendar.
- }
-
- colorRgbFormat: boolean, Whether to use the 'foregroundColor' and 'backgroundColor' fields to write the calendar colors (RGB). If this feature is used, the index-based 'colorId' field will be set to the best matching option automatically. Optional. The default is False.
-
-Returns:
- An object of the form:
-
- {
- "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
- "foregroundColor": "A String", # The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property. Optional.
- "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "description": "A String", # Description of the calendar. Optional. Read-only.
- "colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
- "selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
- "primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
- "summary": "A String", # Title of the calendar. Read-only.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
- "backgroundColor": "A String", # The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property. Optional.
- "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
- "hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
- "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the calendar.
- }
-
-
update(calendarId, body, colorRgbFormat=None)
-
Updates an entry on the user's calendar list.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
- "foregroundColor": "A String", # The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property. Optional.
- "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "description": "A String", # Description of the calendar. Optional. Read-only.
- "colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
- "selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
- "primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
- "summary": "A String", # Title of the calendar. Read-only.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
- "backgroundColor": "A String", # The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property. Optional.
- "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
- "hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
- "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the calendar.
- }
-
- colorRgbFormat: boolean, Whether to use the 'foregroundColor' and 'backgroundColor' fields to write the calendar colors (RGB). If this feature is used, the index-based 'colorId' field will be set to the best matching option automatically. Optional. The default is False.
-
-Returns:
- An object of the form:
-
- {
- "kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
- "foregroundColor": "A String", # The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property. Optional.
- "defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "description": "A String", # Description of the calendar. Optional. Read-only.
- "colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
- "selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
- "primary": True or False, # Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
- "summary": "A String", # Title of the calendar. Read-only.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
- "backgroundColor": "A String", # The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property. Optional.
- "summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
- "hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
- "accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the calendar.
- }
-
Instance Methods
-
- clear(calendarId)
-Clears a primary calendar. This operation deletes all data associated with the primary calendar of an account and cannot be undone.
-
- delete(calendarId)
-Deletes a secondary calendar.
-
- get(calendarId)
-Returns metadata for a calendar.
-
- insert(body)
-Creates a secondary calendar.
-
- patch(calendarId, body)
-Updates metadata for a calendar. This method supports patch semantics.
-
- update(calendarId, body)
-Updates metadata for a calendar.
-Method Details
-
-
clear(calendarId)
-
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)
-
-
-
delete(calendarId)
-
Deletes a secondary calendar.
-
-Args:
- calendarId: string, Calendar identifier. (required)
-
-
-
get(calendarId)
-
Returns metadata for a calendar.
-
-Args:
- calendarId: string, Calendar identifier. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
- "description": "A String", # Description of the calendar. Optional.
- "summary": "A String", # Title of the calendar.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional.
- "id": "A String", # Identifier of the calendar.
- }
-
-
insert(body)
-
Creates a secondary calendar.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
- "description": "A String", # Description of the calendar. Optional.
- "summary": "A String", # Title of the calendar.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional.
- "id": "A String", # Identifier of the calendar.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
- "description": "A String", # Description of the calendar. Optional.
- "summary": "A String", # Title of the calendar.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional.
- "id": "A String", # Identifier of the calendar.
- }
-
-
patch(calendarId, body)
-
Updates metadata for a calendar. This method supports patch semantics.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
- "description": "A String", # Description of the calendar. Optional.
- "summary": "A String", # Title of the calendar.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional.
- "id": "A String", # Identifier of the calendar.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
- "description": "A String", # Description of the calendar. Optional.
- "summary": "A String", # Title of the calendar.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional.
- "id": "A String", # Identifier of the calendar.
- }
-
-
update(calendarId, body)
-
Updates metadata for a calendar.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
- "description": "A String", # Description of the calendar. Optional.
- "summary": "A String", # Title of the calendar.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional.
- "id": "A String", # Identifier of the calendar.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "calendar#calendar", # Type of the resource ("calendar#calendar").
- "description": "A String", # Description of the calendar. Optional.
- "summary": "A String", # Title of the calendar.
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the calendar as free-form text. Optional.
- "timeZone": "A String", # The time zone of the calendar. Optional.
- "id": "A String", # Identifier of the calendar.
- }
-
Instance Methods
-
- stop(body)
-A description of how to use this function
-Method Details
-
-
stop(body)
-
A description of how to use this function
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
-
-
Instance Methods
-
- get()
-Returns the color definitions for calendars and events.
-Method Details
-
-
get()
-
Returns the color definitions for calendars and events.
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "calendar": { # Palette of calendar colors, mapping from the color ID to its definition. An 'calendarListEntry' resource refers to one of these color IDs in its 'color' field. Read-only.
- "a_key": { # A calendar color defintion.
- "foreground": "A String", # The foreground color that can be used to write on top of a background with 'background' color.
- "background": "A String", # The background color associated with this color definition.
- },
- },
- "updated": "A String", # Last modification time of the color palette (as a RFC 3339 timestamp). Read-only.
- "event": { # Palette of event colors, mapping from the color ID to its definition. An 'event' resource may refer to one of these color IDs in its 'color' field. Read-only.
- "a_key": { # An event color definition.
- "foreground": "A String", # The foreground color that can be used to write on top of a background with 'background' color.
- "background": "A String", # The background color associated with this color definition.
- },
- },
- "kind": "calendar#colors", # Type of the resource ("calendar#colors").
- }
-
Instance Methods
-
- delete(calendarId, eventId, sendNotifications=None)
-Deletes an event.
-
- get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)
-Returns an event.
-
- import_(calendarId, body)
-Imports an event. This operation is used to add a private copy of an existing event to a calendar.
-
- insert(calendarId, body, sendNotifications=None, maxAttendees=None)
-Creates an event.
-
- instances(calendarId, eventId, timeMin=None, showDeleted=None, alwaysIncludeEmail=None, pageToken=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)
-Returns instances of the specified recurring event.
-
- instances_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- list(calendarId, orderBy=None, showHiddenInvitations=None, timeMin=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, maxAttendees=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)
-Returns events on the specified calendar.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- move(calendarId, eventId, destination, sendNotifications=None)
-Moves an event to another calendar, i.e. changes an event's organizer.
-
- patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)
-Updates an event. This method supports patch semantics.
-
- quickAdd(calendarId, text, sendNotifications=None)
-Creates an event based on a simple text string.
-
- update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)
-Updates an event.
-
- watch(calendarId, body, orderBy=None, showHiddenInvitations=None, timeMin=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, maxAttendees=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)
-Subscribe to changes in events collection
-Method Details
-
-
delete(calendarId, eventId, sendNotifications=None)
-
Deletes an event.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- eventId: string, Event identifier. (required)
- sendNotifications: boolean, Whether to send notifications about the deletion of the event. Optional. The default is False.
-
-
-
get(calendarId, eventId, alwaysIncludeEmail=None, timeZone=None, maxAttendees=None)
-
Returns an event.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- eventId: string, Event identifier. (required)
- alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
- 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.
-
-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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- }
-
-
import_(calendarId, body)
-
Imports an event. This operation is used to add a private copy of an existing event to a calendar.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- }
-
-
-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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- }
-
-
insert(calendarId, body, sendNotifications=None, maxAttendees=None)
-
Creates an event.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- }
-
- sendNotifications: boolean, Whether to send notifications about the creation of the new event. Optional. The default is False.
- 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.
-
-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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- }
-
-
instances(calendarId, eventId, timeMin=None, showDeleted=None, alwaysIncludeEmail=None, pageToken=None, maxAttendees=None, maxResults=None, timeMax=None, timeZone=None, originalStart=None)
-
Returns instances of the specified recurring event.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- eventId: string, Recurring event 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.
- showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events will still be included if 'singleEvents' is False. Optional. The default is False.
- alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
- pageToken: string, Token specifying which result page to return. 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.
- maxResults: integer, Maximum number of events returned on one result page. Optional.
- timeMax: string, Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
- 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.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.
- "kind": "calendar#events", # Type of the collection ("calendar#events").
- "defaultReminders": [ # The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have 'reminders.useDefault' set to 'true').
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "description": "A String", # Description of the calendar. Read-only.
- "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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- },
- ],
- "updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
- "summary": "A String", # Title of the calendar. Read-only.
- "etag": "A String", # ETag of the collection.
- "timeZone": "A String", # The time zone of the calendar. Read-only.
- "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
- # - "none" - The user has no access.
- # - "freeBusyReader" - The user has read access to free/busy information.
- # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- }
-
-
instances_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
list(calendarId, orderBy=None, showHiddenInvitations=None, timeMin=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, maxAttendees=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)
-
Returns events on the specified calendar.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.
- Allowed values
- 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.
- 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.
- 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.
- alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
- showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if 'showDeleted' and 'singleEvents' are both False. If 'showDeleted' and 'singleEvents' are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
- 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.
- 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.
- timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.
- "kind": "calendar#events", # Type of the collection ("calendar#events").
- "defaultReminders": [ # The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have 'reminders.useDefault' set to 'true').
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "description": "A String", # Description of the calendar. Read-only.
- "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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- },
- ],
- "updated": "A String", # Last modification time of the calendar (as a RFC 3339 timestamp). Read-only.
- "summary": "A String", # Title of the calendar. Read-only.
- "etag": "A String", # ETag of the collection.
- "timeZone": "A String", # The time zone of the calendar. Read-only.
- "accessRole": "A String", # The user's access role for this calendar. Read-only. Possible values are:
- # - "none" - The user has no access.
- # - "freeBusyReader" - The user has read access to free/busy information.
- # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
move(calendarId, eventId, destination, sendNotifications=None)
-
Moves an event to another calendar, i.e. changes an event's organizer.
-
-Args:
- calendarId: string, Calendar identifier of the source calendar where the event currently is on. (required)
- eventId: string, Event identifier. (required)
- destination: string, Calendar identifier of the target calendar where the event is to be moved to. (required)
- sendNotifications: boolean, Whether to send notifications about the change of the event's organizer. Optional. The default is False.
-
-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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- }
-
-
patch(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)
-
Updates an event. This method supports patch semantics.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- eventId: string, Event identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- }
-
- sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
- alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
- 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.
-
-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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- }
-
-
quickAdd(calendarId, text, sendNotifications=None)
-
Creates an event based on a simple text string.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- text: string, The text describing the event to be created. (required)
- sendNotifications: boolean, Whether to send notifications about the creation of the event. Optional. The default is False.
-
-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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- }
-
-
update(calendarId, eventId, body, sendNotifications=None, alwaysIncludeEmail=None, maxAttendees=None)
-
Updates an event.
-
-Args:
- calendarId: string, Calendar identifier. (required)
- eventId: string, Event identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- }
-
- sendNotifications: boolean, Whether to send notifications about the event update (e.g. attendee's responses, title changes, etc.). Optional. The default is False.
- alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
- 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.
-
-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.
- "id": "A String", # The creator's Profile ID, 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.
- "id": "A String", # The organizer's Profile ID, if available.
- },
- "summary": "A String", # Title of the event.
- "id": "A String", # Identifier of the event.
- "hangoutLink": "A String", # An absolute link to the Google+ hangout associated with this event. Read-only.
- "attendees": [ # The attendees of the event.
- {
- "comment": "A String", # The attendee's response comment. Optional.
- "displayName": "A String", # The attendee's name, if available. Optional.
- "responseStatus": "A String", # The attendee's response status. Possible values are:
- # - "needsAction" - The attendee has not responded to the invitation.
- # - "declined" - The attendee has declined the invitation.
- # - "tentative" - The attendee has tentatively accepted the invitation.
- # - "accepted" - The attendee has accepted the invitation.
- "self": True or False, # Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
- "id": "A String", # The attendee's Profile ID, if available.
- "additionalGuests": 42, # Number of additional guests. Optional. The default is 0.
- "resource": True or False, # Whether the attendee is a resource. Read-only. The default is False.
- "organizer": True or False, # Whether the attendee is the organizer of the event. Read-only. The default is False.
- "optional": True or False, # Whether this is an optional attendee. Optional. The default is False.
- "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee.
- },
- ],
- "start": { # The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "htmlLink": "A String", # An absolute link to this event in the Google Calendar Web UI. Read-only.
- "recurrence": [ # List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
- "A String",
- ],
- "source": { # Source of an event from which it was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of the event.
- "url": "A String", # URL of the source pointing to a resource. URL's protocol must be HTTP or HTTPS.
- "title": "A String", # Title of the source; for example a title of a web page or an email subject.
- },
- "etag": "A String", # ETag of the resource.
- "location": "A String", # Geographic location of the event as free-form text. Optional.
- "recurringEventId": "A String", # For an instance of a recurring event, this is the event ID of the recurring event itself. Immutable.
- "gadget": { # A gadget that extends this event.
- "preferences": { # Preferences.
- "a_key": "A String", # The preference name and corresponding value.
- },
- "title": "A String", # The gadget's title.
- "height": 42, # The gadget's height in pixels. Optional.
- "width": 42, # The gadget's width in pixels. Optional.
- "link": "A String", # The gadget's URL.
- "type": "A String", # The gadget's type.
- "display": "A String", # The gadget's display mode. Optional. Possible values are:
- # - "icon" - The gadget displays next to the event's title in the calendar view.
- # - "chip" - The gadget displays when the event is clicked.
- "iconLink": "A String", # The gadget's icon URL.
- },
- "status": "A String", # Status of the event. Optional. Possible values are:
- # - "confirmed" - The event is confirmed. This is the default status.
- # - "tentative" - The event is tentatively confirmed.
- # - "cancelled" - The event is cancelled.
- "updated": "A String", # Last modification time of the event (as a RFC 3339 timestamp). Read-only.
- "description": "A String", # Description of the event. Optional.
- "iCalUID": "A String", # Event ID in the iCalendar format.
- "extendedProperties": { # Extended properties of the event.
- "shared": { # Properties that are shared between copies of the event on other attendees' calendars.
- "a_key": "A String", # The name of the shared property and the corresponding value.
- },
- "private": { # Properties that are private to the copy of the event that appears on this calendar.
- "a_key": "A String", # The name of the private property and the corresponding value.
- },
- },
- "endTimeUnspecified": True or False, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
- "sequence": 42, # Sequence number as per iCalendar.
- "visibility": "A String", # Visibility of the event. Optional. Possible values are:
- # - "default" - Uses the default visibility for events on the calendar. This is the default value.
- # - "public" - The event is public and event details are visible to all readers of the calendar.
- # - "private" - The event is private and only event attendees may view event details.
- # - "confidential" - The event is private. This value is provided for compatibility reasons.
- "guestsCanModify": True or False, # Whether attendees other than the organizer can modify the event. Optional. The default is False.
- "end": { # The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "attendeesOmitted": True or False, # Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the 'maxAttendee' query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.
- "kind": "calendar#event", # Type of the resource ("calendar#event").
- "locked": True or False, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
- "created": "A String", # Creation time of the event (as a RFC 3339 timestamp). Read-only.
- "colorId": "A String", # The color of the event. This is an ID referring to an entry in the "event" section of the colors definition (see the "colors" endpoint). Optional.
- "anyoneCanAddSelf": True or False, # Whether anyone can invite themselves to the event. Optional. The default is False.
- "reminders": { # Information about the event's reminders for the authenticated user.
- "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event.
- {
- "minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
- "method": "A String", # The method used by this reminder. Possible values are:
- # - "email" - Reminders are sent via email.
- # - "sms" - Reminders are sent via SMS.
- # - "popup" - Reminders are sent via a UI popup.
- },
- ],
- "useDefault": True or False, # Whether the default reminders of the calendar apply to the event.
- },
- "guestsCanSeeOtherGuests": True or False, # Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.
- "originalStartTime": { # For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable.
- "date": "A String", # The date, in the format "yyyy-mm-dd", if this is an all-day event.
- "timeZone": "A String", # The name of the time zone in which the time is specified (e.g. "Europe/Zurich"). Optional. The default is the time zone of the calendar.
- "dateTime": "A String", # The time, as a combined date-time value (formatted according to RFC 3339). A time zone offset is required unless a time zone is explicitly specified in 'timeZone'.
- },
- "guestsCanInviteOthers": True or False, # Whether attendees other than the organizer can invite others to the event. Optional. The default is True.
- "transparency": "A String", # Whether the event blocks time on the calendar. Optional. Possible values are:
- # - "opaque" - The event blocks time on the calendar. This is the default value.
- # - "transparent" - The event does not block time on the calendar.
- "privateCopy": True or False, # Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
- }
-
-
watch(calendarId, body, orderBy=None, showHiddenInvitations=None, timeMin=None, pageToken=None, updatedMin=None, singleEvents=None, alwaysIncludeEmail=None, showDeleted=None, maxAttendees=None, iCalUID=None, maxResults=None, timeMax=None, q=None, timeZone=None)
-
Subscribe to changes in events collection
-
-Args:
- calendarId: string, Calendar identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
- orderBy: string, The order of the events returned in the result. Optional. The default is an unspecified, stable order.
- Allowed values
- 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.
- 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.
- 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.
- alwaysIncludeEmail: boolean, Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
- showDeleted: boolean, Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if 'showDeleted' and 'singleEvents' are both False. If 'showDeleted' and 'singleEvents' are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
- 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.
- 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.
- timeZone: string, Time zone used in the response. Optional. The default is the time zone of the calendar.
-
-Returns:
- An object of the form:
-
- {
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
Instance Methods
-
- query(body)
-Returns free/busy information for a set of calendars.
-Method Details
-
-
query(body)
-
Returns free/busy information for a set of calendars.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "calendarExpansionMax": 42, # Maximal number of calendars for which FreeBusy information is to be provided. Optional.
- "groupExpansionMax": 42, # Maximal number of calendar identifiers to be provided for a single group. Optional. An error will be returned for a group with more members than this value.
- "timeMax": "A String", # The end of the interval for the query.
- "items": [ # List of calendars and/or groups to query.
- {
- "id": "A String", # The identifier of a calendar or a group.
- },
- ],
- "timeMin": "A String", # The start of the interval for the query.
- "timeZone": "A String", # Time zone used in the response. Optional. The default is UTC.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "timeMax": "A String", # The end of the interval.
- "kind": "calendar#freeBusy", # Type of the resource ("calendar#freeBusy").
- "calendars": { # List of free/busy information for calendars.
- "a_key": { # Free/busy expansions for a single calendar.
- "busy": [ # List of time ranges during which this calendar should be regarded as busy.
- {
- "start": "A String", # The (inclusive) start of the time period.
- "end": "A String", # The (exclusive) end of the time period.
- },
- ],
- "errors": [ # Optional error(s) (if computation for the calendar failed).
- {
- "domain": "A String", # Domain, or broad category, of the error.
- "reason": "A String", # Specific reason for the error. Some of the possible values are:
- # - "groupTooBig" - The group of users requested is too large for a single query.
- # - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query.
- # - "notFound" - The requested resource was not found.
- # - "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.
- },
- ],
- },
- },
- "timeMin": "A String", # The start of the interval.
- "groups": { # Expansion of groups.
- "a_key": { # List of calendars that are members of this group.
- "errors": [ # Optional error(s) (if computation for the group failed).
- {
- "domain": "A String", # Domain, or broad category, of the error.
- "reason": "A String", # Specific reason for the error. Some of the possible values are:
- # - "groupTooBig" - The group of users requested is too large for a single query.
- # - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query.
- # - "notFound" - The requested resource was not found.
- # - "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.
- },
- ],
- "calendars": [ # List of calendars' identifiers within a group.
- "A String",
- ],
- },
- },
- }
-
Instance Methods
-
- acl()
-
-Returns the acl Resource.
-
-
- calendarList()
-
-Returns the calendarList Resource.
-
-
- calendars()
-
-Returns the calendars Resource.
-
-
- channels()
-
-Returns the channels Resource.
-
-
- colors()
-
-Returns the colors Resource.
-
-
- events()
-
-Returns the events Resource.
-
-
- freebusy()
-
-Returns the freebusy Resource.
-
-
- settings()
-
-Returns the settings Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/calendar_v3.settings.html b/docs/dyn/calendar_v3.settings.html
deleted file mode 100644
index d55b1dd..0000000
--- a/docs/dyn/calendar_v3.settings.html
+++ /dev/null
@@ -1,125 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(setting)
-Returns a single user setting.
-
- list()
-Returns all user settings for the authenticated user.
-Method Details
-
-
get(setting)
-
Returns a single user setting.
-
-Args:
- setting: string, Name of the user setting. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "calendar#setting", # Type of the resource ("calendar#setting").
- "etag": "A String", # ETag of the resource.
- "id": "A String", # Name of the user setting.
- "value": "A String", # Value of the user setting. The format of the value depends on the ID of the setting.
- }
-
-
list()
-
Returns all user settings for the authenticated user.
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "items": [ # List of user settings.
- {
- "kind": "calendar#setting", # Type of the resource ("calendar#setting").
- "etag": "A String", # ETag of the resource.
- "id": "A String", # Name of the user setting.
- "value": "A String", # Value of the user setting. The format of the value depends on the ID of the setting.
- },
- ],
- "kind": "calendar#settings", # Type of the collection ("calendar#settings").
- "etag": "A String", # Etag of the collection.
- }
-
Instance Methods
-
- electionQuery()
-List of available elections to query.
-
- voterInfoQuery(electionId, body, officialOnly=None)
-Looks up information relevant to a voter based on the voter's registered address.
-Method Details
-
-
electionQuery()
-
List of available elections to query.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # The list of elections available for this version of the API.
- "kind": "civicinfo#electionsQueryResponse", # The kind, fixed to "civicinfo#electionsQueryResponse".
- "elections": [ # A list of available elections
- { # Information about the election that was queried.
- "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
- "id": "A String", # The unique ID of this election.
- "name": "A String", # A displayable name for the election.
- },
- ],
- }
-
-
voterInfoQuery(electionId, body, officialOnly=None)
-
Looks up information relevant to a voter based on the voter's registered address.
-
-Args:
- electionId: string, The unique ID of the election to look up. A list of election IDs can be obtained at.https://www.googleapis.com/civicinfo/{version}/elections (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A request for information about a voter.
- "address": "A String", # The registered address of the voter to look up.
- }
-
- officialOnly: boolean, If set to true, only data from official state sources will be returned.
-
-Returns:
- An object of the form:
-
- { # The result of a voter info lookup query.
- "status": "A String", # The result of the request. One of: success, noStreetSegmentFound, addressUnparseable, noAddressParameter, multipleStreetSegmentsFound, electionOver, electionUnknown, internalLookupFailure
- "earlyVoteSites": [ # Locations where the voter is eligible to vote early, prior to election day
- { # A location where a voter can vote. This may be an early vote site or an election day voting location.
- "startDate": "A String", # The first date that this early vote site may be used. This field is not populated for polling locations.
- "pollingHours": "A String", # A description of when this location is open.
- "endDate": "A String", # The last date that this early vote site may be used. This field is not populated for polling locations.
- "name": "A String", # The name of the early vote site. This field is not populated for polling locations.
- "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use)
- "voterServices": "A String", # The services provided by this early vote site. This field is not populated for polling locations.
- "sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "address": { # A simple representation of an address. # The address of the location
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
- },
- ],
- "kind": "civicinfo#voterInfoResponse", # The kind, fixed to "civicinfo#voterInfoResponse".
- "normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "state": [ # Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.
- { # Describes information about a regional election administrative area.
- "local_jurisdiction": # Object with schema name: AdministrationRegion # The city or county that provides election information for this voter. This object can have the same elements as state.
- "sources": [ # A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "electionAdministrationBody": { # Information about an election administrative body (e.g. County Board of Elections). # The election administration body for this area.
- "absenteeVotingInfoUrl": "A String", # A URL provided by this administrative body for information on absentee voting.
- "votingLocationFinderUrl": "A String", # A URL provided by this administrative body for looking up where to vote.
- "name": "A String", # The name of this election administrative body.
- "electionRegistrationConfirmationUrl": "A String", # A URL provided by this administrative body for confirming that the voter is registered to vote.
- "correspondenceAddress": { # A simple representation of an address. # The mailing address of this administrative body.
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "electionRegistrationUrl": "A String", # A URL provided by this administrative body for looking up how to register to vote.
- "electionOfficials": [ # The election officials for this election administrative body.
- { # Information about individual election officials.
- "title": "A String", # The title of the election official.
- "emailAddress": "A String", # The email address of the election official.
- "name": "A String", # The full name of the election official.
- "officePhoneNumber": "A String", # The office phone number of the election official.
- "faxNumber": "A String", # The fax number of the election official.
- },
- ],
- "electionInfoUrl": "A String", # A URL provided by this administrative body for looking up general election information.
- "electionRulesUrl": "A String", # A URL provided by this administrative body describing election rules to the voter.
- "voter_services": [ # A description of the services this administrative body may provide.
- "A String",
- ],
- "ballotInfoUrl": "A String", # A URL provided by this administrative body to give contest information to the voter.
- "hoursOfOperation": "A String", # A description of the hours of operation for this administrative body.
- "physicalAddress": { # A simple representation of an address. # The physical address of this administrative body.
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- },
- "name": "A String", # The name of the jurisdiction.
- "id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
- },
- ],
- "election": { # Information about the election that was queried. # The election that was queried.
- "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
- "id": "A String", # The unique ID of this election.
- "name": "A String", # A displayable name for the election.
- },
- "pollingLocations": [ # Locations where the voter is eligible to vote on election day. For states with mail-in voting only, these locations will be nearby drop box locations. Drop box locations are free to the voter and may be used instead of placing the ballot in the mail.
- { # A location where a voter can vote. This may be an early vote site or an election day voting location.
- "startDate": "A String", # The first date that this early vote site may be used. This field is not populated for polling locations.
- "pollingHours": "A String", # A description of when this location is open.
- "endDate": "A String", # The last date that this early vote site may be used. This field is not populated for polling locations.
- "name": "A String", # The name of the early vote site. This field is not populated for polling locations.
- "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use)
- "voterServices": "A String", # The services provided by this early vote site. This field is not populated for polling locations.
- "sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "address": { # A simple representation of an address. # The address of the location
- "city": "A String", # The city or town for the address.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line3": "A String", # The third line of the address, if needed.
- "line2": "A String", # The second line the address, if needed.
- "line1": "A String", # The street name and number of this address.
- "locationName": "A String", # The name of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- },
- "id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
- },
- ],
- "contests": [ # Contests that will appear on the voter's ballot
- { # Information about a contest that appears on a voter's ballot.
- "numberVotingFor": "A String", # The number of candidates that a voter may vote for in this contest.
- "office": "A String", # The name of the office for this contest.
- "district": { # Describes the geographic scope of a contest. # Information about the electoral district that this contest is in.
- "scope": "A String", # The geographic scope of this district. If unspecified the district's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special
- "id": "A String", # An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id "34" and a scope of stateUpper.
- "name": "A String", # The name of the district.
- },
- "level": "A String", # The level of office for this contest. One of: federal, state, county, city, other
- "type": "A String", # The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'.
- "ballotPlacement": "A String", # A number specifying the position of this contest on the voter's ballot.
- "sources": [ # A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "official": True or False, # Whether this data comes from an official government source.
- "name": "A String", # The name of the data source.
- },
- ],
- "referendumSubtitle": "A String", # A brief description of the referendum. This field is only populated for contests of type 'Referendum'.
- "primaryParty": "A String", # If this is a partisan election, the name of the party it is for.
- "candidates": [ # The candidate choices for this contest.
- { # Information about a candidate running for elected office.
- "name": "A String", # The candidate's name.
- "photoUrl": "A String", # A URL for a photo of the candidate.
- "candidateUrl": "A String", # The URL for the candidate's campaign web site.
- "channels": [ # A list of known (social) media channels for this candidate.
- { # A social media or web channel for a candidate.
- "type": "A String", # The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter
- "id": "A String", # The unique public identifier for the candidate's channel.
- },
- ],
- "phone": "A String", # The voice phone number for the candidate's campaign office.
- "orderOnBallot": "A String", # The order the candidate appears on the ballot for this contest.
- "party": "A String", # The full name of the party the candidate is a member of.
- "email": "A String", # The email address for the candidate's campaign.
- },
- ],
- "numberElected": "A String", # The number of candidates that will be elected to office in this contest.
- "referendumUrl": "A String", # A link to the referendum. This field is only populated for contests of type 'Referendum'.
- "electorateSpecifications": "A String", # A description of any additional eligibility requirements for voting in this contest.
- "referendumTitle": "A String", # The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.
- "id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
- "special": "A String", # "Yes" or "No" depending on whether this a contest being held outside the normal election cycle.
- },
- ],
- }
-
Instance Methods
-
- elections()
-
-Returns the elections Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/compute_v1beta12.disks.html b/docs/dyn/compute_v1beta12.disks.html
deleted file mode 100644
index b0d5d5d..0000000
--- a/docs/dyn/compute_v1beta12.disks.html
+++ /dev/null
@@ -1,272 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(project, disk)
-Deletes the specified persistent disk resource.
-
- get(project, disk)
-Returns the specified persistent disk resource.
-
- insert(project, body)
-Creates a persistent disk resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of persistent disk resources contained within the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, disk)
-
Deletes the specified persistent disk resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- disk: string, Name of the persistent disk resource to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, disk)
-
Returns the specified persistent disk resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- disk: string, Name of the persistent disk resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a persistent disk resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of persistent disk resources contained within the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The persistent disk resources.
- {
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#diskList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, firewall)
-Deletes the specified firewall resource.
-
- get(project, firewall)
-Returns the specified firewall resource.
-
- insert(project, body)
-Creates a firewall resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of firewall resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(project, firewall, body)
-Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
-
- update(project, firewall, body)
-Updates the specified firewall resource with the data included in the request.
-Method Details
-
-
delete(project, firewall)
-
Deletes the specified firewall resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, firewall)
-
Returns the specified firewall resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a firewall resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of firewall resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The firewall resources.
- {
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#firewallList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(project, firewall, body)
-
Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
update(project, firewall, body)
-
Updates the specified firewall resource with the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
Instance Methods
-
- disks()
-
-Returns the disks Resource.
-
-
- firewalls()
-
-Returns the firewalls Resource.
-
-
- images()
-
-Returns the images Resource.
-
-
- instances()
-
-Returns the instances Resource.
-
-
- kernels()
-
-Returns the kernels Resource.
-
-
- machineTypes()
-
-Returns the machineTypes Resource.
-
-
- networks()
-
-Returns the networks Resource.
-
-
- operations()
-
-Returns the operations Resource.
-
-
- projects()
-
-Returns the projects Resource.
-
-
- snapshots()
-
-Returns the snapshots Resource.
-
-
- zones()
-
-Returns the zones Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/compute_v1beta12.images.html b/docs/dyn/compute_v1beta12.images.html
deleted file mode 100644
index 976550c..0000000
--- a/docs/dyn/compute_v1beta12.images.html
+++ /dev/null
@@ -1,284 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(project, image)
-Deletes the specified image resource.
-
- get(project, image)
-Returns the specified image resource.
-
- insert(project, body)
-Creates an image resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of image resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, image)
-
Deletes the specified image resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- image: string, Name of the image resource to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, image)
-
Returns the specified image resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- image: string, Name of the image resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "compute#image", # Type of the resource.
- "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
- "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
- },
- "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
- "diskSnapshot": { # Not yet implemented.
- "source": "A String", # URL of the disk snapshot.
- },
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates an image resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "compute#image", # Type of the resource.
- "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
- "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
- },
- "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
- "diskSnapshot": { # Not yet implemented.
- "source": "A String", # URL of the disk snapshot.
- },
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of image resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The disk image resources.
- {
- "kind": "compute#image", # Type of the resource.
- "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
- "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
- },
- "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
- "diskSnapshot": { # Not yet implemented.
- "source": "A String", # URL of the disk snapshot.
- },
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#imageList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- addAccessConfig(project, instance, network_interface, body)
-Adds an access config to an instance's network interface.
-
- delete(project, instance)
-Deletes the specified instance resource.
-
- deleteAccessConfig(project, instance, access_config, network_interface)
-Deletes an access config from an instance's network interface.
-
- get(project, instance)
-Returns the specified instance resource.
-
- insert(project, body)
-Creates an instance resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of instance resources contained within the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
addAccessConfig(project, instance, network_interface, body)
-
Adds an access config to an instance's network interface.
-
-Args:
- project: string, Project name. (required)
- instance: string, Instance name. (required)
- network_interface: string, Network interface name. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If left blank, the external IP will be drawn from a shared ephemeral pool.
-}
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
delete(project, instance)
-
Deletes the specified instance resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- instance: string, Name of the instance resource to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
deleteAccessConfig(project, instance, access_config, network_interface)
-
Deletes an access config from an instance's network interface.
-
-Args:
- project: string, Project name. (required)
- instance: string, Instance name. (required)
- access_config: string, Access config name. (required)
- network_interface: string, Network interface name. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, instance)
-
Returns the specified instance resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- instance: string, Name of the instance resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING" (output only).
- "kind": "compute#instance", # Type of the resource.
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
- "tags": [ # An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "image": "A String", # An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- {
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "deleteOnTerminate": True or False, # Persistent disk only; If true, delete the disk and all its data when the associated instance is deleted. This property defaults to false if not specified.
- "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- {
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "kind": "compute#serviceAccount", # Type of the resource.
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- {
- "network": "A String", # URL of the network resource attached to this interface.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- {
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If left blank, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address to assign to this instance. If not specified, one will be assigned from the available range.
- "kind": "compute#networkInterface", # Type of the resource.
- "name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 15000 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must be unique.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- },
- }
-
-
insert(project, body)
-
Creates an instance resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING" (output only).
- "kind": "compute#instance", # Type of the resource.
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
- "tags": [ # An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "image": "A String", # An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- {
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "deleteOnTerminate": True or False, # Persistent disk only; If true, delete the disk and all its data when the associated instance is deleted. This property defaults to false if not specified.
- "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- {
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "kind": "compute#serviceAccount", # Type of the resource.
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- {
- "network": "A String", # URL of the network resource attached to this interface.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- {
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If left blank, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address to assign to this instance. If not specified, one will be assigned from the available range.
- "kind": "compute#networkInterface", # Type of the resource.
- "name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 15000 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must be unique.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of instance resources contained within the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of instance resources.
- {
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING" (output only).
- "kind": "compute#instance", # Type of the resource.
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
- "tags": [ # An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "image": "A String", # An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- {
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "deleteOnTerminate": True or False, # Persistent disk only; If true, delete the disk and all its data when the associated instance is deleted. This property defaults to false if not specified.
- "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- {
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "kind": "compute#serviceAccount", # Type of the resource.
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- {
- "network": "A String", # URL of the network resource attached to this interface.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- {
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If left blank, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address to assign to this instance. If not specified, one will be assigned from the available range.
- "kind": "compute#networkInterface", # Type of the resource.
- "name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 15000 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must be unique.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- },
- },
- ],
- "kind": "compute#instanceList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project, kernel)
-Returns the specified kernel resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of kernel resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, kernel)
-
Returns the specified kernel resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- kernel: string, Name of the kernel resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "compute#kernel", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of kernel resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The kernel resources.
- {
- "kind": "compute#kernel", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "kind": "compute#kernelList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project, machineType)
-Returns the specified machine type resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of machine type resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, machineType)
-
Returns the specified machine type resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- machineType: string, Name of the machine type resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "guestCpus": 42, # Count of CPUs exposed to the instance.
- "imageSpaceGb": 42, # Space allotted for the image, defined in GB.
- "kind": "compute#machineType", # Type of the resource.
- "ephemeralDisks": [ # List of extended ephemeral disks assigned to the instance.
- {
- "diskGb": 42, # Size of the ephemeral disk, defined in GB.
- },
- ],
- "maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
- "description": "A String", # An optional textual description of the resource.
- "maximumPersistentDisks": 42, # Maximum persistent disks allowed.
- "name": "A String", # Name of the resource.
- "memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
- "availableZone": [ # The zones that this machine type can run in.
- "",
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "hostCpus": 42, # Count of physical CPUs reserved on the virtual machine host. Deprecated.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of machine type resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The machine type resources.
- {
- "guestCpus": 42, # Count of CPUs exposed to the instance.
- "imageSpaceGb": 42, # Space allotted for the image, defined in GB.
- "kind": "compute#machineType", # Type of the resource.
- "ephemeralDisks": [ # List of extended ephemeral disks assigned to the instance.
- {
- "diskGb": 42, # Size of the ephemeral disk, defined in GB.
- },
- ],
- "maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
- "description": "A String", # An optional textual description of the resource.
- "maximumPersistentDisks": 42, # Maximum persistent disks allowed.
- "name": "A String", # Name of the resource.
- "memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
- "availableZone": [ # The zones that this machine type can run in.
- "",
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "hostCpus": 42, # Count of physical CPUs reserved on the virtual machine host. Deprecated.
- },
- ],
- "kind": "compute#machineTypeList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, network)
-Deletes the specified network resource.
-
- get(project, network)
-Returns the specified network resource.
-
- insert(project, body)
-Creates a network resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of network resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, network)
-
Deletes the specified network resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- network: string, Name of the network resource to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, network)
-
Returns the specified network resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- network: string, Name of the network resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "compute#network", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a network resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "compute#network", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of network resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The network resources.
- {
- "kind": "compute#network", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#networkList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, operation)
-Deletes the specified operation resource.
-
- get(project, operation)
-Retrieves the specified operation resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of operation resources contained within the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, operation)
-
Deletes the specified operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- operation: string, Name of the operation resource to delete. (required)
-
-
-
get(project, operation)
-
Retrieves the specified operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- operation: string, Name of the operation resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of operation resources contained within the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The operation resources.
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- },
- ],
- "kind": "compute#operationList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project)
-Returns the specified project resource.
-
- setCommonInstanceMetadata(project, body)
-Sets metadata common to all instances within the specified project using the data included in the request.
-Method Details
-
-
get(project)
-
Returns the specified project resource.
-
-Args:
- project: string, Name of the project resource to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "compute#project", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "commonInstanceMetadata": { # Metadata key/value pairs available to all instances contained in this project.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 15000 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must be unique.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- },
- "externalIpAddresses": [ # Internet available IP addresses available for use in this project.
- "A String",
- ],
- "quotas": [ # Quotas assigned to this project.
- {
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
setCommonInstanceMetadata(project, body)
-
Sets metadata common to all instances within the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 15000 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must be unique.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
-}
-
-
-
Instance Methods
-
- delete(project, snapshot)
-Deletes the specified persistent disk snapshot resource.
-
- get(project, snapshot)
-Returns the specified persistent disk snapshot resource.
-
- insert(project, body)
-Creates a persistent disk snapshot resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of persistent disk snapshot resources contained within the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, snapshot)
-
Deletes the specified persistent disk snapshot resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- snapshot: string, Name of the persistent disk snapshot resource to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, snapshot)
-
Returns the specified persistent disk snapshot resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- snapshot: string, Name of the persistent disk snapshot resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # The status of the persistent disk snapshot (output only).
- "kind": "compute#snapshot", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a persistent disk snapshot resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # The status of the persistent disk snapshot (output only).
- "kind": "compute#snapshot", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of persistent disk snapshot resources contained within the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The persistent snapshot resources.
- {
- "status": "A String", # The status of the persistent disk snapshot (output only).
- "kind": "compute#snapshot", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#snapshotList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project, zone)
-Returns the specified zone resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of zone resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, zone)
-
Returns the specified zone resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the zone. "UP" or "DOWN".
- "kind": "compute#zone", # Type of the resource.
- "availableMachineType": [ # The machine types that can be used in this zone (output only).
- "",
- ],
- "description": "A String", # Textual description of the resource.
- "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
- {
- "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
- "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
- "name": "A String", # Name of the maintenance window.
- "description": "A String", # Textual description of the maintenance window.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of zone resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The zone resources.
- {
- "status": "A String", # Status of the zone. "UP" or "DOWN".
- "kind": "compute#zone", # Type of the resource.
- "availableMachineType": [ # The machine types that can be used in this zone (output only).
- "",
- ],
- "description": "A String", # Textual description of the resource.
- "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
- {
- "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
- "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
- "name": "A String", # Name of the maintenance window.
- "description": "A String", # Textual description of the maintenance window.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "kind": "compute#zoneList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, disk)
-Deletes the specified persistent disk resource.
-
- get(project, disk)
-Returns the specified persistent disk resource.
-
- insert(project, body)
-Creates a persistent disk resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of persistent disk resources contained within the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, disk)
-
Deletes the specified persistent disk resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- disk: string, Name of the persistent disk resource to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, disk)
-
Returns the specified persistent disk resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- disk: string, Name of the persistent disk resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a persistent disk resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of persistent disk resources contained within the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The persistent disk resources.
- {
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL for the zone where the persistent disk resides; provided by the client when the disk is created. A persistent disk must reside in the same zone as the instance to which it is attached.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#diskList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, firewall)
-Deletes the specified firewall resource.
-
- get(project, firewall)
-Returns the specified firewall resource.
-
- insert(project, body)
-Creates a firewall resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of firewall resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(project, firewall, body)
-Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
-
- update(project, firewall, body)
-Updates the specified firewall resource with the data included in the request.
-Method Details
-
-
delete(project, firewall)
-
Deletes the specified firewall resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, firewall)
-
Returns the specified firewall resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a firewall resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of firewall resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The firewall resources.
- {
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#firewallList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(project, firewall, body)
-
Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
update(project, firewall, body)
-
Updates the specified firewall resource with the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80,"443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
Instance Methods
-
- disks()
-
-Returns the disks Resource.
-
-
- firewalls()
-
-Returns the firewalls Resource.
-
-
- images()
-
-Returns the images Resource.
-
-
- instances()
-
-Returns the instances Resource.
-
-
- kernels()
-
-Returns the kernels Resource.
-
-
- machineTypes()
-
-Returns the machineTypes Resource.
-
-
- networks()
-
-Returns the networks Resource.
-
-
- operations()
-
-Returns the operations Resource.
-
-
- projects()
-
-Returns the projects Resource.
-
-
- snapshots()
-
-Returns the snapshots Resource.
-
-
- zones()
-
-Returns the zones Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/compute_v1beta13.images.html b/docs/dyn/compute_v1beta13.images.html
deleted file mode 100644
index 938a946..0000000
--- a/docs/dyn/compute_v1beta13.images.html
+++ /dev/null
@@ -1,284 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(project, image)
-Deletes the specified image resource.
-
- get(project, image)
-Returns the specified image resource.
-
- insert(project, body)
-Creates an image resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of image resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, image)
-
Deletes the specified image resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- image: string, Name of the image resource to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, image)
-
Returns the specified image resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- image: string, Name of the image resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "compute#image", # Type of the resource.
- "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
- "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
- },
- "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
- "diskSnapshot": { # Not yet implemented.
- "source": "A String", # URL of the disk snapshot.
- },
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates an image resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "compute#image", # Type of the resource.
- "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
- "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
- },
- "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
- "diskSnapshot": { # Not yet implemented.
- "source": "A String", # URL of the disk snapshot.
- },
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of image resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The disk image resources.
- {
- "kind": "compute#image", # Type of the resource.
- "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
- "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
- },
- "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
- "diskSnapshot": { # Not yet implemented.
- "source": "A String", # URL of the disk snapshot.
- },
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#imageList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- addAccessConfig(project, instance, network_interface, body)
-Adds an access config to an instance's network interface.
-
- delete(project, instance)
-Deletes the specified instance resource.
-
- deleteAccessConfig(project, instance, access_config, network_interface)
-Deletes an access config from an instance's network interface.
-
- get(project, instance)
-Returns the specified instance resource.
-
- getSerialPortOutput(project, instance)
-Returns the specified instance's serial port output.
-
- insert(project, body)
-Creates an instance resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of instance resources contained within the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
addAccessConfig(project, instance, network_interface, body)
-
Adds an access config to an instance's network interface.
-
-Args:
- project: string, Project name. (required)
- instance: string, Instance name. (required)
- network_interface: string, Network interface name. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
-}
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
delete(project, instance)
-
Deletes the specified instance resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- instance: string, Name of the instance resource to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
deleteAccessConfig(project, instance, access_config, network_interface)
-
Deletes an access config from an instance's network interface.
-
-Args:
- project: string, Project name. (required)
- instance: string, Instance name. (required)
- access_config: string, Access config name. (required)
- network_interface: string, Network interface name. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, instance)
-
Returns the specified instance resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- instance: string, Name of the instance resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPED", "TERMINATED", and "STOPPING" (output only).
- "kind": "compute#instance", # Type of the resource.
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
- "tags": [ # An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "image": "A String", # An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- {
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "deleteOnTerminate": True or False, # Persistent disk only; If true, delete the disk and all its data when the associated instance is deleted. This property defaults to false if not specified.
- "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- {
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "kind": "compute#serviceAccount", # Type of the resource.
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- {
- "network": "A String", # URL of the network resource attached to this interface.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- {
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address to assign to this instance. If not specified, one will be assigned from the available range.
- "kind": "compute#networkInterface", # Type of the resource.
- "name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- },
- }
-
-
getSerialPortOutput(project, instance)
-
Returns the specified instance's serial port output.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- instance: string, Name of the instance scoping this request. (required)
-
-Returns:
- An object of the form:
-
- { # An instance serial console output.
- "kind": "compute#serialPortOutput", # Type of the resource.
- "selfLink": "A String", # Server defined URL for the resource.
- "contents": "A String", # The contents of the console output.
- }
-
-
insert(project, body)
-
Creates an instance resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPED", "TERMINATED", and "STOPPING" (output only).
- "kind": "compute#instance", # Type of the resource.
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
- "tags": [ # An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "image": "A String", # An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- {
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "deleteOnTerminate": True or False, # Persistent disk only; If true, delete the disk and all its data when the associated instance is deleted. This property defaults to false if not specified.
- "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- {
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "kind": "compute#serviceAccount", # Type of the resource.
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- {
- "network": "A String", # URL of the network resource attached to this interface.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- {
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address to assign to this instance. If not specified, one will be assigned from the available range.
- "kind": "compute#networkInterface", # Type of the resource.
- "name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- },
-}
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of instance resources contained within the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of instance resources.
- {
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPED", "TERMINATED", and "STOPPING" (output only).
- "kind": "compute#instance", # Type of the resource.
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone resource describing where this instance should be hosted; provided by the client when the instance is created.
- "tags": [ # An optional set of tags applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client when the instance is created. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "image": "A String", # An optional URL of the disk image resource to be to be installed on this instance; provided by the client when the instance is created. If not specified, the server will choose a default image.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- {
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "deleteOnTerminate": True or False, # Persistent disk only; If true, delete the disk and all its data when the associated instance is deleted. This property defaults to false if not specified.
- "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- {
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "kind": "compute#serviceAccount", # Type of the resource.
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- {
- "network": "A String", # URL of the network resource attached to this interface.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- {
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address to assign to this instance. If not specified, one will be assigned from the available range.
- "kind": "compute#networkInterface", # Type of the resource.
- "name": "A String", # Name of the resource, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "metadata": { # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- },
- },
- ],
- "kind": "compute#instanceList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project, kernel)
-Returns the specified kernel resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of kernel resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, kernel)
-
Returns the specified kernel resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- kernel: string, Name of the kernel resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "compute#kernel", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of kernel resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The kernel resources.
- {
- "kind": "compute#kernel", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "kind": "compute#kernelList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project, machineType)
-Returns the specified machine type resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of machine type resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, machineType)
-
Returns the specified machine type resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- machineType: string, Name of the machine type resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "guestCpus": 42, # Count of CPUs exposed to the instance.
- "imageSpaceGb": 42, # Space allotted for the image, defined in GB.
- "kind": "compute#machineType", # Type of the resource.
- "ephemeralDisks": [ # List of extended ephemeral disks assigned to the instance.
- {
- "diskGb": 42, # Size of the ephemeral disk, defined in GB.
- },
- ],
- "maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
- "description": "A String", # An optional textual description of the resource.
- "maximumPersistentDisks": 42, # Maximum persistent disks allowed.
- "memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
- "availableZone": [ # The zones that this machine type can run in.
- "A String",
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of machine type resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The machine type resources.
- {
- "guestCpus": 42, # Count of CPUs exposed to the instance.
- "imageSpaceGb": 42, # Space allotted for the image, defined in GB.
- "kind": "compute#machineType", # Type of the resource.
- "ephemeralDisks": [ # List of extended ephemeral disks assigned to the instance.
- {
- "diskGb": 42, # Size of the ephemeral disk, defined in GB.
- },
- ],
- "maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
- "description": "A String", # An optional textual description of the resource.
- "maximumPersistentDisks": 42, # Maximum persistent disks allowed.
- "memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
- "availableZone": [ # The zones that this machine type can run in.
- "A String",
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "kind": "compute#machineTypeList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, network)
-Deletes the specified network resource.
-
- get(project, network)
-Returns the specified network resource.
-
- insert(project, body)
-Creates a network resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of network resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, network)
-
Deletes the specified network resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- network: string, Name of the network resource to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, network)
-
Returns the specified network resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- network: string, Name of the network resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "compute#network", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a network resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "compute#network", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of network resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The network resources.
- {
- "kind": "compute#network", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#networkList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, operation)
-Deletes the specified operation resource.
-
- get(project, operation)
-Retrieves the specified operation resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of operation resources contained within the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, operation)
-
Deletes the specified operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- operation: string, Name of the operation resource to delete. (required)
-
-
-
get(project, operation)
-
Retrieves the specified operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- operation: string, Name of the operation resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of operation resources contained within the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The operation resources.
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- },
- ],
- "kind": "compute#operationList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project)
-Returns the specified project resource.
-
- setCommonInstanceMetadata(project, body)
-Sets metadata common to all instances within the specified project using the data included in the request.
-Method Details
-
-
get(project)
-
Returns the specified project resource.
-
-Args:
- project: string, Name of the project resource to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "compute#project", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "commonInstanceMetadata": { # Metadata key/value pairs available to all instances contained in this project.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- },
- "externalIpAddresses": [ # Internet available IP addresses available for use in this project.
- "A String",
- ],
- "quotas": [ # Quotas assigned to this project.
- {
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
setCommonInstanceMetadata(project, body)
-
Sets metadata common to all instances within the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
-}
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
Instance Methods
-
- delete(project, snapshot)
-Deletes the specified persistent disk snapshot resource.
-
- get(project, snapshot)
-Returns the specified persistent disk snapshot resource.
-
- insert(project, body)
-Creates a persistent disk snapshot resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of persistent disk snapshot resources contained within the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, snapshot)
-
Deletes the specified persistent disk snapshot resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- snapshot: string, Name of the persistent disk snapshot resource to delete. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, snapshot)
-
Returns the specified persistent disk snapshot resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- snapshot: string, Name of the persistent disk snapshot resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # The status of the persistent disk snapshot (output only).
- "kind": "compute#snapshot", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a persistent disk snapshot resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # The status of the persistent disk snapshot (output only).
- "kind": "compute#snapshot", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource.
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of persistent disk snapshot resources contained within the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The persistent snapshot resources.
- {
- "status": "A String", # The status of the persistent disk snapshot (output only).
- "kind": "compute#snapshot", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#snapshotList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project, zone)
-Returns the specified zone resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of zone resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, zone)
-
Returns the specified zone resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone resource to return. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the zone. "UP" or "DOWN".
- "kind": "compute#zone", # Type of the resource.
- "availableMachineType": [ # The machine types that can be used in this zone (output only).
- "A String",
- ],
- "description": "A String", # Textual description of the resource.
- "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
- {
- "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
- "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
- "name": "A String", # Name of the maintenance window.
- "description": "A String", # Textual description of the maintenance window.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of zone resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The zone resources.
- {
- "status": "A String", # Status of the zone. "UP" or "DOWN".
- "kind": "compute#zone", # Type of the resource.
- "availableMachineType": [ # The machine types that can be used in this zone (output only).
- "A String",
- ],
- "description": "A String", # Textual description of the resource.
- "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
- {
- "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
- "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
- "name": "A String", # Name of the maintenance window.
- "description": "A String", # Textual description of the maintenance window.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "kind": "compute#zoneList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, zone, disk)
-Deletes the specified persistent disk resource.
-
- get(project, zone, disk)
-Returns the specified persistent disk resource.
-
- insert(project, zone, body, sourceImage=None)
-Creates a persistent disk resource in the specified project using the data included in the request.
-
- list(project, zone, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of persistent disk resources contained within the specified zone.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, zone, disk)
-
Deletes the specified persistent disk resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- disk: string, Name of the persistent disk resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, zone, disk)
-
Returns the specified persistent disk resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- disk: string, Name of the persistent disk resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, zone, body, sourceImage=None)
-
Creates a persistent disk resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
- sourceImage: string, Optional. Source image to restore onto a disk.
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, zone, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of persistent disk resources contained within the specified zone.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of persistent disk resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The persistent disk resources.
- { # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#diskList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, firewall)
-Deletes the specified firewall resource.
-
- get(project, firewall)
-Returns the specified firewall resource.
-
- insert(project, body)
-Creates a firewall resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of firewall resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(project, firewall, body)
-Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
-
- update(project, firewall, body)
-Updates the specified firewall resource with the data included in the request.
-Method Details
-
-
delete(project, firewall)
-
Deletes the specified firewall resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, firewall)
-
Returns the specified firewall resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a firewall resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of firewall resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of firewall resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The firewall resources.
- { # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#firewallList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(project, firewall, body)
-
Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
update(project, firewall, body)
-
Updates the specified firewall resource with the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
Instance Methods
-
- delete(project, operation)
-Deletes the specified operation resource.
-
- get(project, operation)
-Retrieves the specified operation resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of operation resources contained within the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, operation)
-
Deletes the specified operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- operation: string, Name of the operation resource to delete. (required)
-
-
-
get(project, operation)
-
Retrieves the specified operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- operation: string, Name of the operation resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of operation resources contained within the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of operation resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The operation resources.
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- },
- ],
- "kind": "compute#operationList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- disks()
-
-Returns the disks Resource.
-
-
- firewalls()
-
-Returns the firewalls Resource.
-
-
- globalOperations()
-
-Returns the globalOperations Resource.
-
-
- images()
-
-Returns the images Resource.
-
-
- instances()
-
-Returns the instances Resource.
-
-
- kernels()
-
-Returns the kernels Resource.
-
-
- machineTypes()
-
-Returns the machineTypes Resource.
-
-
- networks()
-
-Returns the networks Resource.
-
-
- projects()
-
-Returns the projects Resource.
-
-
- snapshots()
-
-Returns the snapshots Resource.
-
-
- zoneOperations()
-
-Returns the zoneOperations Resource.
-
-
- zones()
-
-Returns the zones Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/compute_v1beta14.images.html b/docs/dyn/compute_v1beta14.images.html
deleted file mode 100644
index a208737..0000000
--- a/docs/dyn/compute_v1beta14.images.html
+++ /dev/null
@@ -1,391 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(project, image)
-Deletes the specified image resource.
-
- deprecate(project, image, body)
-Sets the deprecation status of an image. If no message body is given, clears the deprecation status instead.
-
- get(project, image)
-Returns the specified image resource.
-
- insert(project, body)
-Creates an image resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of image resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, image)
-
Deletes the specified image resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- image: string, Name of the image resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
deprecate(project, image, body)
-
Sets the deprecation status of an image. If no message body is given, clears the deprecation status instead.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- image: string, Image name. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Deprecation status for a public resource.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
-}
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, image)
-
Returns the specified image resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- image: string, Name of the image resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A disk image resource.
- "kind": "compute#image", # Type of the resource.
- "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
- "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
- },
- "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates an image resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A disk image resource.
- "kind": "compute#image", # Type of the resource.
- "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
- "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
- },
- "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of image resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of disk image resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The disk image resources.
- { # A disk image resource.
- "kind": "compute#image", # Type of the resource.
- "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
- "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
- },
- "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#imageList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- addAccessConfig(project, zone, instance, network_interface, body)
-Adds an access config to an instance's network interface.
-
- attachDisk(project, zone, instance, body)
-Attaches a disk resource to an instance.
-
- delete(project, zone, instance)
-Deletes the specified instance resource.
-
- deleteAccessConfig(project, zone, instance, access_config, network_interface)
-Deletes an access config from an instance's network interface.
-
- detachDisk(project, zone, instance, deviceName)
-Detaches a disk from an instance.
-
- get(project, zone, instance)
-Returns the specified instance resource.
-
- getSerialPortOutput(project, zone, instance)
-Returns the specified instance's serial port output.
-
- insert(project, zone, body)
-Creates an instance resource in the specified project using the data included in the request.
-
- list(project, zone, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of instance resources contained within the specified zone.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- setMetadata(project, zone, instance, body)
-Sets metadata for the specified instance to the data included in the request.
-
- setTags(project, zone, instance, body)
-Sets tags for the specified instance to the data included in the request.
-Method Details
-
-
addAccessConfig(project, zone, instance, network_interface, body)
-
Adds an access config to an instance's network interface.
-
-Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
- network_interface: string, Network interface name. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
-}
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
attachDisk(project, zone, instance, body)
-
Attaches a disk resource to an instance.
-
-Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
delete(project, zone, instance)
-
Deletes the specified instance resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Name of the instance resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
deleteAccessConfig(project, zone, instance, access_config, network_interface)
-
Deletes an access config from an instance's network interface.
-
-Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
- access_config: string, Access config name. (required)
- network_interface: string, Network interface name. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
detachDisk(project, zone, instance, deviceName)
-
Detaches a disk from an instance.
-
-Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
- deviceName: string, Disk device name to detach. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, zone, instance)
-
Returns the specified instance resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Name of the instance resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kernel": "A String", # URL of the kernel resource to use when booting. In case of booting from persistent disk, this parameter is required. When booting from a disk image, it is optional, but may be provided to use a different kernel than the one associated with the image.
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Reserved for future use.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
- "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
- },
- "image": "A String", # An optional URL of the disk image resource to be installed on this instance; provided by the client when the instance is created. Alternatively to passing the image, the client may choose to boot from a persistent disk, by setting boot=true flag on one of the entries in disks[] collection.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- { # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- { # A service account.
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface. If not specified, one will be assigned from the available range.
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
- },
- }
-
-
getSerialPortOutput(project, zone, instance)
-
Returns the specified instance's serial port output.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Name of the instance scoping this request. (required)
-
-Returns:
- An object of the form:
-
- { # An instance serial console output.
- "kind": "compute#serialPortOutput", # Type of the resource.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "contents": "A String", # The contents of the console output.
- }
-
-
insert(project, zone, body)
-
Creates an instance resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kernel": "A String", # URL of the kernel resource to use when booting. In case of booting from persistent disk, this parameter is required. When booting from a disk image, it is optional, but may be provided to use a different kernel than the one associated with the image.
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Reserved for future use.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
- "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
- },
- "image": "A String", # An optional URL of the disk image resource to be installed on this instance; provided by the client when the instance is created. Alternatively to passing the image, the client may choose to boot from a persistent disk, by setting boot=true flag on one of the entries in disks[] collection.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- { # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- { # A service account.
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface. If not specified, one will be assigned from the available range.
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
- },
-}
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, zone, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of instance resources contained within the specified zone.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of instance resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of instance resources.
- { # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kernel": "A String", # URL of the kernel resource to use when booting. In case of booting from persistent disk, this parameter is required. When booting from a disk image, it is optional, but may be provided to use a different kernel than the one associated with the image.
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Reserved for future use.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
- "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
- },
- "image": "A String", # An optional URL of the disk image resource to be installed on this instance; provided by the client when the instance is created. Alternatively to passing the image, the client may choose to boot from a persistent disk, by setting boot=true flag on one of the entries in disks[] collection.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- { # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value.
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "type": "A String", # Type of the disk, either "EPHEMERAL" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- { # A service account.
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address to assign to the instance for this network interface. If not specified, one will be assigned from the available range.
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
- },
- },
- ],
- "kind": "compute#instanceList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
setMetadata(project, zone, instance, body)
-
Sets metadata for the specified instance to the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Name of the instance scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A metadata key/value entry.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
-}
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
setTags(project, zone, instance, body)
-
Sets tags for the specified instance to the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Name of the instance scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A set of instance tags.
- "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
Instance Methods
-
- get(project, kernel)
-Returns the specified kernel resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of kernel resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, kernel)
-
Returns the specified kernel resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- kernel: string, Name of the kernel resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A kernel resource.
- "kind": "compute#kernel", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this kernel.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of kernel resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of kernel resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The kernel resources.
- { # A kernel resource.
- "kind": "compute#kernel", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this kernel.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "kind": "compute#kernelList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project, machineType)
-Returns the specified machine type resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of machine type resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, machineType)
-
Returns the specified machine type resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- machineType: string, Name of the machine type resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A machine type resource.
- "guestCpus": 42, # Count of CPUs exposed to the instance.
- "imageSpaceGb": 42, # Space allotted for the image, defined in GB.
- "kind": "compute#machineType", # Type of the resource.
- "ephemeralDisks": [ # List of extended ephemeral disks assigned to the instance.
- {
- "diskGb": 42, # Size of the ephemeral disk, defined in GB.
- },
- ],
- "maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
- "description": "A String", # An optional textual description of the resource.
- "maximumPersistentDisks": 42, # Maximum persistent disks allowed.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this machine type.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
- "availableZone": [ # The zones that this machine type can run in.
- "A String",
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of machine type resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of machine type resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The machine type resources.
- { # A machine type resource.
- "guestCpus": 42, # Count of CPUs exposed to the instance.
- "imageSpaceGb": 42, # Space allotted for the image, defined in GB.
- "kind": "compute#machineType", # Type of the resource.
- "ephemeralDisks": [ # List of extended ephemeral disks assigned to the instance.
- {
- "diskGb": 42, # Size of the ephemeral disk, defined in GB.
- },
- ],
- "maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
- "description": "A String", # An optional textual description of the resource.
- "maximumPersistentDisks": 42, # Maximum persistent disks allowed.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this machine type.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
- "availableZone": [ # The zones that this machine type can run in.
- "A String",
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "kind": "compute#machineTypeList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, network)
-Deletes the specified network resource.
-
- get(project, network)
-Returns the specified network resource.
-
- insert(project, body)
-Creates a network resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of network resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, network)
-
Deletes the specified network resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- network: string, Name of the network resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, network)
-
Returns the specified network resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- network: string, Name of the network resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A network resource.
- "kind": "compute#network", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a network resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A network resource.
- "kind": "compute#network", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of network resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of network resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The network resources.
- { # A network resource.
- "kind": "compute#network", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#networkList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project)
-Returns the specified project resource.
-
- setCommonInstanceMetadata(project, body)
-Sets metadata common to all instances within the specified project using the data included in the request.
-Method Details
-
-
get(project)
-
Returns the specified project resource.
-
-Args:
- project: string, Name of the project resource to retrieve. (required)
-
-Returns:
- An object of the form:
-
- { # A project resource. Projects can be created only in the APIs Console. Unless marked otherwise, values can only be modified in the console.
- "kind": "compute#project", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
- },
- "externalIpAddresses": [ # Internet available IP addresses available for use in this project.
- "A String",
- ],
- "quotas": [ # Quotas assigned to this project.
- { # A quotas entry.
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
setCommonInstanceMetadata(project, body)
-
Sets metadata common to all instances within the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A metadata key/value entry.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
-}
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
Instance Methods
-
- delete(project, snapshot)
-Deletes the specified persistent disk snapshot resource.
-
- get(project, snapshot)
-Returns the specified persistent disk snapshot resource.
-
- insert(project, body)
-Creates a persistent disk snapshot resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of persistent disk snapshot resources contained within the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, snapshot)
-
Deletes the specified persistent disk snapshot resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- snapshot: string, Name of the persistent disk snapshot resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, snapshot)
-
Returns the specified persistent disk snapshot resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- snapshot: string, Name of the persistent disk snapshot resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A persistent disk snapshot resource.
- "status": "A String", # The status of the persistent disk snapshot (output only).
- "kind": "compute#snapshot", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a persistent disk snapshot resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A persistent disk snapshot resource.
- "status": "A String", # The status of the persistent disk snapshot (output only).
- "kind": "compute#snapshot", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of persistent disk snapshot resources contained within the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of persistent disk snapshot resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The persistent snapshot resources.
- { # A persistent disk snapshot resource.
- "status": "A String", # The status of the persistent disk snapshot (output only).
- "kind": "compute#snapshot", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created.
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#snapshotList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, zone, operation)
-Deletes the specified zone-specific operation resource.
-
- get(project, zone, operation)
-Retrieves the specified zone-specific operation resource.
-
- list(project, zone, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of operation resources contained within the specified zone.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, zone, operation)
-
Deletes the specified zone-specific operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- operation: string, Name of the operation resource to delete. (required)
-
-
-
get(project, zone, operation)
-
Retrieves the specified zone-specific operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- operation: string, Name of the operation resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, zone, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of operation resources contained within the specified zone.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of operation resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The operation resources.
- { # An operation resource, used to manage asynchronous API requests.
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- },
- ],
- "kind": "compute#operationList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project, zone)
-Returns the specified zone resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of zone resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, zone)
-
Returns the specified zone resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A zone resource.
- "status": "A String", # Status of the zone. "UP" or "DOWN".
- "kind": "compute#zone", # Type of the resource.
- "availableMachineType": [ # The machine types that can be used in this zone (output only).
- "A String",
- ],
- "description": "A String", # Textual description of the resource.
- "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
- {
- "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
- "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
- "name": "A String", # Name of the maintenance window.
- "description": "A String", # Textual description of the maintenance window.
- },
- ],
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this zone.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "quotas": [ # Quotas assigned to this zone.
- { # A quotas entry.
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of zone resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of zone resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The zone resources.
- { # A zone resource.
- "status": "A String", # Status of the zone. "UP" or "DOWN".
- "kind": "compute#zone", # Type of the resource.
- "availableMachineType": [ # The machine types that can be used in this zone (output only).
- "A String",
- ],
- "description": "A String", # Textual description of the resource.
- "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
- {
- "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
- "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
- "name": "A String", # Name of the maintenance window.
- "description": "A String", # Textual description of the maintenance window.
- },
- ],
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this zone.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "quotas": [ # Quotas assigned to this zone.
- { # A quotas entry.
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "kind": "compute#zoneList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- aggregatedList(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of addresses grouped by scope.
-
- aggregatedList_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- delete(project, region, address)
-Deletes the specified address resource.
-
- get(project, region, address)
-Returns the specified address resource.
-
- insert(project, region, body)
-Creates an address resource in the specified project using the data included in the request.
-
- list(project, region, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of address resources contained within the specified region.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
aggregatedList(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of addresses grouped by scope.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": { # A map of scoped address lists.
- "a_key": { # Name of the scope containing this set of addresses.
- "warning": { # Informational warning which replaces the list of addresses when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- "addresses": [ # List of addresses contained in this scope.
- { # A reserved address resource.
- "status": "A String", # The status of the address (output only).
- "kind": "compute#address", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "region": "A String", # URL of the region where the address resides (output only).
- "user": "A String", # URL of the resource currently using this address (output only).
- "address": "A String", # The IP address represented by this resource.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- },
- },
- "kind": "compute#addressAggregatedList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
aggregatedList_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
delete(project, region, address)
-
Deletes the specified address resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- region: string, Name of the region scoping this request. (required)
- address: string, Name of the address resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, region, address)
-
Returns the specified address resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- region: string, Name of the region scoping this request. (required)
- address: string, Name of the address resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A reserved address resource.
- "status": "A String", # The status of the address (output only).
- "kind": "compute#address", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "region": "A String", # URL of the region where the address resides (output only).
- "user": "A String", # URL of the resource currently using this address (output only).
- "address": "A String", # The IP address represented by this resource.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, region, body)
-
Creates an address resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- region: string, Name of the region scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A reserved address resource.
- "status": "A String", # The status of the address (output only).
- "kind": "compute#address", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "region": "A String", # URL of the region where the address resides (output only).
- "user": "A String", # URL of the resource currently using this address (output only).
- "address": "A String", # The IP address represented by this resource.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, region, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of address resources contained within the specified region.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- region: string, Name of the region scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of address resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The address resources.
- { # A reserved address resource.
- "status": "A String", # The status of the address (output only).
- "kind": "compute#address", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "region": "A String", # URL of the region where the address resides (output only).
- "user": "A String", # URL of the resource currently using this address (output only).
- "address": "A String", # The IP address represented by this resource.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#addressList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- aggregatedList(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of disks grouped by scope.
-
- aggregatedList_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- createSnapshot(project, zone, disk, body)
-A description of how to use this function
-
- delete(project, zone, disk)
-Deletes the specified persistent disk resource.
-
- get(project, zone, disk)
-Returns the specified persistent disk resource.
-
- insert(project, zone, body, sourceImage=None)
-Creates a persistent disk resource in the specified project using the data included in the request.
-
- list(project, zone, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of persistent disk resources contained within the specified zone.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
aggregatedList(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of disks grouped by scope.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": { # A map of scoped disk lists.
- "a_key": { # Name of the scope containing this set of disks.
- "disks": [ # List of disks contained in this scope.
- { # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "warning": { # Informational warning which replaces the list of disks when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- },
- },
- "kind": "compute#diskAggregatedList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
aggregatedList_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
createSnapshot(project, zone, disk, body)
-
A description of how to use this function
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- disk: string, Name of the persistent disk resource to delete. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A persistent disk snapshot resource.
- "status": "A String", # The status of the persistent disk snapshot (output only).
- "kind": "compute#snapshot", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created (output only).
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
delete(project, zone, disk)
-
Deletes the specified persistent disk resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- disk: string, Name of the persistent disk resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, zone, disk)
-
Returns the specified persistent disk resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- disk: string, Name of the persistent disk resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, zone, body, sourceImage=None)
-
Creates a persistent disk resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
- sourceImage: string, Optional. Source image to restore onto a disk.
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, zone, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of persistent disk resources contained within the specified zone.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of persistent disk resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The persistent disk resources.
- { # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk. Once the source snapshot has been deleted from the system, this field will be cleared, and will not be set even if a snapshot with the same name has been re-created.
- "kind": "compute#disk", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "options": "A String", # Internal use only.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#diskList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, firewall)
-Deletes the specified firewall resource.
-
- get(project, firewall)
-Returns the specified firewall resource.
-
- insert(project, body)
-Creates a firewall resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of firewall resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(project, firewall, body)
-Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
-
- update(project, firewall, body)
-Updates the specified firewall resource with the data included in the request.
-Method Details
-
-
delete(project, firewall)
-
Deletes the specified firewall resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, firewall)
-
Returns the specified firewall resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- #
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a firewall resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- #
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of firewall resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of firewall resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The firewall resources.
- { # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- #
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#firewallList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(project, firewall, body)
-
Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- #
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
update(project, firewall, body)
-
Updates the specified firewall resource with the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- firewall: string, Name of the firewall resource to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A firewall resource.
- "kind": "compute#firewall", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "sourceRanges": [ # A list of IP address blocks expressed in CIDR format which this rule applies to. One or both of sourceRanges and sourceTags may be set; an inbound connection is allowed if either the range or the tag of the source matches.
- "A String",
- ],
- "network": "A String", # URL of the network to which this firewall is applied; provided by the client when the firewall is created.
- "targetTags": [ # A list of instance tags indicating sets of instances located on network which may make network connections as specified in allowed. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
- "A String",
- ],
- "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
- {
- "IPProtocol": "A String", # Required; this is the IP protocol that is allowed for this rule. This can either be a well known protocol string (tcp, udp or icmp) or the IP protocol number.
- "ports": [ # An optional list of ports which are allowed. It is an error to specify this for any protocol that isn't UDP or TCP. Each entry must be either an integer or a range. If not specified, connections through any port are allowed.
- #
- # Example inputs include: ["22"], ["80","443"] and ["12345-12349"].
- "A String",
- ],
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
Instance Methods
-
- aggregatedList(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of all operations grouped by scope.
-
- aggregatedList_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- delete(project, operation)
-Deletes the specified operation resource.
-
- get(project, operation)
-Retrieves the specified operation resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of operation resources contained within the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
aggregatedList(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of all operations grouped by scope.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": { # A map of scoped operation lists.
- "a_key": { # Name of the scope containing this set of operations.
- "operations": [ # List of operations contained in this scope.
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- },
- ],
- "warning": { # Informational warning which replaces the list of operations when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- },
- },
- "kind": "compute#operationAggregatedList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
aggregatedList_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
delete(project, operation)
-
Deletes the specified operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- operation: string, Name of the operation resource to delete. (required)
-
-
-
get(project, operation)
-
Retrieves the specified operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- operation: string, Name of the operation resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of operation resources contained within the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of operation resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The operation resources.
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- },
- ],
- "kind": "compute#operationList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- addresses()
-
-Returns the addresses Resource.
-
-
- disks()
-
-Returns the disks Resource.
-
-
- firewalls()
-
-Returns the firewalls Resource.
-
-
- globalOperations()
-
-Returns the globalOperations Resource.
-
-
- httpHealthChecks()
-
-Returns the httpHealthChecks Resource.
-
-
- images()
-
-Returns the images Resource.
-
-
- instances()
-
-Returns the instances Resource.
-
-
- kernels()
-
-Returns the kernels Resource.
-
-
- machineTypes()
-
-Returns the machineTypes Resource.
-
-
- networks()
-
-Returns the networks Resource.
-
-
- projects()
-
-Returns the projects Resource.
-
-
- regionOperations()
-
-Returns the regionOperations Resource.
-
-
- regions()
-
-Returns the regions Resource.
-
-
- routes()
-
-Returns the routes Resource.
-
-
- snapshots()
-
-Returns the snapshots Resource.
-
-
- zoneOperations()
-
-Returns the zoneOperations Resource.
-
-
- zones()
-
-Returns the zones Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/compute_v1beta15.httpHealthChecks.html b/docs/dyn/compute_v1beta15.httpHealthChecks.html
deleted file mode 100644
index 951e94f..0000000
--- a/docs/dyn/compute_v1beta15.httpHealthChecks.html
+++ /dev/null
@@ -1,156 +0,0 @@
-
-
-
-
-Instance Methods
-
- patch(project, httpHealthCheck, body)
-Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
-Method Details
-
-
patch(project, httpHealthCheck, body)
-
Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP.
- "kind": "compute#httpHealthCheck", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds.
- "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
- "port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
- "healthyThreshold": 42, # A so-far unhealthy VM will be marked healthy after this many consecutive successes. The default value is 2.
- "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
- "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/".
- "unhealthyThreshold": 42, # A so-far healthy VM will be marked unhealthy after this many consecutive failures. The default value is 2.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
Instance Methods
-
- delete(project, image)
-Deletes the specified image resource.
-
- deprecate(project, image, body)
-Sets the deprecation status of an image. If no message body is given, clears the deprecation status instead.
-
- get(project, image)
-Returns the specified image resource.
-
- insert(project, body)
-Creates an image resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of image resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, image)
-
Deletes the specified image resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- image: string, Name of the image resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
deprecate(project, image, body)
-
Sets the deprecation status of an image. If no message body is given, clears the deprecation status instead.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- image: string, Image name. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Deprecation status for a public resource.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
-}
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, image)
-
Returns the specified image resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- image: string, Name of the image resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A disk image resource.
- "status": "A String", # Status of the image (output only). It will be one of the following READY - after image has been successfully created and is ready for use FAILED - if creating the image fails for some reason PENDING - the image creation is in progress An image can be used to create other resources suck as instances only after the image has been successfully created and the status is set to READY.
- "kind": "compute#image", # Type of the resource.
- "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
- "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
- },
- "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates an image resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A disk image resource.
- "status": "A String", # Status of the image (output only). It will be one of the following READY - after image has been successfully created and is ready for use FAILED - if creating the image fails for some reason PENDING - the image creation is in progress An image can be used to create other resources suck as instances only after the image has been successfully created and the status is set to READY.
- "kind": "compute#image", # Type of the resource.
- "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
- "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
- },
- "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of image resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of disk image resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The disk image resources.
- { # A disk image resource.
- "status": "A String", # Status of the image (output only). It will be one of the following READY - after image has been successfully created and is ready for use FAILED - if creating the image fails for some reason PENDING - the image creation is in progress An image can be used to create other resources suck as instances only after the image has been successfully created and the status is set to READY.
- "kind": "compute#image", # Type of the resource.
- "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
- "rawDisk": { # The raw disk image parameters.
- "containerType": "TAR", # The format used to encode and transmit the block device. Should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
- "source": "A String", # The full Google Cloud Storage URL where the disk image is stored; provided by the client when the disk image is created.
- "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created.
- },
- "preferredKernel": "A String", # An optional URL of the preferred kernel for use with this disk image. If not specified, a server defined default kernel will be used.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "sourceType": "RAW", # Must be "RAW"; provided by the client when the disk image is created.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#imageList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- addAccessConfig(project, zone, instance, networkInterface, body)
-Adds an access config to an instance's network interface.
-
- aggregatedList(project, maxResults=None, pageToken=None, filter=None)
-A description of how to use this function
-
- aggregatedList_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- attachDisk(project, zone, instance, body)
-Attaches a disk resource to an instance.
-
- delete(project, zone, instance)
-Deletes the specified instance resource.
-
- deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)
-Deletes an access config from an instance's network interface.
-
- detachDisk(project, zone, instance, deviceName)
-Detaches a disk from an instance.
-
- get(project, zone, instance)
-Returns the specified instance resource.
-
- getSerialPortOutput(project, zone, instance)
-Returns the specified instance's serial port output.
-
- insert(project, zone, body)
-Creates an instance resource in the specified project using the data included in the request.
-
- list(project, zone, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of instance resources contained within the specified zone.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- reset(project, zone, instance)
-Performs a hard reset on the instance.
-
- setMetadata(project, zone, instance, body)
-Sets metadata for the specified instance to the data included in the request.
-
- setTags(project, zone, instance, body)
-Sets tags for the specified instance to the data included in the request.
-Method Details
-
-
addAccessConfig(project, zone, instance, networkInterface, body)
-
Adds an access config to an instance's network interface.
-
-Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
- networkInterface: string, Network interface name. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
-}
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
aggregatedList(project, maxResults=None, pageToken=None, filter=None)
-
A description of how to use this function
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": { # A map of scoped instance lists.
- "a_key": { # Name of the scope containing this set of instances.
- "instances": [ # List of instances contained in this scope.
- { # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kernel": "A String", # URL of the kernel resource to use when booting. In case of booting from persistent disk, this parameter is required. When booting from a disk image, it is optional, but may be provided to use a different kernel than the one associated with the image.
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
- "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
- },
- "image": "A String", # An optional URL of the disk image resource to be installed on this instance; provided by the client when the instance is created. Alternatively to passing the image, the client may choose to boot from a persistent disk, by setting boot=true flag on one of the entries in disks[] collection.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- { # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- { # A service account.
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
- },
- },
- ],
- "warning": { # Informational warning which replaces the list of instances when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- },
- },
- "kind": "compute#instanceAggregatedList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
aggregatedList_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
attachDisk(project, zone, instance, body)
-
Attaches a disk resource to an instance.
-
-Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
delete(project, zone, instance)
-
Deletes the specified instance resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Name of the instance resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)
-
Deletes an access config from an instance's network interface.
-
-Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
- accessConfig: string, Access config name. (required)
- networkInterface: string, Network interface name. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
detachDisk(project, zone, instance, deviceName)
-
Detaches a disk from an instance.
-
-Args:
- project: string, Project name. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Instance name. (required)
- deviceName: string, Disk device name to detach. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, zone, instance)
-
Returns the specified instance resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Name of the instance resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kernel": "A String", # URL of the kernel resource to use when booting. In case of booting from persistent disk, this parameter is required. When booting from a disk image, it is optional, but may be provided to use a different kernel than the one associated with the image.
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
- "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
- },
- "image": "A String", # An optional URL of the disk image resource to be installed on this instance; provided by the client when the instance is created. Alternatively to passing the image, the client may choose to boot from a persistent disk, by setting boot=true flag on one of the entries in disks[] collection.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- { # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- { # A service account.
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
- },
- }
-
-
getSerialPortOutput(project, zone, instance)
-
Returns the specified instance's serial port output.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Name of the instance scoping this request. (required)
-
-Returns:
- An object of the form:
-
- { # An instance serial console output.
- "kind": "compute#serialPortOutput", # Type of the resource.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "contents": "A String", # The contents of the console output.
- }
-
-
insert(project, zone, body)
-
Creates an instance resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kernel": "A String", # URL of the kernel resource to use when booting. In case of booting from persistent disk, this parameter is required. When booting from a disk image, it is optional, but may be provided to use a different kernel than the one associated with the image.
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
- "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
- },
- "image": "A String", # An optional URL of the disk image resource to be installed on this instance; provided by the client when the instance is created. Alternatively to passing the image, the client may choose to boot from a persistent disk, by setting boot=true flag on one of the entries in disks[] collection.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- { # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- { # A service account.
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
- },
-}
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, zone, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of instance resources contained within the specified zone.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of instance resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of instance resources.
- { # An instance resource.
- "status": "A String", # Instance status. One of the following values: "PROVISIONING", "STAGING", "RUNNING", "STOPPING", "STOPPED", "TERMINATED" (output only).
- "kernel": "A String", # URL of the kernel resource to use when booting. In case of booting from persistent disk, this parameter is required. When booting from a disk image, it is optional, but may be provided to use a different kernel than the one associated with the image.
- "kind": "compute#instance", # Type of the resource.
- "canIpForward": True or False, # Allows this instance to send packets with source IP addresses other than its own and receive packets with destination IP addresses other than its own. If this instance will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "zone": "A String", # URL of the zone where the instance resides (output only).
- "tags": { # A set of instance tags. # A list of tags to be applied to this instance. Used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
- "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
- },
- "image": "A String", # An optional URL of the disk image resource to be installed on this instance; provided by the client when the instance is created. Alternatively to passing the image, the client may choose to boot from a persistent disk, by setting boot=true flag on one of the entries in disks[] collection.
- "disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.
- { # An instance-attached disk resource.
- "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
- "kind": "compute#attachedDisk", # Type of the resource.
- "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
- "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
- "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
- "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
- "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
- },
- ],
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "statusMessage": "A String", # An optional, human-readable explanation of the status (output only).
- "machineType": "A String", # URL of the machine type resource describing which machine type to use to host the instance; provided by the client when the instance is created.
- "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instance through metadata queries.
- { # A service account.
- "scopes": [ # The list of scopes to be made available for this service account.
- "A String",
- ],
- "email": "A String", # Email address of the service account.
- },
- ],
- "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # A network interface resource attached to an instance.
- "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
- { # An access configuration attached to an instance's network interface.
- "kind": "compute#accessConfig", # Type of the resource.
- "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
- "name": "A String", # Name of this access configuration.
- "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
- },
- ],
- "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
- "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
- "network": "A String", # URL of the network resource attached to this interface.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to this instance. Consists of custom metadata or predefined keys; see Instance documentation for more information.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
- },
- },
- ],
- "kind": "compute#instanceList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
reset(project, zone, instance)
-
Performs a hard reset on the instance.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Name of the instance scoping this request. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
setMetadata(project, zone, instance, body)
-
Sets metadata for the specified instance to the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Name of the instance scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A metadata key/value entry.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
-}
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
setTags(project, zone, instance, body)
-
Sets tags for the specified instance to the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- instance: string, Name of the instance scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A set of instance tags.
- "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
- "A String",
- ],
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
Instance Methods
-
- get(project, kernel)
-Returns the specified kernel resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of kernel resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, kernel)
-
Returns the specified kernel resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- kernel: string, Name of the kernel resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A kernel resource.
- "kind": "compute#kernel", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this kernel.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of kernel resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of kernel resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The kernel resources.
- { # A kernel resource.
- "kind": "compute#kernel", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this kernel.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "kind": "compute#kernelList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- aggregatedList(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of machine type resources grouped by scope.
-
- aggregatedList_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- get(project, zone, machineType)
-Returns the specified machine type resource.
-
- list(project, zone, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of machine type resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
aggregatedList(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of machine type resources grouped by scope.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": { # A map of scoped machine type lists.
- "a_key": { # Name of the scope containing this set of machine types.
- "machineTypes": [ # List of machine types contained in this scope.
- { # A machine type resource.
- "guestCpus": 42, # Count of CPUs exposed to the instance.
- "imageSpaceGb": 42, # Space allotted for the image, defined in GB.
- "kind": "compute#machineType", # Type of the resource.
- "maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
- "description": "A String", # An optional textual description of the resource.
- "zone": "A String", # Url of the zone where the machine type resides (output only).
- "maximumPersistentDisks": 42, # Maximum persistent disks allowed.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this machine type.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
- "scratchDisks": [ # List of extended scratch disks assigned to the instance.
- {
- "diskGb": 42, # Size of the scratch disk, defined in GB.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "warning": { # Informational warning which replaces the list of machine types when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- },
- },
- "kind": "compute#machineTypeAggregatedList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
aggregatedList_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
get(project, zone, machineType)
-
Returns the specified machine type resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- machineType: string, Name of the machine type resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A machine type resource.
- "guestCpus": 42, # Count of CPUs exposed to the instance.
- "imageSpaceGb": 42, # Space allotted for the image, defined in GB.
- "kind": "compute#machineType", # Type of the resource.
- "maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
- "description": "A String", # An optional textual description of the resource.
- "zone": "A String", # Url of the zone where the machine type resides (output only).
- "maximumPersistentDisks": 42, # Maximum persistent disks allowed.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this machine type.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
- "scratchDisks": [ # List of extended scratch disks assigned to the instance.
- {
- "diskGb": 42, # Size of the scratch disk, defined in GB.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
list(project, zone, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of machine type resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of machine type resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The machine type resources.
- { # A machine type resource.
- "guestCpus": 42, # Count of CPUs exposed to the instance.
- "imageSpaceGb": 42, # Space allotted for the image, defined in GB.
- "kind": "compute#machineType", # Type of the resource.
- "maximumPersistentDisksSizeGb": "A String", # Maximum total persistent disks size (GB) allowed.
- "description": "A String", # An optional textual description of the resource.
- "zone": "A String", # Url of the zone where the machine type resides (output only).
- "maximumPersistentDisks": 42, # Maximum persistent disks allowed.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this machine type.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "memoryMb": 42, # Physical memory assigned to the instance, defined in MB.
- "scratchDisks": [ # List of extended scratch disks assigned to the instance.
- {
- "diskGb": 42, # Size of the scratch disk, defined in GB.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "kind": "compute#machineTypeList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, network)
-Deletes the specified network resource.
-
- get(project, network)
-Returns the specified network resource.
-
- insert(project, body)
-Creates a network resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of network resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, network)
-
Deletes the specified network resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- network: string, Name of the network resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, network)
-
Returns the specified network resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- network: string, Name of the network resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A network resource.
- "kind": "compute#network", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
insert(project, body)
-
Creates a network resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A network resource.
- "kind": "compute#network", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of network resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of network resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The network resources.
- { # A network resource.
- "kind": "compute#network", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "IPv4Range": "A String", # Required; The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
- "gatewayIPv4": "A String", # An optional address that is used for default routing to other networks. This must be within the range specified by IPv4Range, and is typically the first usable address in that range. If not specified, the default value is the first usable address in IPv4Range.
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#networkList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project)
-Returns the specified project resource.
-
- setCommonInstanceMetadata(project, body)
-Sets metadata common to all instances within the specified project using the data included in the request.
-Method Details
-
-
get(project)
-
Returns the specified project resource.
-
-Args:
- project: string, Name of the project resource to retrieve. (required)
-
-Returns:
- An object of the form:
-
- { # A project resource. Projects can be created only in the APIs Console. Unless marked otherwise, values can only be modified in the console.
- "kind": "compute#project", # Type of the resource.
- "description": "A String", # An optional textual description of the resource.
- "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
- },
- "quotas": [ # Quotas assigned to this project.
- { # A quotas entry.
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
setCommonInstanceMetadata(project, body)
-
Sets metadata common to all instances within the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A metadata key/value entry.
- "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
- {
- "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
- "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
- },
- ],
- "kind": "compute#metadata", # Type of the resource.
- "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
-}
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
Instance Methods
-
- delete(project, region, operation)
-Deletes the specified region-specific operation resource.
-
- get(project, region, operation)
-Retrieves the specified region-specific operation resource.
-
- list(project, region, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of operation resources contained within the specified region.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, region, operation)
-
Deletes the specified region-specific operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- region: string, Name of the region scoping this request. (required)
- operation: string, Name of the operation resource to delete. (required)
-
-
-
get(project, region, operation)
-
Retrieves the specified region-specific operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- region: string, Name of the zone scoping this request. (required)
- operation: string, Name of the operation resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, region, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of operation resources contained within the specified region.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- region: string, Name of the region scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of operation resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The operation resources.
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- },
- ],
- "kind": "compute#operationList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project, region)
-Returns the specified region resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of region resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, region)
-
Returns the specified region resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- region: string, Name of the region resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # Region resource.
- "status": "A String", # Status of the region, "UP" or "DOWN".
- "kind": "compute#region", # Type of the resource.
- "description": "A String", # Textual description of the resource.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this region.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "quotas": [ # Quotas assigned to this region.
- { # A quotas entry.
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
- },
- ],
- "zones": [ # A list of zones homed in this region, in the form of resource URLs.
- "A String",
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of region resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of region resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The region resources.
- { # Region resource.
- "status": "A String", # Status of the region, "UP" or "DOWN".
- "kind": "compute#region", # Type of the resource.
- "description": "A String", # Textual description of the resource.
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this region.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "quotas": [ # Quotas assigned to this region.
- { # A quotas entry.
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
- },
- ],
- "zones": [ # A list of zones homed in this region, in the form of resource URLs.
- "A String",
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "kind": "compute#regionList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, route)
-Deletes the specified route resource.
-
- get(project, route)
-Returns the specified route resource.
-
- insert(project, body)
-Creates a route resource in the specified project using the data included in the request.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of route resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, route)
-
Deletes the specified route resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- route: string, Name of the route resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, route)
-
Returns the specified route resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- route: string, Name of the route resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with VMs by tag and the set of Routes for a particular VM is called its routing table. For each packet leaving a VM, the system searches that VM's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the next_hop field of the winning Route -- either to another VM destination, a VM gateway or a GCE operated gateway. Packets that do not match any Route in the sending VM's routing table will be dropped.
- "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets.
- "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values.
- "kind": "compute#route", # Type of the resource.
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "tags": [ # A list of instance tags to which this route applies.
- "A String",
- ],
- "nextHopInstance": "A String", # The URL to an instance that should handle matching packets.
- "warnings": [ # If potential misconfigurations are detected for this route, this field will be populated with warning messages.
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
- "network": "A String", # URL of the network to which this route is applied; provided by the client when the route is created.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "destRange": "A String", # Which packets does this route apply to?
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- }
-
-
insert(project, body)
-
Creates a route resource in the specified project using the data included in the request.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with VMs by tag and the set of Routes for a particular VM is called its routing table. For each packet leaving a VM, the system searches that VM's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the next_hop field of the winning Route -- either to another VM destination, a VM gateway or a GCE operated gateway. Packets that do not match any Route in the sending VM's routing table will be dropped.
- "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets.
- "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values.
- "kind": "compute#route", # Type of the resource.
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "tags": [ # A list of instance tags to which this route applies.
- "A String",
- ],
- "nextHopInstance": "A String", # The URL to an instance that should handle matching packets.
- "warnings": [ # If potential misconfigurations are detected for this route, this field will be populated with warning messages.
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
- "network": "A String", # URL of the network to which this route is applied; provided by the client when the route is created.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "destRange": "A String", # Which packets does this route apply to?
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- }
-
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of route resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of route resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The route resources.
- { # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with VMs by tag and the set of Routes for a particular VM is called its routing table. For each packet leaving a VM, the system searches that VM's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the next_hop field of the winning Route -- either to another VM destination, a VM gateway or a GCE operated gateway. Packets that do not match any Route in the sending VM's routing table will be dropped.
- "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets.
- "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values.
- "kind": "compute#route", # Type of the resource.
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- "tags": [ # A list of instance tags to which this route applies.
- "A String",
- ],
- "nextHopInstance": "A String", # The URL to an instance that should handle matching packets.
- "warnings": [ # If potential misconfigurations are detected for this route, this field will be populated with warning messages.
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
- "network": "A String", # URL of the network to which this route is applied; provided by the client when the route is created.
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "destRange": "A String", # Which packets does this route apply to?
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- },
- ],
- "kind": "compute#routeList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, snapshot)
-Deletes the specified persistent disk snapshot resource.
-
- get(project, snapshot)
-Returns the specified persistent disk snapshot resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of persistent disk snapshot resources contained within the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, snapshot)
-
Deletes the specified persistent disk snapshot resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- snapshot: string, Name of the persistent disk snapshot resource to delete. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
get(project, snapshot)
-
Returns the specified persistent disk snapshot resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- snapshot: string, Name of the persistent disk snapshot resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A persistent disk snapshot resource.
- "status": "A String", # The status of the persistent disk snapshot (output only).
- "kind": "compute#snapshot", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created (output only).
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of persistent disk snapshot resources contained within the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of persistent disk snapshot resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The persistent snapshot resources.
- { # A persistent disk snapshot resource.
- "status": "A String", # The status of the persistent disk snapshot (output only).
- "kind": "compute#snapshot", # Type of the resource.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot. Once the source disk has been deleted from the system, this field will be cleared, and will not be set even if a disk with the same name has been re-created (output only).
- "sourceDiskId": "A String", # The 'id' value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
- "diskSizeGb": "A String", # Size of the persistent disk snapshot, specified in GB (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
- },
- ],
- "kind": "compute#snapshotList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(project, zone, operation)
-Deletes the specified zone-specific operation resource.
-
- get(project, zone, operation)
-Retrieves the specified zone-specific operation resource.
-
- list(project, zone, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of operation resources contained within the specified zone.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(project, zone, operation)
-
Deletes the specified zone-specific operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- operation: string, Name of the operation resource to delete. (required)
-
-
-
get(project, zone, operation)
-
Retrieves the specified zone-specific operation resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- operation: string, Name of the operation resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- }
-
-
list(project, zone, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of operation resources contained within the specified zone.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of operation resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The operation resources.
- { # An operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only).
- "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "zone": "A String", # URL of the zone where the operation resides (output only).
- "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only).
- "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
- "progress": 42, # An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
- "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only).
- "statusMessage": "A String", # An optional textual description of the current status of the operation (output only).
- "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).
- "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only).
- "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only).
- {
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
- {
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
- },
- ],
- },
- ],
- "user": "A String", # User who requested the operation, for example "user@example.com" (output only).
- "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only).
- "kind": "compute#operation", # Type of the resource.
- "name": "A String", # Name of the resource (output only).
- "region": "A String", # URL of the region where the operation resides (output only).
- "error": { # If errors occurred during processing of this operation, this field will be populated (output only).
- "errors": [ # The array of errors encountered while processing this operation.
- {
- "message": "A String", # An optional, human-readable error message.
- "code": "A String", # The error type identifier for this error.
- "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
- },
- ],
- },
- "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "targetLink": "A String", # URL of the resource the operation is mutating (output only).
- },
- ],
- "kind": "compute#operationList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(project, zone)
-Returns the specified zone resource.
-
- list(project, maxResults=None, pageToken=None, filter=None)
-Retrieves the list of zone resources available to the specified project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, zone)
-
Returns the specified zone resource.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone resource to return. (required)
-
-Returns:
- An object of the form:
-
- { # A zone resource.
- "status": "A String", # Status of the zone. "UP" or "DOWN".
- "kind": "compute#zone", # Type of the resource.
- "description": "A String", # Textual description of the resource.
- "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
- {
- "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
- "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
- "name": "A String", # Name of the maintenance window.
- "description": "A String", # Textual description of the maintenance window.
- },
- ],
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this zone.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "region": "A String", # Full URL reference to the region which hosts the zone (output only).
- "quotas": [ # Quotas assigned to this zone.
- { # A quotas entry.
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- }
-
-
list(project, maxResults=None, pageToken=None, filter=None)
-
Retrieves the list of zone resources available to the specified project.
-
-Args:
- project: string, Name of the project scoping this request. (required)
- maxResults: integer, Optional. Maximum count of results to be returned. Maximum and default value is 100.
- pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
- filter: string, Optional. Filter expression for filtering listed resources.
-
-Returns:
- An object of the form:
-
- { # Contains a list of zone resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # The zone resources.
- { # A zone resource.
- "status": "A String", # Status of the zone. "UP" or "DOWN".
- "kind": "compute#zone", # Type of the resource.
- "description": "A String", # Textual description of the resource.
- "maintenanceWindows": [ # Scheduled maintenance windows for the zone. When the zone is in a maintenance window, all resources which reside in the zone will be unavailable.
- {
- "endTime": "A String", # End time of the maintenance window, in RFC 3339 format.
- "beginTime": "A String", # Begin time of the maintenance window, in RFC 3339 format.
- "name": "A String", # Name of the maintenance window.
- "description": "A String", # Textual description of the maintenance window.
- },
- ],
- "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this zone.
- "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
- "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
- "state": "A String", # The deprecation state. Can be "DEPRECATED", "OBSOLETE", or "DELETED". Operations which create a new resource using a "DEPRECATED" resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. New uses of "OBSOLETE" or "DELETED" resources will result in an error.
- "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
- "replacement": "A String", # A URL of the suggested replacement for the deprecated resource. The deprecated resource and its replacement must be resources of the same kind.
- },
- "region": "A String", # Full URL reference to the region which hosts the zone (output only).
- "quotas": [ # Quotas assigned to this zone.
- { # A quotas entry.
- "usage": 3.14, # Current usage of this metric.
- "metric": "A String", # Name of the quota metric.
- "limit": 3.14, # Quota limit for this metric.
- },
- ],
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "name": "A String", # Name of the resource.
- },
- ],
- "kind": "compute#zoneList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(teamId)
-Retrieves a list of custom field definitions for a team.
-Method Details
-
-
list(teamId)
-
Retrieves a list of custom field definitions for a team.
-
-Args:
- teamId: string, Team ID (required)
-
-Returns:
- An object of the form:
-
- { # Collection of custom field definitions for a team.
- "items": [ # Collection of custom field definitions in a team.
- { # Custom field definition.
- "kind": "coordinate#customFieldDef", # Identifies this object as a custom field definition.
- "name": "A String", # Custom field name.
- "enabled": True or False, # Whether the field is enabled.
- "requiredForCheckout": True or False, # Whether the field is required for checkout.
- "type": "A String", # Custom field type.
- "id": "A String", # Custom field id.
- },
- ],
- "kind": "coordinate#customFieldDefList", # Identifies this object as a collection of custom field definitions in a team.
- }
-
Instance Methods
-
- customFieldDef()
-
-Returns the customFieldDef Resource.
-
-
- jobs()
-
-Returns the jobs Resource.
-
-
- location()
-
-Returns the location Resource.
-
-
- schedule()
-
-Returns the schedule Resource.
-
-
- worker()
-
-Returns the worker Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/coordinate_v1.jobs.html b/docs/dyn/coordinate_v1.jobs.html
deleted file mode 100644
index 96ffda4..0000000
--- a/docs/dyn/coordinate_v1.jobs.html
+++ /dev/null
@@ -1,779 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(teamId, jobId)
-Retrieves a job, including all the changes made to the job.
-
- insert(teamId, address, lat, lng, title, body, customerName=None, assignee=None, customerPhoneNumber=None, note=None, customField=None)
-Inserts a new job. Only the state field of the job should be set.
-
- list(teamId, pageToken=None, minModifiedTimestampMs=None, maxResults=None)
-Retrieves jobs created or modified since the given timestamp.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None, customField=None)
-Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics.
-
- update(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None, customField=None)
-Updates a job. Fields that are set in the job state will be updated.
-Method Details
-
-
get(teamId, jobId)
-
Retrieves a job, including all the changes made to the job.
-
-Args:
- teamId: string, Team ID (required)
- jobId: string, Job number (required)
-
-Returns:
- An object of the form:
-
- { # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }
-
-
insert(teamId, address, lat, lng, title, body, customerName=None, assignee=None, customerPhoneNumber=None, note=None, customField=None)
-
Inserts a new job. Only the state field of the job should be set.
-
-Args:
- teamId: string, Team ID (required)
- address: string, Job address as newline (Unix) separated string (required)
- lat: number, The latitude coordinate of this job's location. (required)
- lng: number, The longitude coordinate of this job's location. (required)
- title: string, Job title (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }
-
- customerName: string, Customer name
- assignee: string, Assignee email address, or empty string to unassign.
- customerPhoneNumber: string, Customer phone number
- note: string, Job note as newline (Unix) separated string
- customField: string, Map from custom field id (from /team//custom_fields) to the field value. For example '123=Alice' (repeated)
-
-Returns:
- An object of the form:
-
- { # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }
-
-
list(teamId, pageToken=None, minModifiedTimestampMs=None, maxResults=None)
-
Retrieves jobs created or modified since the given timestamp.
-
-Args:
- teamId: string, Team ID (required)
- pageToken: string, Continuation token
- minModifiedTimestampMs: string, Minimum time a job was modified in milliseconds since epoch.
- maxResults: integer, Maximum number of results to return in one page.
-
-Returns:
- An object of the form:
-
- { # Response from a List Jobs request.
- "nextPageToken": "A String", # A token to provide to get the next page of results.
- "items": [ # Jobs in the collection.
- { # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "kind": "coordinate#jobList", # Identifies this object as a list of jobs.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None, customField=None)
-
Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics.
-
-Args:
- teamId: string, Team ID (required)
- jobId: string, Job number (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }
-
- customerName: string, Customer name
- assignee: string, Assignee email address, or empty string to unassign.
- customerPhoneNumber: string, Customer phone number
- lng: number, The longitude coordinate of this job's location.
- note: string, Job note as newline (Unix) separated string
- title: string, Job title
- progress: string, Job progress
- Allowed values
- COMPLETED - Completed
- IN_PROGRESS - In progress
- NOT_ACCEPTED - Not accepted
- NOT_STARTED - Not started
- OBSOLETE - Obsolete
- address: string, Job address as newline (Unix) separated string
- lat: number, The latitude coordinate of this job's location.
- customField: string, Map from custom field id (from /team//custom_fields) to the field value. For example '123=Alice' (repeated)
-
-Returns:
- An object of the form:
-
- { # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }
-
-
update(teamId, jobId, body, customerName=None, assignee=None, customerPhoneNumber=None, lng=None, note=None, title=None, progress=None, address=None, lat=None, customField=None)
-
Updates a job. Fields that are set in the job state will be updated.
-
-Args:
- teamId: string, Team ID (required)
- jobId: string, Job number (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }
-
- customerName: string, Customer name
- assignee: string, Assignee email address, or empty string to unassign.
- customerPhoneNumber: string, Customer phone number
- lng: number, The longitude coordinate of this job's location.
- note: string, Job note as newline (Unix) separated string
- title: string, Job title
- progress: string, Job progress
- Allowed values
- COMPLETED - Completed
- IN_PROGRESS - In progress
- NOT_ACCEPTED - Not accepted
- NOT_STARTED - Not started
- OBSOLETE - Obsolete
- address: string, Job address as newline (Unix) separated string
- lat: number, The latitude coordinate of this job's location.
- customField: string, Map from custom field id (from /team//custom_fields) to the field value. For example '123=Alice' (repeated)
-
-Returns:
- An object of the form:
-
- { # A job.
- "kind": "coordinate#job", # Identifies this object as a job.
- "jobChange": [ # List of job changes since it was created. The first change corresponds to the state of the job when it was created.
- { # Change to a job. For example assigning the job to a different worker.
- "timestamp": "A String", # Time at which this change was applied.
- "kind": "coordinate#jobChange", # Identifies this object as a job change.
- "state": { # Current state of a job. # Change applied to the job. Only the fields that were changed are set.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- },
- ],
- "id": "A String", # Job id.
- "state": { # Current state of a job. # Current job state.
- "kind": "coordinate#jobState", # Identifies this object as a job state.
- "customerName": "A String", # Customer name.
- "title": "A String", # Job title.
- "note": [ # Note added to the job.
- "A String",
- ],
- "assignee": "A String", # Email address of the assignee.
- "customerPhoneNumber": "A String", # Customer phone number.
- "location": { # Location of a job. # Job location.
- "lat": 3.14, # Latitude.
- "kind": "coordinate#location", # Identifies this object as a location.
- "addressLine": [ # Address.
- "A String",
- ],
- "lng": 3.14, # Longitude.
- },
- "progress": "A String", # Job progress.
- "customFields": { # Collection of custom fields. # Custom fields.
- "kind": "coordinate#customFields", # Identifies this object as a collection of custom fields.
- "customField": [ # Collection of custom fields.
- { # Custom field.
- "kind": "coordinate#customField", # Identifies this object as a custom field.
- "customFieldId": "A String", # Custom field id.
- "value": "A String", # Custom field value.
- },
- ],
- },
- },
- }
-
Instance Methods
-
- list(teamId, workerEmail, startTimestampMs, pageToken=None, maxResults=None)
-Retrieves a list of locations for a worker.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(teamId, workerEmail, startTimestampMs, pageToken=None, maxResults=None)
-
Retrieves a list of locations for a worker.
-
-Args:
- teamId: string, Team ID (required)
- workerEmail: string, Worker email address. (required)
- startTimestampMs: string, Start timestamp in milliseconds since the epoch. (required)
- pageToken: string, Continuation token
- maxResults: integer, Maximum number of results to return in one page.
-
-Returns:
- An object of the form:
-
- { # Response from a List Locations request.
- "nextPageToken": "A String", # A token to provide to get the next page of results.
- "items": [ # Locations in the collection.
- { # Recorded location of a worker.
- "latitude": 3.14, # Latitude.
- "collectionTime": "A String", # The collection time in milliseconds since the epoch.
- "confidenceRadius": 3.14, # The location accuracy in meters. This is the radius of a 95% confidence interval around the location measurement.
- "kind": "coordinate#locationRecord", # Identifies this object as a location.
- "longitude": 3.14, # Longitude.
- },
- ],
- "kind": "coordinate#locationList", # Identifies this object as a list of locations.
- "tokenPagination": { # Pagination information. # Pagination information for token pagination.
- "nextPageToken": "A String", # A token to provide to get the next page of results.
- "previousPageToken": "A String", # A token to provide to get the previous page of results.
- "kind": "coordinate#tokenPagination", # Identifies this object as pagination information.
- },
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(teamId, jobId)
-Retrieves the schedule for a job.
-
- patch(teamId, jobId, body, allDay=None, startTime=None, duration=None, endTime=None)
-Replaces the schedule of a job with the provided schedule. This method supports patch semantics.
-
- update(teamId, jobId, body, allDay=None, startTime=None, duration=None, endTime=None)
-Replaces the schedule of a job with the provided schedule.
-Method Details
-
-
get(teamId, jobId)
-
Retrieves the schedule for a job.
-
-Args:
- teamId: string, Team ID (required)
- jobId: string, Job number (required)
-
-Returns:
- An object of the form:
-
- { # Job schedule.
- "duration": "A String", # Job duration in milliseconds.
- "kind": "coordinate#schedule", # Identifies this object as a job schedule.
- "allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
- "startTime": "A String", # Scheduled start time in milliseconds since epoch.
- "endTime": "A String", # Scheduled end time in milliseconds since epoch.
- }
-
-
patch(teamId, jobId, body, allDay=None, startTime=None, duration=None, endTime=None)
-
Replaces the schedule of a job with the provided schedule. This method supports patch semantics.
-
-Args:
- teamId: string, Team ID (required)
- jobId: string, Job number (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Job schedule.
- "duration": "A String", # Job duration in milliseconds.
- "kind": "coordinate#schedule", # Identifies this object as a job schedule.
- "allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
- "startTime": "A String", # Scheduled start time in milliseconds since epoch.
- "endTime": "A String", # Scheduled end time in milliseconds since epoch.
- }
-
- allDay: boolean, Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
- startTime: string, Scheduled start time in milliseconds since epoch.
- duration: string, Job duration in milliseconds.
- endTime: string, Scheduled end time in milliseconds since epoch.
-
-Returns:
- An object of the form:
-
- { # Job schedule.
- "duration": "A String", # Job duration in milliseconds.
- "kind": "coordinate#schedule", # Identifies this object as a job schedule.
- "allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
- "startTime": "A String", # Scheduled start time in milliseconds since epoch.
- "endTime": "A String", # Scheduled end time in milliseconds since epoch.
- }
-
-
update(teamId, jobId, body, allDay=None, startTime=None, duration=None, endTime=None)
-
Replaces the schedule of a job with the provided schedule.
-
-Args:
- teamId: string, Team ID (required)
- jobId: string, Job number (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Job schedule.
- "duration": "A String", # Job duration in milliseconds.
- "kind": "coordinate#schedule", # Identifies this object as a job schedule.
- "allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
- "startTime": "A String", # Scheduled start time in milliseconds since epoch.
- "endTime": "A String", # Scheduled end time in milliseconds since epoch.
- }
-
- allDay: boolean, Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
- startTime: string, Scheduled start time in milliseconds since epoch.
- duration: string, Job duration in milliseconds.
- endTime: string, Scheduled end time in milliseconds since epoch.
-
-Returns:
- An object of the form:
-
- { # Job schedule.
- "duration": "A String", # Job duration in milliseconds.
- "kind": "coordinate#schedule", # Identifies this object as a job schedule.
- "allDay": True or False, # Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
- "startTime": "A String", # Scheduled start time in milliseconds since epoch.
- "endTime": "A String", # Scheduled end time in milliseconds since epoch.
- }
-
Instance Methods
-
- list(teamId)
-Retrieves a list of workers in a team.
-Method Details
-
-
list(teamId)
-
Retrieves a list of workers in a team.
-
-Args:
- teamId: string, Team ID (required)
-
-Returns:
- An object of the form:
-
- { # Response from a List Workers request.
- "items": [ # Workers in the collection.
- { # A worker in a Coordinate team.
- "kind": "coordinate#worker", # Identifies this object as a worker.
- "id": "A String", # Worker email address.
- },
- ],
- "kind": "coordinate#workerList", # Identifies this object as a list of workers.
- }
-
Instance Methods
-
- list(q, dateRestrict=None, hl=None, orTerms=None, highRange=None, num=None, cr=None, imgType=None, relatedSite=None, filter=None, gl=None, searchType=None, fileType=None, start=None, imgDominantColor=None, lr=None, siteSearch=None, cref=None, sort=None, hq=None, c2coff=None, googlehost=None, safe=None, exactTerms=None, lowRange=None, imgSize=None, imgColorType=None, rights=None, excludeTerms=None, linkSite=None, cx=None, siteSearchFilter=None)
-Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results.
-Method Details
-
-
list(q, dateRestrict=None, hl=None, orTerms=None, highRange=None, num=None, cr=None, imgType=None, relatedSite=None, filter=None, gl=None, searchType=None, fileType=None, start=None, imgDominantColor=None, lr=None, siteSearch=None, cref=None, sort=None, hq=None, c2coff=None, googlehost=None, safe=None, exactTerms=None, lowRange=None, imgSize=None, imgColorType=None, rights=None, excludeTerms=None, linkSite=None, cx=None, siteSearchFilter=None)
-
Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results.
-
-Args:
- q: string, Query (required)
- 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
- cr: string, Country restrict(s).
- imgType: string, Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.
- Allowed values
- clipart - clipart
- face - face
- lineart - lineart
- news - news
- photo - photo
- relatedSite: string, Specifies that all search results should be pages that are related to the specified URL
- filter: string, Controls turning on or off the duplicate content filter.
- Allowed values
- 0 - Turns off duplicate content filter.
- 1 - Turns on duplicate content filter.
- gl: string, Geolocation of end user.
- searchType: string, Specifies the search type: image.
- Allowed values
- image - custom image search
- 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.
- Allowed values
- black - black
- blue - blue
- brown - brown
- gray - gray
- green - green
- pink - pink
- purple - purple
- teal - teal
- white - white
- yellow - yellow
- lr: string, The language restriction for the search results
- Allowed values
- lang_ar - Arabic
- lang_bg - Bulgarian
- lang_ca - Catalan
- lang_cs - Czech
- lang_da - Danish
- lang_de - German
- lang_el - Greek
- lang_en - English
- lang_es - Spanish
- lang_et - Estonian
- lang_fi - Finnish
- lang_fr - French
- lang_hr - Croatian
- lang_hu - Hungarian
- lang_id - Indonesian
- lang_is - Icelandic
- lang_it - Italian
- lang_iw - Hebrew
- lang_ja - Japanese
- lang_ko - Korean
- lang_lt - Lithuanian
- lang_lv - Latvian
- lang_nl - Dutch
- lang_no - Norwegian
- lang_pl - Polish
- lang_pt - Portuguese
- lang_ro - Romanian
- lang_ru - Russian
- lang_sk - Slovak
- lang_sl - Slovenian
- lang_sr - Serbian
- lang_sv - Swedish
- lang_tr - Turkish
- lang_zh-CN - Chinese (Simplified)
- lang_zh-TW - Chinese (Traditional)
- siteSearch: string, Specifies all search results should be pages from a given site
- 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.
- 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
- Allowed values
- high - Enables highest level of safe search filtering.
- 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
- 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
- huge - huge
- icon - icon
- large - large
- medium - medium
- small - small
- xlarge - xlarge
- xxlarge - xxlarge
- imgColorType: string, Returns black and white, grayscale, or color images: mono, gray, and color.
- Allowed values
- color - color
- gray - gray
- mono - mono
- rights: string, Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these.
- excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the search results
- 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
- siteSearchFilter: string, Controls whether to include or exclude results from the site named in the as_sitesearch parameter
- Allowed values
- e - exclude
- i - include
-
-Returns:
- An object of the form:
-
- {
- "promotions": [
- {
- "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,
- },
- },
- ],
- "kind": "customsearch#search",
- "url": {
- "type": "application/json",
- "template": "https://www.googleapis.com/customsearch/v1?q={searchTerms}&num={count?}&start={startIndex?}&lr={language?}&safe={safe?}&cx={cx?}&cref={cref?}&sort={sort?}&filter={filter?}&gl={gl?}&cr={cr?}&googlehost={googleHost?}&c2coff={disableCnTwTranslation?}&hq={hq?}&hl={hl?}&siteSearch={siteSearch?}&siteSearchFilter={siteSearchFilter?}&exactTerms={exactTerms?}&excludeTerms={excludeTerms?}&linkSite={linkSite?}&orTerms={orTerms?}&relatedSite={relatedSite?}&dateRestrict={dateRestrict?}&lowRange={lowRange?}&highRange={highRange?}&searchType={searchType}&fileType={fileType?}&rights={rights?}&imgSize={imgSize?}&imgType={imgType?}&imgColorType={imgColorType?}&imgDominantColor={imgDominantColor?}&alt=json",
- },
- "items": [
- {
- "snippet": "A String",
- "kind": "customsearch#result",
- "labels": [
- {
- "displayName": "A String",
- "name": "A String",
- },
- ],
- "title": "A String",
- "displayLink": "A String",
- "cacheId": "A String",
- "formattedUrl": "A String",
- "htmlFormattedUrl": "A String",
- "pagemap": {
- "a_key": [
- {
- "a_key": "",
- },
- ],
- },
- "htmlTitle": "A String",
- "htmlSnippet": "A String",
- "link": "A String",
- "image": {
- "thumbnailWidth": 42,
- "byteSize": 42,
- "height": 42,
- "width": 42,
- "contextLink": "A String",
- "thumbnailLink": "A String",
- "thumbnailHeight": 42,
- },
- "mime": "A String",
- "fileFormat": "A String",
- },
- ],
- "context": {
- "facets": [
- [
- {
- "anchor": "A String",
- "label": "A String",
- },
- ],
- ],
- "title": "A String",
- },
- "queries": {
- "a_key": [
- {
- "sort": "A String",
- "hl": "A String",
- "orTerms": "A String",
- "highRange": "A String",
- "cx": "A String",
- "startPage": 42,
- "disableCnTwTranslation": "A String",
- "cr": "A String",
- "imgType": "A String",
- "gl": "A String",
- "relatedSite": "A String",
- "searchType": "A String",
- "title": "A String",
- "googleHost": "A String",
- "fileType": "A String",
- "imgDominantColor": "A String",
- "siteSearch": "A String",
- "cref": "A String",
- "dateRestrict": "A String",
- "safe": "A String",
- "outputEncoding": "A String",
- "hq": "A String",
- "searchTerms": "A String",
- "exactTerms": "A String",
- "language": "A String",
- "inputEncoding": "A String",
- "totalResults": "A String",
- "lowRange": "A String",
- "count": 42,
- "imgSize": "A String",
- "imgColorType": "A String",
- "rights": "A String",
- "startIndex": 42,
- "excludeTerms": "A String",
- "filter": "A String",
- "linkSite": "A String",
- "siteSearchFilter": "A String",
- },
- ],
- },
- "spelling": {
- "correctedQuery": "A String",
- "htmlCorrectedQuery": "A String",
- },
- "searchInformation": {
- "formattedSearchTime": "A String",
- "formattedTotalResults": "A String",
- "totalResults": "A String",
- "searchTime": 3.14,
- },
- }
-
Instance Methods
-
- cse()
-
-Returns the cse Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/datastore_v1beta1.datasets.html b/docs/dyn/datastore_v1beta1.datasets.html
deleted file mode 100644
index 24e7972..0000000
--- a/docs/dyn/datastore_v1beta1.datasets.html
+++ /dev/null
@@ -1,1212 +0,0 @@
-
-
-
-
-Instance Methods
-
- allocateIds(datasetId, body)
-Allocate IDs for incomplete keys (useful for referencing an entity before it is inserted).
-
- beginTransaction(datasetId, body)
-Begin a new transaction.
-
- blindWrite(datasetId, body)
-Create, delete or modify some entities outside a transaction.
-
- commit(datasetId, body)
-Commit a transaction, optionally creating, deleting or modifying some entities.
-
- lookup(datasetId, body)
-Look up some entities by key.
-
- rollback(datasetId, body)
-Roll back a transaction.
-
- runQuery(datasetId, body)
-Query for entities.
-Method Details
-
-
allocateIds(datasetId, body)
-
Allocate IDs for incomplete keys (useful for referencing an entity before it is inserted).
-
-Args:
- datasetId: string, Identifies the dataset. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "keys": [ # A list of keys with incomplete key paths to allocate IDs for. No key may be reserved/read-only.
- {
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "keys": [ # The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.
- {
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- ],
- "header": {
- "kind": "datastore#responseHeader", # The kind, fixed to "datastore#responseHeader".
- },
- }
-
-
beginTransaction(datasetId, body)
-
Begin a new transaction.
-
-Args:
- datasetId: string, Identifies the dataset. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "isolationLevel": "A String", # The transaction isolation level. Either snapshot or serializable. The default isolation level is snapshot isolation, which means that another transaction may not concurrently modify the data that is modified by this transaction. Optionally, a transaction can request to be made serializable which means that another transaction cannot concurrently modify the data that is read or modified by this transaction.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "header": {
- "kind": "datastore#responseHeader", # The kind, fixed to "datastore#responseHeader".
- },
- "transaction": "A String", # The transaction identifier (always present).
- }
-
-
blindWrite(datasetId, body)
-
Create, delete or modify some entities outside a transaction.
-
-Args:
- datasetId: string, Identifies the dataset. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "mutation": { # The mutation to perform.
- "insert": [ # Entities to insert. Each inserted entity's key must have a complete path and must not be reserved/read-only.
- {
- "properties": { # The entity's properties.
- "a_key": { # The name of the property. Properties with names matching regex "__.*__" are reserved. A reserved property name is forbidden in certain documented contexts. The name cannot be "".
- "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
- "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
- {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- ],
- },
- },
- "key": { # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- },
- ],
- "force": True or False, # Ignore a user specified read-only period. Optional.
- "insertAutoId": [ # Insert entities with a newly allocated ID. Each inserted entity's key must omit the final identifier in its path and must not be reserved/read-only.
- {
- "properties": { # The entity's properties.
- "a_key": { # The name of the property. Properties with names matching regex "__.*__" are reserved. A reserved property name is forbidden in certain documented contexts. The name cannot be "".
- "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
- "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
- {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- ],
- },
- },
- "key": { # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- },
- ],
- "update": [ # Entities to update. Each updated entity's key must have a complete path and must not be reserved/read-only.
- {
- "properties": { # The entity's properties.
- "a_key": { # The name of the property. Properties with names matching regex "__.*__" are reserved. A reserved property name is forbidden in certain documented contexts. The name cannot be "".
- "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
- "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
- {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- ],
- },
- },
- "key": { # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- },
- ],
- "delete": [ # Keys of entities to delete. Each key must have a complete key path and must not be reserved/read-only.
- {
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- ],
- "upsert": [ # Entities to upsert. Each upserted entity's key must have a complete path and must not be reserved/read-only.
- {
- "properties": { # The entity's properties.
- "a_key": { # The name of the property. Properties with names matching regex "__.*__" are reserved. A reserved property name is forbidden in certain documented contexts. The name cannot be "".
- "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
- "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
- {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- ],
- },
- },
- "key": { # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- },
- ],
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "header": {
- "kind": "datastore#responseHeader", # The kind, fixed to "datastore#responseHeader".
- },
- "mutationResult": { # The result of performing the mutation (always present).
- "insertAutoIdKeys": [ # Keys for insertAutoId entities. One per entity from the request, in the same order.
- {
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- ],
- "indexUpdates": 42, # Number of index writes.
- },
- }
-
-
commit(datasetId, body)
-
Commit a transaction, optionally creating, deleting or modifying some entities.
-
-Args:
- datasetId: string, Identifies the dataset. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "transaction": "A String", # The transaction identifier, returned by a call to beginTransaction.
- "mutation": { # The mutation to perform as part of this transaction. Optional.
- "insert": [ # Entities to insert. Each inserted entity's key must have a complete path and must not be reserved/read-only.
- {
- "properties": { # The entity's properties.
- "a_key": { # The name of the property. Properties with names matching regex "__.*__" are reserved. A reserved property name is forbidden in certain documented contexts. The name cannot be "".
- "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
- "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
- {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- ],
- },
- },
- "key": { # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- },
- ],
- "force": True or False, # Ignore a user specified read-only period. Optional.
- "insertAutoId": [ # Insert entities with a newly allocated ID. Each inserted entity's key must omit the final identifier in its path and must not be reserved/read-only.
- {
- "properties": { # The entity's properties.
- "a_key": { # The name of the property. Properties with names matching regex "__.*__" are reserved. A reserved property name is forbidden in certain documented contexts. The name cannot be "".
- "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
- "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
- {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- ],
- },
- },
- "key": { # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- },
- ],
- "update": [ # Entities to update. Each updated entity's key must have a complete path and must not be reserved/read-only.
- {
- "properties": { # The entity's properties.
- "a_key": { # The name of the property. Properties with names matching regex "__.*__" are reserved. A reserved property name is forbidden in certain documented contexts. The name cannot be "".
- "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
- "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
- {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- ],
- },
- },
- "key": { # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- },
- ],
- "delete": [ # Keys of entities to delete. Each key must have a complete key path and must not be reserved/read-only.
- {
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- ],
- "upsert": [ # Entities to upsert. Each upserted entity's key must have a complete path and must not be reserved/read-only.
- {
- "properties": { # The entity's properties.
- "a_key": { # The name of the property. Properties with names matching regex "__.*__" are reserved. A reserved property name is forbidden in certain documented contexts. The name cannot be "".
- "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
- "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
- {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- ],
- },
- },
- "key": { # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- },
- ],
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "header": {
- "kind": "datastore#responseHeader", # The kind, fixed to "datastore#responseHeader".
- },
- "mutationResult": { # The result of performing the mutation (if any).
- "insertAutoIdKeys": [ # Keys for insertAutoId entities. One per entity from the request, in the same order.
- {
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- ],
- "indexUpdates": 42, # Number of index writes.
- },
- }
-
-
lookup(datasetId, body)
-
Look up some entities by key.
-
-Args:
- datasetId: string, Identifies the dataset. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "keys": [ # Keys of entities to look up from the datastore.
- {
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- ],
- "readOptions": { # Options for this lookup request. Optional.
- "transaction": "A String", # The transaction to use. Optional.
- "readConsistency": "A String", # The read consistency to use. One of default, strong, or eventual. Cannot be set when transaction is set. Lookup and ancestor queries default to strong, global queries default to eventual and cannot be set to strong. Optional. Default is default.
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "deferred": [ # A list of keys that were not looked up due to resource constraints.
- {
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- ],
- "missing": [ # Entities not found, with only the key populated.
- {
- "entity": { # The resulting entity.
- "properties": { # The entity's properties.
- "a_key": { # The name of the property. Properties with names matching regex "__.*__" are reserved. A reserved property name is forbidden in certain documented contexts. The name cannot be "".
- "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
- "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
- {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- ],
- },
- },
- "key": { # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- },
- },
- ],
- "header": {
- "kind": "datastore#responseHeader", # The kind, fixed to "datastore#responseHeader".
- },
- "found": [ # Entities found.
- {
- "entity": { # The resulting entity.
- "properties": { # The entity's properties.
- "a_key": { # The name of the property. Properties with names matching regex "__.*__" are reserved. A reserved property name is forbidden in certain documented contexts. The name cannot be "".
- "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
- "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
- {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- ],
- },
- },
- "key": { # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- },
- },
- ],
- }
-
-
rollback(datasetId, body)
-
Roll back a transaction.
-
-Args:
- datasetId: string, Identifies the dataset. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "transaction": "A String", # The transaction identifier, returned by a call to beginTransaction.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "header": {
- "kind": "datastore#responseHeader", # The kind, fixed to "datastore#responseHeader".
- },
- }
-
-
runQuery(datasetId, body)
-
Query for entities.
-
-Args:
- datasetId: string, Identifies the dataset. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "query": { # The query to run. Either this field or field gql_query must be set, but not both.
- "startCursor": "A String", # A starting point for the query results. Optional. Query cursors are returned in query result batches.
- "kinds": [ # The kinds to query (if empty, returns entities from all kinds).
- {
- "name": "A String", # The name of the kind.
- },
- ],
- "projection": [ # The projection to return. If not set the entire entity is returned.
- {
- "aggregationFunction": "A String", # The aggregation function to apply to the property. Optional. Can only be used when grouping by at least one property. Must then be set on all properties in the projection that are not being grouped by. Aggregation functions: first selects the first result as determined by the query's order.
- "property": { # The property to project.
- "name": "A String", # The name of the property.
- },
- },
- ],
- "order": [ # The order to apply to the query results (if empty, order is unspecified).
- {
- "direction": "A String", # The direction to order by. One of ascending or descending. Optional, defaults to ascending.
- "property": { # The property to order by.
- "name": "A String", # The name of the property.
- },
- },
- ],
- "filter": { # The filter to apply (optional).
- "compositeFilter": { # A composite filter.
- "operator": "A String", # The operator for combining multiple filters. Only "and" is currently supported.
- "filters": [ # The list of filters to combine. Must contain at least one filter.
- # Object with schema name: Filter
- ],
- },
- "propertyFilter": { # A filter on a property.
- "operator": "A String", # The operator to filter by. One of lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, equal, or hasAncestor.
- "property": { # The property to filter by.
- "name": "A String", # The name of the property.
- },
- "value": { # The value to compare the property to.
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- },
- },
- "limit": 42, # The maximum number of results to return. Applies after all other constraints. Optional.
- "offset": 42, # The number of results to skip. Applies before limit, but after all other constraints (optional, defaults to 0).
- "endCursor": "A String", # An ending point for the query results. Optional. Query cursors are returned in query result batches.
- "groupBy": [ # The properties to group by (if empty, no grouping is applied to the result set).
- {
- "name": "A String", # The name of the property.
- },
- ],
- },
- "partitionId": { # Entities are partitioned into subsets, identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- "gqlQuery": { # The GQL query to run. Either this field or field query must be set, but not both.
- "queryString": "A String",
- "nameArgs": [ # A named argument must set field GqlQueryArg.name. No two named arguments may have the same name. For each non-reserved named binding site in the query string, there must be a named argument with that name, but not necessarily the inverse.
- {
- "cursor": "A String",
- "name": "A String", # Must match regex "[A-Za-z_$][A-Za-z_$0-9]*". Must not match regex "__.*__". Must not be "".
- "value": {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- },
- ],
- "allowLiteral": True or False, # When false, the query string must not contain a literal.
- "numberArgs": [ # Numbered binding site @1 references the first numbered argument, effectively using 1-based indexing, rather than the usual 0. A numbered argument must NOT set field GqlQueryArg.name. For each binding site numbered i in query_string, there must be an ith numbered argument. The inverse must also be true.
- {
- "cursor": "A String",
- "name": "A String", # Must match regex "[A-Za-z_$][A-Za-z_$0-9]*". Must not match regex "__.*__". Must not be "".
- "value": {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- },
- ],
- },
- "readOptions": { # The options for this query.
- "transaction": "A String", # The transaction to use. Optional.
- "readConsistency": "A String", # The read consistency to use. One of default, strong, or eventual. Cannot be set when transaction is set. Lookup and ancestor queries default to strong, global queries default to eventual and cannot be set to strong. Optional. Default is default.
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "header": {
- "kind": "datastore#responseHeader", # The kind, fixed to "datastore#responseHeader".
- },
- "batch": { # A batch of query results (always present).
- "moreResults": "A String", # The state of the query after the current batch. One of notFinished, moreResultsAfterLimit, noMoreResults.
- "entityResults": [ # The results for this batch.
- {
- "entity": { # The resulting entity.
- "properties": { # The entity's properties.
- "a_key": { # The name of the property. Properties with names matching regex "__.*__" are reserved. A reserved property name is forbidden in certain documented contexts. The name cannot be "".
- "multi": True or False, # If this property contains a list of values. Input values may explicitly set multi to false, but otherwise false is always represented by omitting multi.
- "values": [ # The value(s) of the property. When multi is false there is always exactly one value. When multi is true there are always one or more values. Each value can have only one value property populated. For example, you cannot have a values list of { values: [ { integerValue: 22, stringValue: "a" } ] }, but you can have { multi: true, values: [ { integerValue: 22 }, { stringValue: "a" } ] }.
- {
- "entityValue": # Object with schema name: Entity # An entity value. May have no key. May have a key with an incomplete key path. May have a reserved/read-only key.
- "doubleValue": 3.14, # A double value.
- "integerValue": "A String", # An integer value.
- "meaning": 42, # The meaning field is reserved and should not be used.
- "dateTimeValue": "A String", # A timestamp value.
- "keyValue": { # A key value.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- "stringValue": "A String", # A UTF-8 encoded string value.
- "indexed": True or False, # If the value should be indexed.
- #
- # The indexed property may be set for a null value. When indexed is true, stringValue is limited to 500 characters and the blob value is limited to 500 bytes. Input values by default have indexed set to true; however, you can explicitly set indexed to true if you want. (An output value never has indexed explicitly set to true.) If a value is itself an entity, it cannot have indexed set to true.
- "blobValue": "A String", # A blob value.
- "booleanValue": True or False, # A boolean value.
- "blobKeyValue": "A String", # A blob key value.
- },
- ],
- },
- },
- "key": { # The entity's key.
- #
- # An entity must have a key, unless otherwise documented (for example, an entity in Value.entityValue may have no key). An entity's kind is its key's path's last element's kind, or null if it has no key.
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. An entity path is always fully complete: ALL of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. A path can never be empty.
- { # A (kind, ID/name) pair used to construct a key path.
- #
- # At most one of name or ID may be set. If either is set, the element is complete. If neither is set, the element is incomplete.
- "kind": "A String", # The kind of the entity. Kinds matching regex "__.*__" are reserved/read-only. Cannot be "".
- "id": "A String", # The ID of the entity. Always > 0.
- "name": "A String", # The name of the entity. Names matching regex "__.*__" are reserved/read-only. Cannot be "".
- },
- ],
- "partitionId": { # Entities are partitioned into subsets, currently identified by a dataset (usually implicitly specified by the project) and namespace ID. Queries are scoped to a single partition.
- "namespace": "A String", # The namespace.
- "datasetId": "A String", # The dataset ID.
- },
- },
- },
- },
- ],
- "skippedResults": 42, # The number of results skipped because of Query.offset.
- "endCursor": "A String", # A cursor that points to the position after the last result in the batch. May be absent.
- "entityResultType": "A String", # The result type for every entity in entityResults. full for full entities, projection for entities with only projected properties, keyOnly for entities with only a key.
- },
- }
-
Instance Methods
-
- datasets()
-
-Returns the datasets Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v1_1.dimensionValues.html b/docs/dyn/dfareporting_v1_1.dimensionValues.html
deleted file mode 100644
index 6f0a933..0000000
--- a/docs/dyn/dfareporting_v1_1.dimensionValues.html
+++ /dev/null
@@ -1,143 +0,0 @@
-
-
-
-
-Instance Methods
-
- query(profileId, body, pageToken=None, maxResults=None)
-Retrieves list of report dimension values for a list of filters.
-
- query_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
query(profileId, body, pageToken=None, maxResults=None)
-
Retrieves list of report dimension values for a list of filters.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a DimensionValuesRequest.
- "dimensionName": "A String", # The name of the dimension for which values should be requested.
- "startDate": "A String", # The start date of the date range for which to retrieve dimension values. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dimensionValueRequest", # The kind of request this is, in this case dfareporting#dimensionValueRequest.
- "endDate": "A String", # The end date of the date range for which to retrieve dimension values. A string of the format: "yyyy-MM-dd".
- "filters": [ # The list of filters by which to filter values. The filters are ANDed.
- { # Represents a dimension filter.
- "dimensionName": "A String", # The name of the dimension to filter.
- "kind": "dfareporting#dimensionFilter", # The kind of resource this is, in this case dfareporting#dimensionFilter.
- "value": "A String", # The value of the dimension to filter.
- },
- ],
- }
-
- pageToken: string, The value of the nextToken from the previous result page.
- maxResults: integer, Maximum number of results to return.
-
-Returns:
- An object of the form:
-
- { # Represents the list of DimensionValue resources.
- "nextPageToken": "A String", # Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
- "items": [ # The dimension values returned in this response.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "kind": "dfareporting#dimensionValueList", # The kind of list this is, in this case dfareporting#dimensionValueList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }
-
-
query_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(profileId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
-Lists files for a user profile.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(profileId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
-
Lists files for a user profile.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- pageToken: string, The value of the nextToken from the previous result page.
- sortField: string, The field by which to sort the list.
- Allowed values
- ID - Sort by file ID.
- LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is 'DESCENDING'.
- Allowed values
- ASCENDING - Ascending order.
- DESCENDING - Descending order.
-
-Returns:
- An object of the form:
-
- { # Represents the list of File resources.
- "nextPageToken": "A String", # Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
- "items": [ # The files returned in this response.
- { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
- "status": "A String", # The status of the report file, one of:
- # - "PROCESSING"
- # - "REPORT_AVAILABLE"
- # - "FAILED"
- # - "CANCELLED"
- "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
- "format": "A String", # The output format of the report. Only available once the file is available.
- "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "fileName": "A String", # The file name of the file.
- "etag": "A String", # The eTag of this response for caching purposes.
- "reportId": "A String", # The ID of the report this file was generated from.
- "urls": { # The urls where the completed report file can be downloaded.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
- "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
- "id": "A String", # The unique ID of this report file.
- },
- ],
- "kind": "dfareporting#fileList", # The kind of list this is, in this case dfareporting#fileList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- dimensionValues()
-
-Returns the dimensionValues Resource.
-
-
- files()
-
-Returns the files Resource.
-
-
- reports()
-
-Returns the reports Resource.
-
-
- userProfiles()
-
-Returns the userProfiles Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v1_1.reports.files.html b/docs/dyn/dfareporting_v1_1.reports.files.html
deleted file mode 100644
index bb9bc0a..0000000
--- a/docs/dyn/dfareporting_v1_1.reports.files.html
+++ /dev/null
@@ -1,223 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(profileId, reportId, fileId)
-Retrieves a report file.
-
- list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
-Lists files for a report.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(profileId, reportId, fileId)
-
Retrieves a report file.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the report. (required)
- fileId: string, The ID of the report file. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
- "status": "A String", # The status of the report file, one of:
- # - "PROCESSING"
- # - "REPORT_AVAILABLE"
- # - "FAILED"
- # - "CANCELLED"
- "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
- "format": "A String", # The output format of the report. Only available once the file is available.
- "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "fileName": "A String", # The file name of the file.
- "etag": "A String", # The eTag of this response for caching purposes.
- "reportId": "A String", # The ID of the report this file was generated from.
- "urls": { # The urls where the completed report file can be downloaded.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
- "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
- "id": "A String", # The unique ID of this report file.
- }
-
-
list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
-
Lists files for a report.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the parent report. (required)
- pageToken: string, The value of the nextToken from the previous result page.
- sortField: string, The field by which to sort the list.
- Allowed values
- ID - Sort by file ID.
- LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is 'DESCENDING'.
- Allowed values
- ASCENDING - Ascending order.
- DESCENDING - Descending order.
-
-Returns:
- An object of the form:
-
- { # Represents the list of File resources.
- "nextPageToken": "A String", # Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
- "items": [ # The files returned in this response.
- { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
- "status": "A String", # The status of the report file, one of:
- # - "PROCESSING"
- # - "REPORT_AVAILABLE"
- # - "FAILED"
- # - "CANCELLED"
- "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
- "format": "A String", # The output format of the report. Only available once the file is available.
- "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "fileName": "A String", # The file name of the file.
- "etag": "A String", # The eTag of this response for caching purposes.
- "reportId": "A String", # The ID of the report this file was generated from.
- "urls": { # The urls where the completed report file can be downloaded.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
- "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
- "id": "A String", # The unique ID of this report file.
- },
- ],
- "kind": "dfareporting#fileList", # The kind of list this is, in this case dfareporting#fileList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- files()
-
-Returns the files Resource.
-
-
- delete(profileId, reportId)
-Deletes a report by its ID.
-
- get(profileId, reportId)
-Retrieves a report by its ID.
-
- insert(profileId, body)
-Creates a report.
-
- list(profileId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
-Retrieves list of reports.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(profileId, reportId, body)
-Updates a report. This method supports patch semantics.
-
- run(profileId, reportId, synchronous=None)
-Runs a report.
-
- update(profileId, reportId, body)
-Updates a report.
-Method Details
-
-
delete(profileId, reportId)
-
Deletes a report by its ID.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
-
-
-
get(profileId, reportId)
-
Retrieves a report by its ID.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
insert(profileId, body)
-
Creates a report.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
list(profileId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
-
Retrieves list of reports.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- pageToken: string, The value of the nextToken from the previous result page.
- sortField: string, The field by which to sort the list.
- Allowed values
- ID - Sort by report ID.
- LAST_MODIFIED_TIME - Sort by 'lastModifiedTime' field.
- NAME - Sort by name of reports.
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is 'DESCENDING'.
- Allowed values
- ASCENDING - Ascending order.
- DESCENDING - Descending order.
-
-Returns:
- An object of the form:
-
- { # Represents the list of reports.
- "nextPageToken": "A String", # Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
- "items": [ # The reports returned in this response.
- { # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- },
- ],
- "kind": "dfareporting#reportList", # The kind of list this is, in this case dfareporting#reportList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(profileId, reportId, body)
-
Updates a report. This method supports patch semantics.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
run(profileId, reportId, synchronous=None)
-
Runs a report.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the report. (required)
- synchronous: boolean, If set and true, tries to run the report synchronously.
-
-Returns:
- An object of the form:
-
- { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
- "status": "A String", # The status of the report file, one of:
- # - "PROCESSING"
- # - "REPORT_AVAILABLE"
- # - "FAILED"
- # - "CANCELLED"
- "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
- "format": "A String", # The output format of the report. Only available once the file is available.
- "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "fileName": "A String", # The file name of the file.
- "etag": "A String", # The eTag of this response for caching purposes.
- "reportId": "A String", # The ID of the report this file was generated from.
- "urls": { # The urls where the completed report file can be downloaded.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
- "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
- "id": "A String", # The unique ID of this report file.
- }
-
-
update(profileId, reportId, body)
-
Updates a report.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT" (support for additional options will be added later)
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # The name of the dimension.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # The eTag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
Instance Methods
-
- get(profileId)
-Gets one user profile by ID.
-
- list()
-Retrieves list of user profiles for a user.
-Method Details
-
-
get(profileId)
-
Gets one user profile by ID.
-
-Args:
- profileId: string, The user profile ID. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a UserProfile resource.
- "userName": "A String", # The user name.
- "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
- "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
- "accountName": "A String", # The account name this profile belongs to.
- "etag": "A String", # The eTag of this response for caching purposes.
- "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
- "profileId": "A String", # The unique ID of the user profile.
- "accountId": "A String", # The account ID to which this profile belongs.
- }
-
-
list()
-
Retrieves list of user profiles for a user.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # Represents the list of user profiles.
- "items": [ # The user profiles returned in this response.
- { # Represents a UserProfile resource.
- "userName": "A String", # The user name.
- "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
- "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
- "accountName": "A String", # The account name this profile belongs to.
- "etag": "A String", # The eTag of this response for caching purposes.
- "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
- "profileId": "A String", # The unique ID of the user profile.
- "accountId": "A String", # The account ID to which this profile belongs.
- },
- ],
- "kind": "dfareporting#userProfileList", # The kind of list this is, in this case dfareporting#userProfileList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }
-
Instance Methods
-
- query(profileId, body, pageToken=None, maxResults=None)
-Retrieves list of report dimension values for a list of filters.
-
- query_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
query(profileId, body, pageToken=None, maxResults=None)
-
Retrieves list of report dimension values for a list of filters.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a DimensionValuesRequest.
- "dimensionName": "A String", # The name of the dimension for which values should be requested.
- "startDate": "A String", # The start date of the date range for which to retrieve dimension values. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dimensionValueRequest", # The kind of request this is, in this case dfareporting#dimensionValueRequest.
- "endDate": "A String", # The end date of the date range for which to retrieve dimension values. A string of the format: "yyyy-MM-dd".
- "filters": [ # The list of filters by which to filter values. The filters are ANDed.
- { # Represents a dimension filter.
- "dimensionName": "A String", # The name of the dimension to filter.
- "kind": "dfareporting#dimensionFilter", # The kind of resource this is, in this case dfareporting#dimensionFilter.
- "value": "A String", # The value of the dimension to filter.
- },
- ],
- }
-
- pageToken: string, The value of the nextToken from the previous result page.
- maxResults: integer, Maximum number of results to return.
-
-Returns:
- An object of the form:
-
- { # Represents the list of DimensionValue resources.
- "nextPageToken": "A String", # Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
- "items": [ # The dimension values returned in this response.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "kind": "dfareporting#dimensionValueList", # The kind of list this is, in this case dfareporting#dimensionValueList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }
-
-
query_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(reportId, fileId)
-Retrieves a report file by its report ID and file ID.
-
- get_media(reportId, fileId)
-Retrieves a report file by its report ID and file ID.
-
- list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)
-Lists files for a user profile.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(reportId, fileId)
-
Retrieves a report file by its report ID and file ID.
-
-Args:
- reportId: string, The ID of the report. (required)
- fileId: string, The ID of the report file. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
- "status": "A String", # The status of the report file, one of:
- # - "PROCESSING"
- # - "REPORT_AVAILABLE"
- # - "FAILED"
- # - "CANCELLED"
- "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
- "format": "A String", # The output format of the report. Only available once the file is available.
- "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "fileName": "A String", # The file name of the file.
- "etag": "A String", # The eTag of this response for caching purposes.
- "reportId": "A String", # The ID of the report this file was generated from.
- "urls": { # The urls where the completed report file can be downloaded.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
- "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
- "id": "A String", # The unique ID of this report file.
- }
-
-
get_media(reportId, fileId)
-
Retrieves a report file by its report ID and file ID.
-
-Args:
- reportId: string, The ID of the report. (required)
- fileId: string, The ID of the report file. (required)
-
-Returns:
- The media object as a string.
-
-
-
-
list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)
-
Lists files for a user profile.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- pageToken: string, The value of the nextToken from the previous result page.
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is 'DESCENDING'.
- Allowed values
- ASCENDING - Ascending order.
- DESCENDING - Descending order.
- sortField: string, The field by which to sort the list.
- Allowed values
- ID - Sort by file ID.
- LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
- scope: string, The scope that defines which results are returned, default is 'MINE'.
- Allowed values
- ALL - All files in account.
- MINE - My files.
- SHARED_WITH_ME - Files shared with me.
-
-Returns:
- An object of the form:
-
- { # Represents the list of File resources.
- "nextPageToken": "A String", # Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
- "items": [ # The files returned in this response.
- { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
- "status": "A String", # The status of the report file, one of:
- # - "PROCESSING"
- # - "REPORT_AVAILABLE"
- # - "FAILED"
- # - "CANCELLED"
- "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
- "format": "A String", # The output format of the report. Only available once the file is available.
- "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "fileName": "A String", # The file name of the file.
- "etag": "A String", # The eTag of this response for caching purposes.
- "reportId": "A String", # The ID of the report this file was generated from.
- "urls": { # The urls where the completed report file can be downloaded.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
- "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
- "id": "A String", # The unique ID of this report file.
- },
- ],
- "kind": "dfareporting#fileList", # The kind of list this is, in this case dfareporting#fileList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- dimensionValues()
-
-Returns the dimensionValues Resource.
-
-
- files()
-
-Returns the files Resource.
-
-
- reports()
-
-Returns the reports Resource.
-
-
- userProfiles()
-
-Returns the userProfiles Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v1_3.reports.compatibleFields.html b/docs/dyn/dfareporting_v1_3.reports.compatibleFields.html
deleted file mode 100644
index 3ceb69c..0000000
--- a/docs/dyn/dfareporting_v1_3.reports.compatibleFields.html
+++ /dev/null
@@ -1,763 +0,0 @@
-
-
-
-
-Instance Methods
-
- query(profileId, body)
-Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.
-Method Details
-
-
query(profileId, body)
-
Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT"
- # - "LINK"
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT"
- # - "LINK"
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a response to the queryCompatibleFields method.
- "kind": "dfareporting#compatibleFields", # The kind of resource this is, in this case dfareporting#compatibleFields.
- "reachReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "REACH". # Contains items that are compatible to be selected for a report of type "REACH".
- "kind": "dfareporting#reachReportCompatibleFields", # The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.
- "dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
- { # Represents a dimension.
- "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
- "name": "A String", # The dimension name, e.g. dfa:advertiser
- },
- ],
- "reachByFrequencyMetrics": [ # Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report.
- { # Represents a metric.
- "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
- "name": "A String", # The metric name, e.g. dfa:impressions
- },
- ],
- "pivotedActivityMetrics": [ # Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
- { # Represents a metric.
- "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
- "name": "A String", # The metric name, e.g. dfa:impressions
- },
- ],
- "dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
- { # Represents a dimension.
- "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
- "name": "A String", # The dimension name, e.g. dfa:advertiser
- },
- ],
- "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
- { # Represents a metric.
- "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
- "name": "A String", # The metric name, e.g. dfa:impressions
- },
- ],
- },
- "pathToConversionReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". # Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
- "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
- { # Represents a metric.
- "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
- "name": "A String", # The metric name, e.g. dfa:impressions
- },
- ],
- "perInteractionDimensions": [ # Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report.
- { # Represents a dimension.
- "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
- "name": "A String", # The dimension name, e.g. dfa:advertiser
- },
- ],
- "kind": "dfareporting#pathToConversionReportCompatibleFields", # The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.
- "conversionDimensions": [ # Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report.
- { # Represents a dimension.
- "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
- "name": "A String", # The dimension name, e.g. dfa:advertiser
- },
- ],
- "customFloodlightVariables": [ # Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report.
- { # Represents a dimension.
- "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
- "name": "A String", # The dimension name, e.g. dfa:advertiser
- },
- ],
- },
- "crossDimensionReachReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". # Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # Dimensions which are compatible to be selected in the "breakdown" section of the report.
- { # Represents a dimension.
- "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
- "name": "A String", # The dimension name, e.g. dfa:advertiser
- },
- ],
- "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
- { # Represents a metric.
- "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
- "name": "A String", # The metric name, e.g. dfa:impressions
- },
- ],
- "kind": "dfareporting#crossDimensionReachReportCompatibleFields", # The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.
- "overlapMetrics": [ # Metrics which are compatible to be selected in the "overlapMetricNames" section of the report.
- { # Represents a metric.
- "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
- "name": "A String", # The metric name, e.g. dfa:impressions
- },
- ],
- "dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
- { # Represents a dimension.
- "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
- "name": "A String", # The dimension name, e.g. dfa:advertiser
- },
- ],
- },
- "floodlightReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". # Contains items that are compatible to be selected for a report of type "FLOODLIGHT".
- "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
- { # Represents a metric.
- "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
- "name": "A String", # The metric name, e.g. dfa:impressions
- },
- ],
- "kind": "dfareporting#floodlightReportCompatibleFields", # The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.
- "dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
- { # Represents a dimension.
- "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
- "name": "A String", # The dimension name, e.g. dfa:advertiser
- },
- ],
- "dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
- { # Represents a dimension.
- "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
- "name": "A String", # The dimension name, e.g. dfa:advertiser
- },
- ],
- },
- "reportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "STANDARD". # Contains items that are compatible to be selected for a report of type "STANDARD".
- "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
- { # Represents a metric.
- "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
- "name": "A String", # The metric name, e.g. dfa:impressions
- },
- ],
- "kind": "dfareporting#reportCompatibleFields", # The kind of resource this is, in this case dfareporting#reportCompatibleFields.
- "pivotedActivityMetrics": [ # Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
- { # Represents a metric.
- "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
- "name": "A String", # The metric name, e.g. dfa:impressions
- },
- ],
- "dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
- { # Represents a dimension.
- "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
- "name": "A String", # The dimension name, e.g. dfa:advertiser
- },
- ],
- "dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
- { # Represents a dimension.
- "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
- "name": "A String", # The dimension name, e.g. dfa:advertiser
- },
- ],
- },
- }
-
Instance Methods
-
- get(profileId, reportId, fileId)
-Retrieves a report file.
-
- get_media(profileId, reportId, fileId)
-Retrieves a report file.
-
- list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
-Lists files for a report.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(profileId, reportId, fileId)
-
Retrieves a report file.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the report. (required)
- fileId: string, The ID of the report file. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
- "status": "A String", # The status of the report file, one of:
- # - "PROCESSING"
- # - "REPORT_AVAILABLE"
- # - "FAILED"
- # - "CANCELLED"
- "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
- "format": "A String", # The output format of the report. Only available once the file is available.
- "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "fileName": "A String", # The file name of the file.
- "etag": "A String", # The eTag of this response for caching purposes.
- "reportId": "A String", # The ID of the report this file was generated from.
- "urls": { # The urls where the completed report file can be downloaded.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
- "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
- "id": "A String", # The unique ID of this report file.
- }
-
-
get_media(profileId, reportId, fileId)
-
Retrieves a report file.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the report. (required)
- fileId: string, The ID of the report file. (required)
-
-Returns:
- The media object as a string.
-
-
-
-
list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
-
Lists files for a report.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the parent report. (required)
- pageToken: string, The value of the nextToken from the previous result page.
- sortField: string, The field by which to sort the list.
- Allowed values
- ID - Sort by file ID.
- LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is 'DESCENDING'.
- Allowed values
- ASCENDING - Ascending order.
- DESCENDING - Descending order.
-
-Returns:
- An object of the form:
-
- { # Represents the list of File resources.
- "nextPageToken": "A String", # Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
- "items": [ # The files returned in this response.
- { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
- "status": "A String", # The status of the report file, one of:
- # - "PROCESSING"
- # - "REPORT_AVAILABLE"
- # - "FAILED"
- # - "CANCELLED"
- "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
- "format": "A String", # The output format of the report. Only available once the file is available.
- "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "fileName": "A String", # The file name of the file.
- "etag": "A String", # The eTag of this response for caching purposes.
- "reportId": "A String", # The ID of the report this file was generated from.
- "urls": { # The urls where the completed report file can be downloaded.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
- "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
- "id": "A String", # The unique ID of this report file.
- },
- ],
- "kind": "dfareporting#fileList", # The kind of list this is, in this case dfareporting#fileList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- compatibleFields()
-
-Returns the compatibleFields Resource.
-
-
- files()
-
-Returns the files Resource.
-
-
- delete(profileId, reportId)
-Deletes a report by its ID.
-
- get(profileId, reportId)
-Retrieves a report by its ID.
-
- insert(profileId, body)
-Creates a report.
-
- list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)
-Retrieves list of reports.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(profileId, reportId, body)
-Updates a report. This method supports patch semantics.
-
- run(profileId, reportId, synchronous=None)
-Runs a report.
-
- update(profileId, reportId, body)
-Updates a report.
-Method Details
-
-
delete(profileId, reportId)
-
Deletes a report by its ID.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
-
-
-
get(profileId, reportId)
-
Retrieves a report by its ID.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT"
- # - "LINK"
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT"
- # - "LINK"
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
insert(profileId, body)
-
Creates a report.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT"
- # - "LINK"
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT"
- # - "LINK"
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT"
- # - "LINK"
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT"
- # - "LINK"
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)
-
Retrieves list of reports.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- pageToken: string, The value of the nextToken from the previous result page.
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is 'DESCENDING'.
- Allowed values
- ASCENDING - Ascending order.
- DESCENDING - Descending order.
- sortField: string, The field by which to sort the list.
- Allowed values
- ID - Sort by report ID.
- LAST_MODIFIED_TIME - Sort by 'lastModifiedTime' field.
- NAME - Sort by name of reports.
- scope: string, The scope that defines which results are returned, default is 'MINE'.
- Allowed values
- ALL - All reports in account.
- MINE - My reports.
-
-Returns:
- An object of the form:
-
- { # Represents the list of reports.
- "nextPageToken": "A String", # Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
- "items": [ # The reports returned in this response.
- { # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT"
- # - "LINK"
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT"
- # - "LINK"
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- },
- ],
- "kind": "dfareporting#reportList", # The kind of list this is, in this case dfareporting#reportList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(profileId, reportId, body)
-
Updates a report. This method supports patch semantics.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT"
- # - "LINK"
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT"
- # - "LINK"
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT"
- # - "LINK"
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT"
- # - "LINK"
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
run(profileId, reportId, synchronous=None)
-
Runs a report.
-
-Args:
- profileId: string, The DFA profile ID. (required)
- reportId: string, The ID of the report. (required)
- synchronous: boolean, If set and true, tries to run the report synchronously.
-
-Returns:
- An object of the form:
-
- { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
- "status": "A String", # The status of the report file, one of:
- # - "PROCESSING"
- # - "REPORT_AVAILABLE"
- # - "FAILED"
- # - "CANCELLED"
- "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
- "format": "A String", # The output format of the report. Only available once the file is available.
- "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "fileName": "A String", # The file name of the file.
- "etag": "A String", # The eTag of this response for caching purposes.
- "reportId": "A String", # The ID of the report this file was generated from.
- "urls": { # The urls where the completed report file can be downloaded.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
- "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
- "id": "A String", # The unique ID of this report file.
- }
-
-
update(profileId, reportId, body)
-
Updates a report.
-
-Args:
- profileId: string, The DFA user profile ID. (required)
- reportId: string, The ID of the report. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT"
- # - "LINK"
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT"
- # - "LINK"
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a Report resource.
- "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
- "conversionDimensions": [ # The list of conversion dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "reportProperties": { # The properties of the report.
- "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
- "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
- "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
- "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
- },
- "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "activityFilters": [ # The list of 'dfa:activity' values to filter on.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval for which the report is repeated, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
- "A String",
- ],
- },
- "format": "A String", # The output format of the report, one of:
- # - "CSV"
- # - "EXCEL" If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "reachCriteria": { # The report criteria for a report of type "REACH".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
- "A String",
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- "customRichMediaEvents": [ # The list of custom rich media events to include.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "reportProperties": { # The properties of the report.
- "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
- "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
- "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
- },
- },
- "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- },
- "delivery": { # The report's email delivery settings.
- "message": "A String", # The message to be sent with each email.
- "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
- # - "ATTACHMENT"
- # - "LINK"
- "recipients": [ # The list of recipients to which to email the report.
- { # Represents a recipient.
- "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
- "deliveryType": "A String", # The delivery type for the recipient, one of:
- # - "ATTACHMENT"
- # - "LINK"
- "email": "A String", # The email address of the recipient.
- },
- ],
- "emailOwner": True or False, # Whether the report should be emailed to the report owner.
- },
- "etag": "A String", # The eTag of this response for caching purposes.
- "criteria": { # The report criteria for a report of type "STANDARD".
- "activities": { # Represents an activity group. # Activity group.
- "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of standard dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range for which this report should be run.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
- "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- },
- },
- "id": "A String", # The unique ID identifying this report resource.
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "fileName": "A String", # The file name used when generating report files for this report.
- "type": "A String", # The type of the report, one of:
- # - STANDARD
- # - REACH
- # - ACTIVE_GRP
- # - PATH_TO_CONVERSION
- # - FLOODLIGHT
- # - CROSS_DIMENSION_REACH
- "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
- "breakdown": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
- "A String",
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # Represents a date range. # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- },
- "dimensionFilters": [ # The list of filters on which dimensions are filtered.
- { # Represents a DimensionValue resource.
- "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
- "value": "A String", # The value of the dimension.
- "dimensionName": "A String", # The name of the dimension.
- "etag": "A String", # The eTag of this response for caching purposes.
- "matchType": "A String", # Determines how the 'value' field is matched when filtering. One of:
- # - EXACT (default if not specified)
- # - CONTAINS
- # - BEGINS_WITH
- # - WILDCARD_EXPRESSION (allowing '*' as a placeholder for variable length character sequences, it can be escaped with a backslash.) Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
- "id": "A String", # The ID associated with the value if available.
- },
- ],
- "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
- "dimension": "A String", # The dimension option, one of:
- # - "ADVERTISER"
- # - "CAMPAIGN"
- # - "SITE_BY_ADVERTISER"
- # - "SITE_BY_CAMPAIGN"
- },
- "accountId": "A String", # The account ID to which this report belongs.
- }
-
Instance Methods
-
- get(profileId)
-Gets one user profile by ID.
-
- list()
-Retrieves list of user profiles for a user.
-Method Details
-
-
get(profileId)
-
Gets one user profile by ID.
-
-Args:
- profileId: string, The user profile ID. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a UserProfile resource.
- "userName": "A String", # The user name.
- "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
- "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
- "accountName": "A String", # The account name this profile belongs to.
- "etag": "A String", # The eTag of this response for caching purposes.
- "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
- "profileId": "A String", # The unique ID of the user profile.
- "accountId": "A String", # The account ID to which this profile belongs.
- }
-
-
list()
-
Retrieves list of user profiles for a user.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # Represents the list of user profiles.
- "items": [ # The user profiles returned in this response.
- { # Represents a UserProfile resource.
- "userName": "A String", # The user name.
- "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
- "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
- "accountName": "A String", # The account name this profile belongs to.
- "etag": "A String", # The eTag of this response for caching purposes.
- "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
- "profileId": "A String", # The unique ID of the user profile.
- "accountId": "A String", # The account ID to which this profile belongs.
- },
- ],
- "kind": "dfareporting#userProfileList", # The kind of list this is, in this case dfareporting#userProfileList.
- "etag": "A String", # The eTag of this response for caching purposes.
- }
-
Instance Methods
-
- getRest(api, version)
-Retrieve the description of a particular version of an api.
-
- list(name=None, preferred=None)
-Retrieve the list of APIs supported at this endpoint.
-Method Details
-
-
getRest(api, version)
-
Retrieve the description of a particular version of an api.
-
-Args:
- api: string, The name of the API. (required)
- version: string, The version of the API. (required)
-
-Returns:
- An object of the form:
-
- {
- "protocol": "rest", # The protocol described by this document.
- "methods": { # API-level methods for this API.
- "a_key": { # An individual method description.
- "scopes": [ # OAuth 2.0 scopes applicable to this method.
- "A String",
- ],
- "description": "A String", # Description of this method.
- "parameters": { # Details for all parameters in this method.
- "a_key": { # Details for a single parameter in this method.
- "properties": { # If this is a schema for an object, list the schema for each property of this object.
- "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
- },
- "required": True or False, # Whether the parameter is required.
- "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
- "description": "A String", # A description of this object.
- "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
- "default": "A String", # The default value of this property (if one exists).
- "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array.
- "enum": [ # Values this parameter may take (if it is an enum).
- "A String",
- ],
- "maximum": "A String", # The maximum value of this parameter.
- "id": "A String", # Unique identifier for this schema.
- "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
- "A String",
- ],
- "minimum": "A String", # The minimum value of this parameter.
- "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
- "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
- "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
- "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
- "repeated": True or False, # Whether this parameter may appear multiple times.
- "annotations": { # Additional information about this property.
- "required": [ # A list of methods for which this property is required on requests.
- "A String",
- ],
- },
- "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
- },
- },
- "supportsMediaUpload": True or False, # Whether this method supports media uploads.
- "etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.
- "mediaUpload": { # Media upload parameters.
- "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
- "protocols": { # Supported upload protocols.
- "simple": { # Supports uploading as a single HTTP request.
- "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
- "multipart": true, # True if this endpoint supports upload multipart media.
- },
- "resumable": { # Supports the Resumable Media Upload protocol.
- "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
- "multipart": true, # True if this endpoint supports uploading multipart media.
- },
- },
- "accept": [ # MIME Media Ranges for acceptable media uploads to this method.
- "A String",
- ],
- },
- "request": { # The schema for the request.
- "parameterName": "A String", # parameter name.
- "$ref": "A String", # Schema ID for the request schema.
- },
- "response": { # The schema for the response.
- "$ref": "A String", # Schema ID for the response schema.
- },
- "httpMethod": "A String", # HTTP method used by this method.
- "supportsSubscription": True or False, # Whether this method supports subscriptions.
- "parameterOrder": [ # Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first.
- "A String",
- ],
- "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
- "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
- "supportsMediaDownload": True or False, # Whether this method supports media downloads.
- },
- },
- "labels": [ # Labels for the status of this API, such as labs or deprecated.
- "A String",
- ],
- "ownerName": "A String", # The name of the owner of this API. See ownerDomain.
- "batchPath": "batch", # The path for REST batch requests.
- "id": "A String", # The ID of this API.
- "features": [ # A list of supported features for this API.
- "A String",
- ],
- "ownerDomain": "A String", # The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name.
- "rootUrl": "A String", # The root URL under which all API services live.
- "parameters": { # Common parameters that apply across all apis.
- "a_key": { # Description of a single parameter.
- "properties": { # If this is a schema for an object, list the schema for each property of this object.
- "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
- },
- "required": True or False, # Whether the parameter is required.
- "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
- "description": "A String", # A description of this object.
- "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
- "default": "A String", # The default value of this property (if one exists).
- "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array.
- "enum": [ # Values this parameter may take (if it is an enum).
- "A String",
- ],
- "maximum": "A String", # The maximum value of this parameter.
- "id": "A String", # Unique identifier for this schema.
- "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
- "A String",
- ],
- "minimum": "A String", # The minimum value of this parameter.
- "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
- "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
- "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
- "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
- "repeated": True or False, # Whether this parameter may appear multiple times.
- "annotations": { # Additional information about this property.
- "required": [ # A list of methods for which this property is required on requests.
- "A String",
- ],
- },
- "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
- },
- },
- "icons": { # Links to 16x16 and 32x32 icons representing the API.
- "x32": "A String", # The URL of the 32x32 icon.
- "x16": "A String", # The URL of the 16x16 icon.
- },
- "baseUrl": "A String", # [DEPRECATED] The base URL for REST requests.
- "etag": "A String", # The ETag for this response.
- "version": "A String", # The version of this API.
- "servicePath": "A String", # The base path for all REST requests.
- "schemas": { # The schemas for this API.
- "a_key": { # An individual schema description.
- "properties": { # If this is a schema for an object, list the schema for each property of this object.
- "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
- },
- "required": True or False, # Whether the parameter is required.
- "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
- "description": "A String", # A description of this object.
- "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
- "default": "A String", # The default value of this property (if one exists).
- "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array.
- "enum": [ # Values this parameter may take (if it is an enum).
- "A String",
- ],
- "maximum": "A String", # The maximum value of this parameter.
- "id": "A String", # Unique identifier for this schema.
- "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
- "A String",
- ],
- "minimum": "A String", # The minimum value of this parameter.
- "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
- "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
- "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
- "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
- "repeated": True or False, # Whether this parameter may appear multiple times.
- "annotations": { # Additional information about this property.
- "required": [ # A list of methods for which this property is required on requests.
- "A String",
- ],
- },
- "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
- },
- },
- "resources": { # The resources in this API.
- "a_key": { # An individual resource description. Contains methods and sub-resources related to this resource.
- "methods": { # Methods on this resource.
- "a_key": { # Description for any methods on this resource.
- "scopes": [ # OAuth 2.0 scopes applicable to this method.
- "A String",
- ],
- "description": "A String", # Description of this method.
- "parameters": { # Details for all parameters in this method.
- "a_key": { # Details for a single parameter in this method.
- "properties": { # If this is a schema for an object, list the schema for each property of this object.
- "a_key": # Object with schema name: JsonSchema # A single property of this object. The value is itself a JSON Schema object describing this property.
- },
- "required": True or False, # Whether the parameter is required.
- "type": "A String", # The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
- "description": "A String", # A description of this object.
- "format": "A String", # An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
- "default": "A String", # The default value of this property (if one exists).
- "items": # Object with schema name: JsonSchema # If this is a schema for an array, this property is the schema for each element in the array.
- "enum": [ # Values this parameter may take (if it is an enum).
- "A String",
- ],
- "maximum": "A String", # The maximum value of this parameter.
- "id": "A String", # Unique identifier for this schema.
- "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
- "A String",
- ],
- "minimum": "A String", # The minimum value of this parameter.
- "readOnly": True or False, # The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
- "location": "A String", # Whether this parameter goes in the query or the path for REST requests.
- "pattern": "A String", # The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
- "additionalProperties": # Object with schema name: JsonSchema # If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
- "repeated": True or False, # Whether this parameter may appear multiple times.
- "annotations": { # Additional information about this property.
- "required": [ # A list of methods for which this property is required on requests.
- "A String",
- ],
- },
- "$ref": "A String", # A reference to another schema. The value of this property is the "id" of another schema.
- },
- },
- "supportsMediaUpload": True or False, # Whether this method supports media uploads.
- "etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.
- "mediaUpload": { # Media upload parameters.
- "maxSize": "A String", # Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
- "protocols": { # Supported upload protocols.
- "simple": { # Supports uploading as a single HTTP request.
- "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
- "multipart": true, # True if this endpoint supports upload multipart media.
- },
- "resumable": { # Supports the Resumable Media Upload protocol.
- "path": "A String", # The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
- "multipart": true, # True if this endpoint supports uploading multipart media.
- },
- },
- "accept": [ # MIME Media Ranges for acceptable media uploads to this method.
- "A String",
- ],
- },
- "request": { # The schema for the request.
- "parameterName": "A String", # parameter name.
- "$ref": "A String", # Schema ID for the request schema.
- },
- "response": { # The schema for the response.
- "$ref": "A String", # Schema ID for the response schema.
- },
- "httpMethod": "A String", # HTTP method used by this method.
- "supportsSubscription": True or False, # Whether this method supports subscriptions.
- "parameterOrder": [ # Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first.
- "A String",
- ],
- "path": "A String", # The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
- "id": "A String", # A unique ID for this method. This property can be used to match methods between different versions of Discovery.
- "supportsMediaDownload": True or False, # Whether this method supports media downloads.
- },
- },
- "resources": { # Sub-resources on this resource.
- "a_key": # Object with schema name: RestResource # Description for any sub-resources on this resource.
- },
- },
- },
- "revision": "A String", # The version of this API.
- "description": "A String", # The description of this API.
- "canonicalName": "A String", # Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.
- "auth": { # Authentication information.
- "oauth2": { # OAuth 2.0 authentication information.
- "scopes": { # Available OAuth 2.0 scopes.
- "a_key": { # The scope value.
- "description": "A String", # Description of scope.
- },
- },
- },
- },
- "packagePath": "A String", # The package of the owner of this API. See ownerDomain.
- "kind": "discovery#restDescription", # The kind for this response.
- "name": "A String", # The name of this API.
- "basePath": "A String", # [DEPRECATED] The base path for REST requests.
- "title": "A String", # The title of this API.
- "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
- "documentationLink": "A String", # A link to human readable documentation for the API.
- }
-
-
list(name=None, preferred=None)
-
Retrieve the list of APIs supported at this endpoint.
-
-Args:
- name: string, Only include APIs with the given name.
- preferred: boolean, Return only the preferred version of an API.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # The individual directory entries. One entry per api/version pair.
- {
- "kind": "discovery#directoryItem", # The kind for this response.
- "labels": [ # Labels for the status of this API, such as labs or deprecated.
- "A String",
- ],
- "description": "A String", # The description of this API.
- "icons": { # Links to 16x16 and 32x32 icons representing the API.
- "x32": "A String", # The URL of the 32x32 icon.
- "x16": "A String", # The URL of the 16x16 icon.
- },
- "discoveryRestUrl": "A String", # The URL for the discovery REST document.
- "preferred": True or False, # True if this version is the preferred version to use.
- "name": "A String", # The name of the API.
- "discoveryLink": "A String", # A link to the discovery document.
- "version": "A String", # The version of the API.
- "title": "A String", # The title of this API.
- "id": "A String", # The id of this API.
- "documentationLink": "A String", # A link to human readable documentation for the API.
- },
- ],
- "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.
- "kind": "discovery#directoryList", # The kind for this response.
- }
-
Instance Methods
-
- apis()
-
-Returns the apis Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/doubleclickbidmanager_v1.html b/docs/dyn/doubleclickbidmanager_v1.html
deleted file mode 100644
index e1c40d7..0000000
--- a/docs/dyn/doubleclickbidmanager_v1.html
+++ /dev/null
@@ -1,87 +0,0 @@
-
-
-
-
-Instance Methods
-
- queries()
-
-Returns the queries Resource.
-
-
- reports()
-
-Returns the reports Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/doubleclickbidmanager_v1.queries.html b/docs/dyn/doubleclickbidmanager_v1.queries.html
deleted file mode 100644
index 91e1a97..0000000
--- a/docs/dyn/doubleclickbidmanager_v1.queries.html
+++ /dev/null
@@ -1,328 +0,0 @@
-
-
-
-
-Instance Methods
-
- createquery(body)
-Creates a query.
-
- deletequery(queryId)
-Deletes a stored query as well as the associated stored reports.
-
- getquery(queryId)
-Retrieves a stored query.
-
- listqueries()
-Retrieves stored queries.
-
- runquery(queryId, body)
-Runs a stored query to generate a report.
-Method Details
-
-
createquery(body)
-
Creates a query.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a query.
- "kind": "doubleclickbidmanager#query", # The kind, fixed to "doubleclickbidmanager#query".
- "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
- "endTimeMs": "A String", # Run the query periodically until the specified time.
- "frequency": "A String", # How often the query is run.
- },
- "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
- "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
- "queryId": "A String", # Query ID.
- "params": { # Parameters of a query or report. # Query parameters.
- "metrics": [ # Metrics to include as columns in your report.
- "A String",
- ],
- "includeInviteData": True or False, # Whether to include data from Invite Media.
- "type": "A String", # Report type.
- "groupBys": [ # Data is grouped by the filters listed in this field.
- "A String",
- ],
- "filters": [ # Filters used to match traffic data in your report.
- { # Filter used to match traffic data in your report.
- "type": "A String", # Filter type.
- "value": "A String", # Filter value.
- },
- ],
- },
- "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
- "metadata": { # Query metadata. # Query metadata.
- "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
- "dataRange": "A String", # Range of report data.
- "format": "A String", # Format of the generated report.
- "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
- "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
- "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
- "A String",
- ],
- "reportCount": 42, # Number of reports that have been generated for the query.
- "running": True or False, # Whether the latest report is currently running.
- "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
- "title": "A String", # Query title. It is used to name the reports generated from this query.
- },
-}
-
-
-Returns:
- An object of the form:
-
- { # Represents a query.
- "kind": "doubleclickbidmanager#query", # The kind, fixed to "doubleclickbidmanager#query".
- "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
- "endTimeMs": "A String", # Run the query periodically until the specified time.
- "frequency": "A String", # How often the query is run.
- },
- "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
- "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
- "queryId": "A String", # Query ID.
- "params": { # Parameters of a query or report. # Query parameters.
- "metrics": [ # Metrics to include as columns in your report.
- "A String",
- ],
- "includeInviteData": True or False, # Whether to include data from Invite Media.
- "type": "A String", # Report type.
- "groupBys": [ # Data is grouped by the filters listed in this field.
- "A String",
- ],
- "filters": [ # Filters used to match traffic data in your report.
- { # Filter used to match traffic data in your report.
- "type": "A String", # Filter type.
- "value": "A String", # Filter value.
- },
- ],
- },
- "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
- "metadata": { # Query metadata. # Query metadata.
- "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
- "dataRange": "A String", # Range of report data.
- "format": "A String", # Format of the generated report.
- "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
- "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
- "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
- "A String",
- ],
- "reportCount": 42, # Number of reports that have been generated for the query.
- "running": True or False, # Whether the latest report is currently running.
- "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
- "title": "A String", # Query title. It is used to name the reports generated from this query.
- },
- }
-
-
deletequery(queryId)
-
Deletes a stored query as well as the associated stored reports.
-
-Args:
- queryId: string, Query ID to delete. (required)
-
-
-
getquery(queryId)
-
Retrieves a stored query.
-
-Args:
- queryId: string, Query ID to retrieve. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a query.
- "kind": "doubleclickbidmanager#query", # The kind, fixed to "doubleclickbidmanager#query".
- "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
- "endTimeMs": "A String", # Run the query periodically until the specified time.
- "frequency": "A String", # How often the query is run.
- },
- "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
- "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
- "queryId": "A String", # Query ID.
- "params": { # Parameters of a query or report. # Query parameters.
- "metrics": [ # Metrics to include as columns in your report.
- "A String",
- ],
- "includeInviteData": True or False, # Whether to include data from Invite Media.
- "type": "A String", # Report type.
- "groupBys": [ # Data is grouped by the filters listed in this field.
- "A String",
- ],
- "filters": [ # Filters used to match traffic data in your report.
- { # Filter used to match traffic data in your report.
- "type": "A String", # Filter type.
- "value": "A String", # Filter value.
- },
- ],
- },
- "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
- "metadata": { # Query metadata. # Query metadata.
- "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
- "dataRange": "A String", # Range of report data.
- "format": "A String", # Format of the generated report.
- "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
- "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
- "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
- "A String",
- ],
- "reportCount": 42, # Number of reports that have been generated for the query.
- "running": True or False, # Whether the latest report is currently running.
- "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
- "title": "A String", # Query title. It is used to name the reports generated from this query.
- },
- }
-
-
listqueries()
-
Retrieves stored queries.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # List queries response.
- "kind": "doubleclickbidmanager#listQueriesResponse", # The kind, fixed to "doubleclickbidmanager#listQueriesResponse".
- "queries": [ # Retrieved queries.
- { # Represents a query.
- "kind": "doubleclickbidmanager#query", # The kind, fixed to "doubleclickbidmanager#query".
- "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
- "endTimeMs": "A String", # Run the query periodically until the specified time.
- "frequency": "A String", # How often the query is run.
- },
- "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
- "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
- "queryId": "A String", # Query ID.
- "params": { # Parameters of a query or report. # Query parameters.
- "metrics": [ # Metrics to include as columns in your report.
- "A String",
- ],
- "includeInviteData": True or False, # Whether to include data from Invite Media.
- "type": "A String", # Report type.
- "groupBys": [ # Data is grouped by the filters listed in this field.
- "A String",
- ],
- "filters": [ # Filters used to match traffic data in your report.
- { # Filter used to match traffic data in your report.
- "type": "A String", # Filter type.
- "value": "A String", # Filter value.
- },
- ],
- },
- "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
- "metadata": { # Query metadata. # Query metadata.
- "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
- "dataRange": "A String", # Range of report data.
- "format": "A String", # Format of the generated report.
- "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
- "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
- "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
- "A String",
- ],
- "reportCount": 42, # Number of reports that have been generated for the query.
- "running": True or False, # Whether the latest report is currently running.
- "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
- "title": "A String", # Query title. It is used to name the reports generated from this query.
- },
- },
- ],
- }
-
-
runquery(queryId, body)
-
Runs a stored query to generate a report.
-
-Args:
- queryId: string, Query ID to run. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Request to run a stored query to generate a report.
- "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.
- "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
- "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.
- "dataRange": "A String", # Report data range used to generate the report.
- }
-
-
-
Instance Methods
-
- listreports(queryId)
-Retrieves stored reports.
-Method Details
-
-
listreports(queryId)
-
Retrieves stored reports.
-
-Args:
- queryId: string, Query ID with which the reports are associated. (required)
-
-Returns:
- An object of the form:
-
- { # List reports response.
- "kind": "doubleclickbidmanager#listReportsResponse", # The kind, fixed to "doubleclickbidmanager#listReportsResponse".
- "reports": [ # Retrieved reports.
- { # Represents a report.
- "params": { # Parameters of a query or report. # Report parameters.
- "metrics": [ # Metrics to include as columns in your report.
- "A String",
- ],
- "includeInviteData": True or False, # Whether to include data from Invite Media.
- "type": "A String", # Report type.
- "groupBys": [ # Data is grouped by the filters listed in this field.
- "A String",
- ],
- "filters": [ # Filters used to match traffic data in your report.
- { # Filter used to match traffic data in your report.
- "type": "A String", # Filter type.
- "value": "A String", # Filter value.
- },
- ],
- },
- "key": { # Key used to identify a report. # Key used to identify a report.
- "queryId": "A String", # Query ID.
- "reportId": "A String", # Report ID.
- },
- "metadata": { # Report metadata. # Report metadata.
- "status": { # Report status. # Report status.
- "failure": { # An explanation of a report failure. # If the report failed, this records the cause.
- "errorCode": "A String", # Error code that shows why the report was not created.
- },
- "state": "A String", # The state of the report.
- "finishTimeMs": "A String", # The time when this report either completed successfully or failed.
- "format": "A String", # The file type of the report.
- },
- "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report.
- "googleCloudStoragePath": "A String", # The path to the location in Google Cloud Storage where the report is stored.
- "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report.
- },
- },
- ],
- }
-
Instance Methods
-
- get(includeSubscribed=None, startChangeId=None, maxChangeIdCount=None)
-Gets the information about the current user along with Drive API settings
-Method Details
-
-
get(includeSubscribed=None, startChangeId=None, maxChangeIdCount=None)
-
Gets the information about the current user along with Drive API settings
-
-Args:
- includeSubscribed: boolean, When calculating the number of remaining change IDs, whether to include shared files and public files the user has opened. When set to false, this counts only change IDs for owned files and any shared or public files that the user has explictly added to a folder in Drive.
- startChangeId: string, Change ID to start counting from when calculating number of remaining change IDs
- maxChangeIdCount: string, Maximum number of remaining change IDs to count
-
-Returns:
- An object of the form:
-
- { # An item with user information and settings.
- "kind": "drive#about", # This is always drive#about.
- "features": [ # List of additional features enabled on this account.
- {
- "featureName": "A String", # The name of the feature.
- "featureRate": 3.14, # The request limit rate for this feature, in queries per second.
- },
- ],
- "quotaBytesUsed": "A String", # The number of quota bytes used by Google Drive.
- "user": { # The JSON template for a user. # The authenticated user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "permissionId": "A String", # The current user's ID as visible in the permissions collection.
- "maxUploadSizes": [ # List of max upload sizes for each file type. The most specific type takes precedence.
- {
- "type": "A String", # The file type.
- "size": "A String", # The max upload size for this type.
- },
- ],
- "name": "A String", # The name of the current user.
- "remainingChangeIds": "A String", # The number of remaining change ids.
- "additionalRoleInfo": [ # Information about supported additional roles per file type. The most specific type takes precedence.
- {
- "roleSets": [ # The supported additional roles per primary role.
- {
- "primaryRole": "A String", # A primary permission role.
- "additionalRoles": [ # The supported additional roles with the primary role.
- "A String",
- ],
- },
- ],
- "type": "A String", # The content type that this additional role info applies to.
- },
- ],
- "etag": "A String", # The ETag of the item.
- "importFormats": [ # The allowable import formats.
- {
- "source": "A String", # The imported file's content type to convert from.
- "targets": [ # The possible content types to convert to.
- "A String",
- ],
- },
- ],
- "quotaBytesTotal": "A String", # The total number of quota bytes.
- "rootFolderId": "A String", # The id of the root folder.
- "largestChangeId": "A String", # The largest change id.
- "quotaBytesUsedInTrash": "A String", # The number of quota bytes used by trashed items.
- "exportFormats": [ # The allowable export formats.
- {
- "source": "A String", # The content type to convert from.
- "targets": [ # The possible content types to convert to.
- "A String",
- ],
- },
- ],
- "quotaBytesUsedAggregate": "A String", # The number of quota bytes used by all Google apps (Drive, Picasa, etc.).
- "domainSharingPolicy": "A String", # The domain sharing policy for the current user.
- "selfLink": "A String", # A link back to this item.
- "isCurrentAppInstalled": True or False, # A boolean indicating whether the authenticated app is installed by the authenticated user.
- }
-
Instance Methods
-
- get(appId)
-Gets a specific app.
-
- list()
-Lists a user's installed apps.
-Method Details
-
-
get(appId)
-
Gets a specific app.
-
-Args:
- appId: string, The ID of the app. (required)
-
-Returns:
- An object of the form:
-
- { # The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.
- "kind": "drive#app", # This is always drive#app.
- "primaryFileExtensions": [ # The list of primary file extensions.
- "A String",
- ],
- "secondaryMimeTypes": [ # The list of secondary mime types.
- "A String",
- ],
- "name": "A String", # The name of the app.
- "icons": [ # The various icons for the app.
- {
- "category": "A String", # Category of the icon. Allowed values are:
- # - application - icon for the application
- # - document - icon for a file associated with the app
- # - documentShared - icon for a shared file associated with the app
- "iconUrl": "A String", # URL for the icon.
- "size": 42, # Size of the icon. Represented as the maximum of the width and height.
- },
- ],
- "shortDescription": "A String", # A short description of the app.
- "secondaryFileExtensions": [ # The list of secondary file extensions.
- "A String",
- ],
- "useByDefault": True or False, # Whether the app is selected as the default handler for the types it supports.
- "installed": True or False, # Whether the app is installed.
- "supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
- "productUrl": "A String", # A link to the product listing for this app.
- "productId": "A String", # The ID of the product listing for this app.
- "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
- "supportsCreate": True or False, # Whether this app supports creating new objects.
- "supportsImport": True or False, # Whether this app supports importing Google Docs.
- "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids.
- "longDescription": "A String", # A long description of the app.
- "primaryMimeTypes": [ # The list of primary mime types.
- "A String",
- ],
- "id": "A String", # The ID of the app.
- "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
- }
-
-
list()
-
Lists a user's installed apps.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # A list of third-party applications which the user has installed or given access to Google Drive.
- "items": [ # The actual list of apps.
- { # The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.
- "kind": "drive#app", # This is always drive#app.
- "primaryFileExtensions": [ # The list of primary file extensions.
- "A String",
- ],
- "secondaryMimeTypes": [ # The list of secondary mime types.
- "A String",
- ],
- "name": "A String", # The name of the app.
- "icons": [ # The various icons for the app.
- {
- "category": "A String", # Category of the icon. Allowed values are:
- # - application - icon for the application
- # - document - icon for a file associated with the app
- # - documentShared - icon for a shared file associated with the app
- "iconUrl": "A String", # URL for the icon.
- "size": 42, # Size of the icon. Represented as the maximum of the width and height.
- },
- ],
- "shortDescription": "A String", # A short description of the app.
- "secondaryFileExtensions": [ # The list of secondary file extensions.
- "A String",
- ],
- "useByDefault": True or False, # Whether the app is selected as the default handler for the types it supports.
- "installed": True or False, # Whether the app is installed.
- "supportsMultiOpen": True or False, # Whether this app supports opening more than one file.
- "productUrl": "A String", # A link to the product listing for this app.
- "productId": "A String", # The ID of the product listing for this app.
- "authorized": True or False, # Whether the app is authorized to access data on the user's Drive.
- "supportsCreate": True or False, # Whether this app supports creating new objects.
- "supportsImport": True or False, # Whether this app supports importing Google Docs.
- "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids.
- "longDescription": "A String", # A long description of the app.
- "primaryMimeTypes": [ # The list of primary mime types.
- "A String",
- ],
- "id": "A String", # The ID of the app.
- "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.
- },
- ],
- "kind": "drive#appList", # This is always drive#appList.
- "etag": "A String", # The ETag of the list.
- "selfLink": "A String", # A link back to this list.
- }
-
Instance Methods
-
- get(changeId)
-Gets a specific change.
-
- list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)
-Lists the changes for a user.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- watch(body, includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)
-Subscribe to changes for a user.
-Method Details
-
-
get(changeId)
-
Gets a specific change.
-
-Args:
- changeId: string, The ID of the change. (required)
-
-Returns:
- An object of the form:
-
- { # Representation of a change to a file.
- "kind": "drive#change", # This is always drive#change.
- "deleted": True or False, # Whether the file has been deleted.
- "file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
- },
- "modificationDate": "A String", # The time of this modification.
- "id": "A String", # The ID of the change.
- "selfLink": "A String", # A link back to this change.
- "fileId": "A String", # The ID of the file associated with this change.
- }
-
-
list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)
-
Lists the changes for a user.
-
-Args:
- includeSubscribed: boolean, Whether to include shared files and public files the user has opened. When set to false, the list will include owned files plus any shared or public files the user has explictly added to a folder in Drive.
- includeDeleted: boolean, Whether to include deleted items.
- pageToken: string, Page token for changes.
- maxResults: integer, Maximum number of changes to return.
- startChangeId: string, Change ID to start listing changes from.
-
-Returns:
- An object of the form:
-
- { # A list of changes for a user.
- "nextPageToken": "A String", # The page token for the next page of changes.
- "kind": "drive#changeList", # This is always drive#changeList.
- "items": [ # The actual list of changes.
- { # Representation of a change to a file.
- "kind": "drive#change", # This is always drive#change.
- "deleted": True or False, # Whether the file has been deleted.
- "file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
- },
- "modificationDate": "A String", # The time of this modification.
- "id": "A String", # The ID of the change.
- "selfLink": "A String", # A link back to this change.
- "fileId": "A String", # The ID of the file associated with this change.
- },
- ],
- "nextLink": "A String", # A link to the next page of changes.
- "etag": "A String", # The ETag of the list.
- "largestChangeId": "A String", # The current largest change ID.
- "selfLink": "A String", # A link back to this list.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
watch(body, includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)
-
Subscribe to changes for a user.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
- includeSubscribed: boolean, Whether to include shared files and public files the user has opened. When set to false, the list will include owned files plus any shared or public files the user has explictly added to a folder in Drive.
- includeDeleted: boolean, Whether to include deleted items.
- pageToken: string, Page token for changes.
- maxResults: integer, Maximum number of changes to return.
- startChangeId: string, Change ID to start listing changes from.
-
-Returns:
- An object of the form:
-
- {
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
Instance Methods
-
- stop(body)
-A description of how to use this function
-Method Details
-
-
stop(body)
-
A description of how to use this function
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
-
-
Instance Methods
-
- delete(folderId, childId)
-Removes a child from a folder.
-
- get(folderId, childId)
-Gets a specific child reference.
-
- insert(folderId, body)
-Inserts a file into a folder.
-
- list(folderId, q=None, pageToken=None, maxResults=None)
-Lists a folder's children.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(folderId, childId)
-
Removes a child from a folder.
-
-Args:
- folderId: string, The ID of the folder. (required)
- childId: string, The ID of the child. (required)
-
-
-
get(folderId, childId)
-
Gets a specific child reference.
-
-Args:
- folderId: string, The ID of the folder. (required)
- childId: string, The ID of the child. (required)
-
-Returns:
- An object of the form:
-
- { # A reference to a folder's child.
- "kind": "drive#childReference", # This is always drive#childReference.
- "childLink": "A String", # A link to the child.
- "id": "A String", # The ID of the child.
- "selfLink": "A String", # A link back to this reference.
- }
-
-
insert(folderId, body)
-
Inserts a file into a folder.
-
-Args:
- folderId: string, The ID of the folder. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A reference to a folder's child.
- "kind": "drive#childReference", # This is always drive#childReference.
- "childLink": "A String", # A link to the child.
- "id": "A String", # The ID of the child.
- "selfLink": "A String", # A link back to this reference.
- }
-
-
-Returns:
- An object of the form:
-
- { # A reference to a folder's child.
- "kind": "drive#childReference", # This is always drive#childReference.
- "childLink": "A String", # A link to the child.
- "id": "A String", # The ID of the child.
- "selfLink": "A String", # A link back to this reference.
- }
-
-
list(folderId, q=None, pageToken=None, maxResults=None)
-
Lists a folder's children.
-
-Args:
- folderId: string, The ID of the folder. (required)
- q: string, Query string for searching children.
- pageToken: string, Page token for children.
- maxResults: integer, Maximum number of children to return.
-
-Returns:
- An object of the form:
-
- { # A list of children of a file.
- "nextPageToken": "A String", # The page token for the next page of children.
- "kind": "drive#childList", # This is always drive#childList.
- "items": [ # The actual list of children.
- { # A reference to a folder's child.
- "kind": "drive#childReference", # This is always drive#childReference.
- "childLink": "A String", # A link to the child.
- "id": "A String", # The ID of the child.
- "selfLink": "A String", # A link back to this reference.
- },
- ],
- "nextLink": "A String", # A link to the next page of children.
- "etag": "A String", # The ETag of the list.
- "selfLink": "A String", # A link back to this list.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(fileId, commentId)
-Deletes a comment.
-
- get(fileId, commentId, includeDeleted=None)
-Gets a comment by ID.
-
- insert(fileId, body)
-Creates a new comment on the given file.
-
- list(fileId, includeDeleted=None, pageToken=None, updatedMin=None, maxResults=None)
-Lists a file's comments.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(fileId, commentId, body)
-Updates an existing comment. This method supports patch semantics.
-
- update(fileId, commentId, body)
-Updates an existing comment.
-Method Details
-
-
delete(fileId, commentId)
-
Deletes a comment.
-
-Args:
- fileId: string, The ID of the file. (required)
- commentId: string, The ID of the comment. (required)
-
-
-
get(fileId, commentId, includeDeleted=None)
-
Gets a comment by ID.
-
-Args:
- fileId: string, The ID of the file. (required)
- commentId: string, The ID of the comment. (required)
- includeDeleted: boolean, If set, this will succeed when retrieving a deleted comment, and will include any deleted replies.
-
-Returns:
- An object of the form:
-
- { # A JSON representation of a comment on a file in Google Drive.
- "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
- # - "open" - The comment is still open.
- # - "resolved" - The comment has been resolved by one of its replies.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
- "replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- },
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
- },
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }
-
-
insert(fileId, body)
-
Creates a new comment on the given file.
-
-Args:
- fileId: string, The ID of the file. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A JSON representation of a comment on a file in Google Drive.
- "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
- # - "open" - The comment is still open.
- # - "resolved" - The comment has been resolved by one of its replies.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
- "replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- },
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
- },
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }
-
-
-Returns:
- An object of the form:
-
- { # A JSON representation of a comment on a file in Google Drive.
- "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
- # - "open" - The comment is still open.
- # - "resolved" - The comment has been resolved by one of its replies.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
- "replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- },
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
- },
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }
-
-
list(fileId, includeDeleted=None, pageToken=None, updatedMin=None, maxResults=None)
-
Lists a file's comments.
-
-Args:
- fileId: string, The ID of the file. (required)
- includeDeleted: boolean, If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
- 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.
- updatedMin: string, Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.
- maxResults: integer, The maximum number of discussions to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- { # A JSON representation of a list of comments on a file in Google Drive.
- "nextPageToken": "A String", # The token to use to request the next page of results.
- "items": [ # List of comments.
- { # A JSON representation of a comment on a file in Google Drive.
- "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
- # - "open" - The comment is still open.
- # - "resolved" - The comment has been resolved by one of its replies.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
- "replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- },
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
- },
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- },
- ],
- "kind": "drive#commentList", # This is always drive#commentList.
- "selfLink": "A String", # A link back to this list.
- "nextLink": "A String", # A link to the next page of comments.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(fileId, commentId, body)
-
Updates an existing comment. This method supports patch semantics.
-
-Args:
- fileId: string, The ID of the file. (required)
- commentId: string, The ID of the comment. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A JSON representation of a comment on a file in Google Drive.
- "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
- # - "open" - The comment is still open.
- # - "resolved" - The comment has been resolved by one of its replies.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
- "replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- },
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
- },
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }
-
-
-Returns:
- An object of the form:
-
- { # A JSON representation of a comment on a file in Google Drive.
- "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
- # - "open" - The comment is still open.
- # - "resolved" - The comment has been resolved by one of its replies.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
- "replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- },
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
- },
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }
-
-
update(fileId, commentId, body)
-
Updates an existing comment.
-
-Args:
- fileId: string, The ID of the file. (required)
- commentId: string, The ID of the comment. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A JSON representation of a comment on a file in Google Drive.
- "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
- # - "open" - The comment is still open.
- # - "resolved" - The comment has been resolved by one of its replies.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
- "replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- },
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
- },
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }
-
-
-Returns:
- An object of the form:
-
- { # A JSON representation of a comment on a file in Google Drive.
- "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
- # - "open" - The comment is still open.
- # - "resolved" - The comment has been resolved by one of its replies.
- "selfLink": "A String", # A link back to this comment.
- "kind": "drive#comment", # This is always drive#comment.
- "author": { # The JSON template for a user. # The user who wrote this comment.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
- "replies": [ # Replies to this post.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- },
- ],
- "htmlContent": "A String", # HTML formatted content for this comment.
- "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
- "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
- "context": { # The context of the file which is being commented on.
- "type": "A String", # The MIME type of the context snippet.
- "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
- },
- "createdDate": "A String", # The date when this comment was first created.
- "commentId": "A String", # The ID of the comment.
- "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
- "fileTitle": "A String", # The title of the file which this comment is addressing.
- "fileId": "A String", # The file which this comment is addressing.
- }
-
Instance Methods
-
- copy(fileId, body, pinned=None, convert=None, visibility=None, ocrLanguage=None, ocr=None, timedTextLanguage=None, timedTextTrackName=None)
-Creates a copy of the specified file.
-
- delete(fileId)
-Permanently deletes a file by ID. Skips the trash.
-
- get(fileId, projection=None, updateViewedDate=None)
-Gets a file's metadata by ID.
-
- insert(body=None, media_body=None, convert=None, useContentAsIndexableText=None, visibility=None, ocrLanguage=None, ocr=None, timedTextLanguage=None, timedTextTrackName=None, pinned=None)
-Insert a new file.
-
- list(q=None, projection=None, pageToken=None, maxResults=None)
-Lists the user's files.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(fileId, body, newRevision=None, pinned=None, ocrLanguage=None, ocr=None, updateViewedDate=None, timedTextTrackName=None, convert=None, useContentAsIndexableText=None, setModifiedDate=None, timedTextLanguage=None)
-Updates file metadata and/or content. This method supports patch semantics.
-
- touch(fileId)
-Set the file's updated time to the current server time.
-
- trash(fileId)
-Moves a file to the trash.
-
- untrash(fileId)
-Restores a file from the trash.
-
- update(fileId, body=None, newRevision=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, updateViewedDate=None, timedTextTrackName=None, convert=None, useContentAsIndexableText=None, setModifiedDate=None, timedTextLanguage=None)
-Updates file metadata and/or content.
-
- watch(fileId, body, projection=None, updateViewedDate=None)
-Subscribe to changes on a file
-Method Details
-
-
copy(fileId, body, pinned=None, convert=None, visibility=None, ocrLanguage=None, ocr=None, timedTextLanguage=None, timedTextTrackName=None)
-
Creates a copy of the specified file.
-
-Args:
- fileId: string, The ID of the file to copy. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
-}
-
- pinned: boolean, Whether to pin the head revision of the new copy.
- convert: boolean, Whether to convert this file to the corresponding Google Docs format.
- visibility: string, The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false.
- Allowed values
- DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies.
- PRIVATE - The new file will be visible to only the owner.
- ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
- ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
- timedTextLanguage: string, The language of the timed text.
- timedTextTrackName: string, The timed text track name.
-
-Returns:
- An object of the form:
-
- { # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
- }
-
-
delete(fileId)
-
Permanently deletes a file by ID. Skips the trash.
-
-Args:
- fileId: string, The ID of the file to delete. (required)
-
-
-
get(fileId, projection=None, updateViewedDate=None)
-
Gets a file's metadata by ID.
-
-Args:
- fileId: string, The ID for the file in question. (required)
- projection: string, This parameter is deprecated and has no function.
- Allowed values
- BASIC - Deprecated
- FULL - Deprecated
- updateViewedDate: boolean, Whether to update the view date after successfully retrieving the file.
-
-Returns:
- An object of the form:
-
- { # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
- }
-
-
insert(body=None, media_body=None, convert=None, useContentAsIndexableText=None, visibility=None, ocrLanguage=None, ocr=None, timedTextLanguage=None, timedTextTrackName=None, pinned=None)
-
Insert a new file.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{ # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
-}
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- convert: boolean, Whether to convert this file to the corresponding Google Docs format.
- useContentAsIndexableText: boolean, Whether to use the content as indexable text.
- visibility: string, The visibility of the new file. This parameter is only relevant when convert=false.
- Allowed values
- DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies.
- PRIVATE - The new file will be visible to only the owner.
- ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
- ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
- timedTextLanguage: string, The language of the timed text.
- timedTextTrackName: string, The timed text track name.
- pinned: boolean, Whether to pin the head revision of the uploaded file.
-
-Returns:
- An object of the form:
-
- { # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
- }
-
-
list(q=None, projection=None, pageToken=None, maxResults=None)
-
Lists the user's files.
-
-Args:
- q: string, Query string for searching files.
- projection: string, This parameter is deprecated and has no function.
- Allowed values
- BASIC - Deprecated
- FULL - Deprecated
- pageToken: string, Page token for files.
- maxResults: integer, Maximum number of files to return.
-
-Returns:
- An object of the form:
-
- { # A list of files.
- "nextPageToken": "A String", # The page token for the next page of files.
- "kind": "drive#fileList", # This is always drive#fileList.
- "items": [ # The actual list of files.
- { # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
- },
- ],
- "nextLink": "A String", # A link to the next page of files.
- "etag": "A String", # The ETag of the list.
- "selfLink": "A String", # A link back to this list.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(fileId, body, newRevision=None, pinned=None, ocrLanguage=None, ocr=None, updateViewedDate=None, timedTextTrackName=None, convert=None, useContentAsIndexableText=None, setModifiedDate=None, timedTextLanguage=None)
-
Updates file metadata and/or content. This method supports patch semantics.
-
-Args:
- fileId: string, The ID of the file to update. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
-}
-
- newRevision: boolean, Whether a blob upload should create a new revision. If not set or false, the blob data in the current head revision is replaced. If true, a new blob is created as head revision, and previous revisions are preserved (causing increased use of the user's data storage quota).
- pinned: boolean, Whether to pin the new revision.
- ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
- ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
- updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
- timedTextTrackName: string, The timed text track name.
- convert: boolean, Whether to convert this file to the corresponding Google Docs format.
- useContentAsIndexableText: boolean, Whether to use the content as indexable text.
- setModifiedDate: boolean, Whether to set the modified date with the supplied modified date.
- timedTextLanguage: string, The language of the timed text.
-
-Returns:
- An object of the form:
-
- { # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
- }
-
-
touch(fileId)
-
Set the file's updated time to the current server time.
-
-Args:
- fileId: string, The ID of the file to update. (required)
-
-Returns:
- An object of the form:
-
- { # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
- }
-
-
trash(fileId)
-
Moves a file to the trash.
-
-Args:
- fileId: string, The ID of the file to trash. (required)
-
-Returns:
- An object of the form:
-
- { # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
- }
-
-
untrash(fileId)
-
Restores a file from the trash.
-
-Args:
- fileId: string, The ID of the file to untrash. (required)
-
-Returns:
- An object of the form:
-
- { # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
- }
-
-
update(fileId, body=None, newRevision=None, media_body=None, ocrLanguage=None, ocr=None, pinned=None, updateViewedDate=None, timedTextTrackName=None, convert=None, useContentAsIndexableText=None, setModifiedDate=None, timedTextLanguage=None)
-
Updates file metadata and/or content.
-
-Args:
- fileId: string, The ID of the file to update. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
-}
-
- newRevision: boolean, Whether a blob upload should create a new revision. If not set or false, the blob data in the current head revision is replaced. If true, a new blob is created as head revision, and previous revisions are preserved (causing increased use of the user's data storage quota).
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
- ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
- pinned: boolean, Whether to pin the new revision.
- updateViewedDate: boolean, Whether to update the view date after successfully updating the file.
- timedTextTrackName: string, The timed text track name.
- convert: boolean, Whether to convert this file to the corresponding Google Docs format.
- useContentAsIndexableText: boolean, Whether to use the content as indexable text.
- setModifiedDate: boolean, Whether to set the modified date with the supplied modified date.
- timedTextLanguage: string, The language of the timed text.
-
-Returns:
- An object of the form:
-
- { # The metadata for a file.
- "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
- "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
- "appDataContents": True or False, # Whether this file is in the appdata folder.
- "thumbnailLink": "A String", # A link to the file's thumbnail.
- "labels": { # A group of labels for the file.
- "restricted": True or False, # Whether viewers are prevented from downloading this file.
- "hidden": True or False, # Whether this file is hidden from the user.
- "viewed": True or False, # Whether this file has been viewed by this 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.
- },
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. This will only be populated if the file is trashed.
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
- "writersCanShare": True or False, # Whether writers can share the document with other users.
- "owners": [ # The owner(s) of this file.
- { # The JSON template for a user.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- ],
- "id": "A String", # The ID of the file.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this file.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "copyable": True or False, # Whether the file can be copied by the current user.
- "ownerNames": [ # Name(s) of the owner(s) of this file.
- "A String",
- ],
- "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
- "etag": "A String", # ETag of the file.
- "parents": [ # Collection of parent folders which contain this file.
- # Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "shared": True or False, # Whether the file has been shared.
- "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
- "mimeType": "A String", # The MIME type of the thumbnail.
- "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
- },
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
- "a_key": "A String",
- },
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "location": { # Geographic location information stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
- },
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "height": 42, # The height of the image in pixels.
- "lens": "A String", # The lens used to create the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "width": 42, # The width of the image in pixels.
- "meteringMode": "A String", # The metering mode used to create the photo.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- },
- "description": "A String", # A short description of the file.
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "editable": True or False, # Whether the file can be edited by the current user.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "fileSize": "A String", # The size of the file in bytes. This is only populated for files with content stored in Drive.
- "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
- "properties": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This is populated only for files with content stored in Drive.
- "iconLink": "A String", # A link to the file's icon.
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
- "embedLink": "A String", # A link for embedding the file.
- "alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
- "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
- "downloadUrl": "A String", # Short lived download URL for the file. This is only populated for files with content stored in Drive.
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- "originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
- "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it in the title when creating the file. This is only populated for files with content stored in Drive.
- "headRevisionId": "A String", # The ID of the file's head revision. This will only be populated for files with content stored in Drive.
- "selfLink": "A String", # A link back to this file.
- "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
- }
-
-
watch(fileId, body, projection=None, updateViewedDate=None)
-
Subscribe to changes on a file
-
-Args:
- fileId: string, The ID for the file in question. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
- projection: string, This parameter is deprecated and has no function.
- Allowed values
- BASIC - Deprecated
- FULL - Deprecated
- updateViewedDate: boolean, Whether to update the view date after successfully retrieving the file.
-
-Returns:
- An object of the form:
-
- {
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
Instance Methods
-
- about()
-
-Returns the about Resource.
-
-
- apps()
-
-Returns the apps Resource.
-
-
- changes()
-
-Returns the changes Resource.
-
-
- channels()
-
-Returns the channels Resource.
-
-
- children()
-
-Returns the children Resource.
-
-
- comments()
-
-Returns the comments Resource.
-
-
- files()
-
-Returns the files Resource.
-
-
- parents()
-
-Returns the parents Resource.
-
-
- permissions()
-
-Returns the permissions Resource.
-
-
- properties()
-
-Returns the properties Resource.
-
-
- realtime()
-
-Returns the realtime Resource.
-
-
- replies()
-
-Returns the replies Resource.
-
-
- revisions()
-
-Returns the revisions Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/drive_v2.parents.html b/docs/dyn/drive_v2.parents.html
deleted file mode 100644
index 4dc0671..0000000
--- a/docs/dyn/drive_v2.parents.html
+++ /dev/null
@@ -1,176 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(fileId, parentId)
-Removes a parent from a file.
-
- get(fileId, parentId)
-Gets a specific parent reference.
-
- insert(fileId, body)
-Adds a parent folder for a file.
-
- list(fileId)
-Lists a file's parents.
-Method Details
-
-
delete(fileId, parentId)
-
Removes a parent from a file.
-
-Args:
- fileId: string, The ID of the file. (required)
- parentId: string, The ID of the parent. (required)
-
-
-
get(fileId, parentId)
-
Gets a specific parent reference.
-
-Args:
- fileId: string, The ID of the file. (required)
- parentId: string, The ID of the parent. (required)
-
-Returns:
- An object of the form:
-
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- }
-
-
insert(fileId, body)
-
Adds a parent folder for a file.
-
-Args:
- fileId: string, The ID of the file. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
-}
-
-
-Returns:
- An object of the form:
-
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- }
-
-
list(fileId)
-
Lists a file's parents.
-
-Args:
- fileId: string, The ID of the file. (required)
-
-Returns:
- An object of the form:
-
- { # A list of a file's parents.
- "items": [ # The actual list of parents.
- { # A reference to a file's parent.
- "selfLink": "A String", # A link back to this reference.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "parentLink": "A String", # A link to the parent.
- },
- ],
- "kind": "drive#parentList", # This is always drive#parentList.
- "etag": "A String", # The ETag of the list.
- "selfLink": "A String", # A link back to this list.
- }
-
Instance Methods
-
- delete(fileId, permissionId)
-Deletes a permission from a file.
-
- get(fileId, permissionId)
-Gets a permission by ID.
-
- insert(fileId, body, sendNotificationEmails=None, emailMessage=None)
-Inserts a permission for a file.
-
- list(fileId)
-Lists a file's permissions.
-
- patch(fileId, permissionId, body, transferOwnership=None)
-Updates a permission. This method supports patch semantics.
-
- update(fileId, permissionId, body, transferOwnership=None)
-Updates a permission.
-Method Details
-
-
delete(fileId, permissionId)
-
Deletes a permission from a file.
-
-Args:
- fileId: string, The ID for the file. (required)
- permissionId: string, The ID for the permission. (required)
-
-
-
get(fileId, permissionId)
-
Gets a permission by ID.
-
-Args:
- fileId: string, The ID for the file. (required)
- permissionId: string, The ID for the permission. (required)
-
-Returns:
- An object of the form:
-
- { # A permission for a file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- }
-
-
insert(fileId, body, sendNotificationEmails=None, emailMessage=None)
-
Inserts a permission for a file.
-
-Args:
- fileId: string, The ID for the file. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A permission for a file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
-}
-
- sendNotificationEmails: boolean, Whether to send notification emails when sharing to users or groups.
- emailMessage: string, A custom message to include in notification emails.
-
-Returns:
- An object of the form:
-
- { # A permission for a file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- }
-
-
list(fileId)
-
Lists a file's permissions.
-
-Args:
- fileId: string, The ID for the file. (required)
-
-Returns:
- An object of the form:
-
- { # A list of permissions associated with a file.
- "items": [ # The actual list of permissions.
- { # A permission for a file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- },
- ],
- "kind": "drive#permissionList", # This is always drive#permissionList.
- "etag": "A String", # The ETag of the list.
- "selfLink": "A String", # A link back to this list.
- }
-
-
patch(fileId, permissionId, body, transferOwnership=None)
-
Updates a permission. This method supports patch semantics.
-
-Args:
- fileId: string, The ID for the file. (required)
- permissionId: string, The ID for the permission. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A permission for a file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
-}
-
- transferOwnership: boolean, Whether changing a role to 'owner' should also downgrade the current owners to writers.
-
-Returns:
- An object of the form:
-
- { # A permission for a file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- }
-
-
update(fileId, permissionId, body, transferOwnership=None)
-
Updates a permission.
-
-Args:
- fileId: string, The ID for the file. (required)
- permissionId: string, The ID for the permission. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A permission for a file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
-}
-
- transferOwnership: boolean, Whether changing a role to 'owner' should also downgrade the current owners to writers.
-
-Returns:
- An object of the form:
-
- { # A permission for a file.
- "withLink": True or False, # Whether the link is required for this permission.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is populated when the permission type is "user", "group" or "domain".
- "name": "A String", # The name for this permission.
- "kind": "drive#permission", # This is always drive#permission.
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses.
- "id": "A String", # The ID of the permission.
- "authKey": "A String", # The authkey parameter required for this permission.
- "etag": "A String", # The ETag of the permission.
- "emailAddress": "A String", # The email address of the user this permission refers to. This is an output-only field which is populated when the permission type is "user" and the given user's Google+ profile privacy settings allow exposing their email address.
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. Allowed values are:
- # - owner
- # - reader
- # - writer
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
- "A String",
- ],
- "selfLink": "A String", # A link back to this permission.
- }
-
Instance Methods
-
- delete(fileId, propertyKey, visibility=None)
-Deletes a property.
-
- get(fileId, propertyKey, visibility=None)
-Gets a property by its key.
-
- insert(fileId, body)
-Adds a property to a file.
-
- list(fileId)
-Lists a file's properties.
-
- patch(fileId, propertyKey, body, visibility=None)
-Updates a property. This method supports patch semantics.
-
- update(fileId, propertyKey, body, visibility=None)
-Updates a property.
-Method Details
-
-
delete(fileId, propertyKey, visibility=None)
-
Deletes a property.
-
-Args:
- fileId: string, The ID of the file. (required)
- propertyKey: string, The key of the property. (required)
- visibility: string, The visibility of the property.
-
-
-
get(fileId, propertyKey, visibility=None)
-
Gets a property by its key.
-
-Args:
- fileId: string, The ID of the file. (required)
- propertyKey: string, The key of the property. (required)
- visibility: string, The visibility of the property.
-
-Returns:
- An object of the form:
-
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- }
-
-
insert(fileId, body)
-
Adds a property to a file.
-
-Args:
- fileId: string, The ID of the file. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
-}
-
-
-Returns:
- An object of the form:
-
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- }
-
-
list(fileId)
-
Lists a file's properties.
-
-Args:
- fileId: string, The ID of the file. (required)
-
-Returns:
- An object of the form:
-
- { # A collection of properties, key-value pairs that are either public or private to an application.
- "items": [ # The list of properties.
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- },
- ],
- "kind": "drive#propertyList", # This is always drive#propertyList.
- "etag": "A String", # The ETag of the list.
- "selfLink": "A String", # The link back to this list.
- }
-
-
patch(fileId, propertyKey, body, visibility=None)
-
Updates a property. This method supports patch semantics.
-
-Args:
- fileId: string, The ID of the file. (required)
- propertyKey: string, The key of the property. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
-}
-
- visibility: string, The visibility of the property.
-
-Returns:
- An object of the form:
-
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- }
-
-
update(fileId, propertyKey, body, visibility=None)
-
Updates a property.
-
-Args:
- fileId: string, The ID of the file. (required)
- propertyKey: string, The key of the property. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
-}
-
- visibility: string, The visibility of the property.
-
-Returns:
- An object of the form:
-
- { # A key-value pair that is either public or private to an application.
- "kind": "drive#property", # This is always drive#property.
- "value": "A String", # The value of this property.
- "etag": "A String", # ETag of the property.
- "visibility": "A String", # The visibility of this property.
- "key": "A String", # The key of this property.
- "selfLink": "A String", # The link back to this property.
- }
-
Instance Methods
-
- get(fileId)
-Exports the contents of the Realtime API data model associated with this file as JSON.
-
- get_media(fileId)
-Exports the contents of the Realtime API data model associated with this file as JSON.
-Method Details
-
-
get(fileId)
-
Exports the contents of the Realtime API data model associated with this file as JSON.
-
-Args:
- fileId: string, The ID of the file that the Realtime API data model is associated with. (required)
-
-
-
get_media(fileId)
-
Exports the contents of the Realtime API data model associated with this file as JSON.
-
-Args:
- fileId: string, The ID of the file that the Realtime API data model is associated with. (required)
-
-
Instance Methods
-
- delete(fileId, commentId, replyId)
-Deletes a reply.
-
- get(fileId, commentId, replyId, includeDeleted=None)
-Gets a reply.
-
- insert(fileId, commentId, body)
-Creates a new reply to the given comment.
-
- list(fileId, commentId, includeDeleted=None, pageToken=None, maxResults=None)
-Lists all of the replies to a comment.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(fileId, commentId, replyId, body)
-Updates an existing reply. This method supports patch semantics.
-
- update(fileId, commentId, replyId, body)
-Updates an existing reply.
-Method Details
-
-
delete(fileId, commentId, replyId)
-
Deletes a reply.
-
-Args:
- fileId: string, The ID of the file. (required)
- commentId: string, The ID of the comment. (required)
- replyId: string, The ID of the reply. (required)
-
-
-
get(fileId, commentId, replyId, includeDeleted=None)
-
Gets a reply.
-
-Args:
- fileId: string, The ID of the file. (required)
- commentId: string, The ID of the comment. (required)
- replyId: string, The ID of the reply. (required)
- includeDeleted: boolean, If set, this will succeed when retrieving a deleted reply.
-
-Returns:
- An object of the form:
-
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- }
-
-
insert(fileId, commentId, body)
-
Creates a new reply to the given comment.
-
-Args:
- fileId: string, The ID of the file. (required)
- commentId: string, The ID of the comment. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
-}
-
-
-Returns:
- An object of the form:
-
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- }
-
-
list(fileId, commentId, includeDeleted=None, pageToken=None, maxResults=None)
-
Lists all of the replies to a comment.
-
-Args:
- fileId: string, The ID of the file. (required)
- commentId: string, The ID of the comment. (required)
- includeDeleted: boolean, If set, all replies, including deleted replies (with content stripped) will be returned.
- 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 replies to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- { # A JSON representation of a list of replies to a comment on a file in Google Drive.
- "nextPageToken": "A String", # The token to use to request the next page of results.
- "items": [ # List of reply.
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- },
- ],
- "kind": "drive#commentReplyList", # This is always drive#commentReplyList.
- "selfLink": "A String", # A link back to this list.
- "nextLink": "A String", # A link to the next page of replies.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(fileId, commentId, replyId, body)
-
Updates an existing reply. This method supports patch semantics.
-
-Args:
- fileId: string, The ID of the file. (required)
- commentId: string, The ID of the comment. (required)
- replyId: string, The ID of the reply. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
-}
-
-
-Returns:
- An object of the form:
-
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- }
-
-
update(fileId, commentId, replyId, body)
-
Updates an existing reply.
-
-Args:
- fileId: string, The ID of the file. (required)
- commentId: string, The ID of the comment. (required)
- replyId: string, The ID of the reply. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
-}
-
-
-Returns:
- An object of the form:
-
- { # A JSON representation of a reply to a comment on a file in Google Drive.
- "kind": "drive#commentReply", # This is always drive#commentReply.
- "author": { # The JSON template for a user. # The user who wrote this reply.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
- "htmlContent": "A String", # HTML formatted content for this reply.
- "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
- "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
- # - "resolve" - To resolve a comment.
- # - "reopen" - To reopen (un-resolve) a comment.
- "replyId": "A String", # The ID of the reply.
- "modifiedDate": "A String", # The date when this reply was last modified.
- "createdDate": "A String", # The date when this reply was first created.
- }
-
Instance Methods
-
- delete(fileId, revisionId)
-Removes a revision.
-
- get(fileId, revisionId)
-Gets a specific revision.
-
- list(fileId)
-Lists a file's revisions.
-
- patch(fileId, revisionId, body)
-Updates a revision. This method supports patch semantics.
-
- update(fileId, revisionId, body)
-Updates a revision.
-Method Details
-
-
delete(fileId, revisionId)
-
Removes a revision.
-
-Args:
- fileId: string, The ID of the file. (required)
- revisionId: string, The ID of the revision. (required)
-
-
-
get(fileId, revisionId)
-
Gets a specific revision.
-
-Args:
- fileId: string, The ID of the file. (required)
- revisionId: string, The ID of the revision. (required)
-
-Returns:
- An object of the form:
-
- { # A revision of a file.
- "mimeType": "A String", # The MIME type of the revision.
- "pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
- "kind": "drive#revision", # This is always drive#revision.
- "publishedLink": "A String", # A link to the published revision.
- "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
- "published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
- "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
- "selfLink": "A String", # A link back to this revision.
- "etag": "A String", # The ETag of the revision.
- "fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "lastModifyingUserName": "A String", # Name of the last user to modify this revision.
- "originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
- "id": "A String", # The ID of the revision.
- "md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
- "modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
- }
-
-
list(fileId)
-
Lists a file's revisions.
-
-Args:
- fileId: string, The ID of the file. (required)
-
-Returns:
- An object of the form:
-
- { # A list of revisions of a file.
- "items": [ # The actual list of revisions.
- { # A revision of a file.
- "mimeType": "A String", # The MIME type of the revision.
- "pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
- "kind": "drive#revision", # This is always drive#revision.
- "publishedLink": "A String", # A link to the published revision.
- "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
- "published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
- "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
- "selfLink": "A String", # A link back to this revision.
- "etag": "A String", # The ETag of the revision.
- "fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "lastModifyingUserName": "A String", # Name of the last user to modify this revision.
- "originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
- "id": "A String", # The ID of the revision.
- "md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
- "modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
- },
- ],
- "kind": "drive#revisionList", # This is always drive#revisionList.
- "etag": "A String", # The ETag of the list.
- "selfLink": "A String", # A link back to this list.
- }
-
-
patch(fileId, revisionId, body)
-
Updates a revision. This method supports patch semantics.
-
-Args:
- fileId: string, The ID for the file. (required)
- revisionId: string, The ID for the revision. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A revision of a file.
- "mimeType": "A String", # The MIME type of the revision.
- "pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
- "kind": "drive#revision", # This is always drive#revision.
- "publishedLink": "A String", # A link to the published revision.
- "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
- "published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
- "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
- "selfLink": "A String", # A link back to this revision.
- "etag": "A String", # The ETag of the revision.
- "fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "lastModifyingUserName": "A String", # Name of the last user to modify this revision.
- "originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
- "id": "A String", # The ID of the revision.
- "md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
- "modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
- }
-
-
-Returns:
- An object of the form:
-
- { # A revision of a file.
- "mimeType": "A String", # The MIME type of the revision.
- "pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
- "kind": "drive#revision", # This is always drive#revision.
- "publishedLink": "A String", # A link to the published revision.
- "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
- "published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
- "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
- "selfLink": "A String", # A link back to this revision.
- "etag": "A String", # The ETag of the revision.
- "fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "lastModifyingUserName": "A String", # Name of the last user to modify this revision.
- "originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
- "id": "A String", # The ID of the revision.
- "md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
- "modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
- }
-
-
update(fileId, revisionId, body)
-
Updates a revision.
-
-Args:
- fileId: string, The ID for the file. (required)
- revisionId: string, The ID for the revision. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A revision of a file.
- "mimeType": "A String", # The MIME type of the revision.
- "pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
- "kind": "drive#revision", # This is always drive#revision.
- "publishedLink": "A String", # A link to the published revision.
- "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
- "published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
- "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
- "selfLink": "A String", # A link back to this revision.
- "etag": "A String", # The ETag of the revision.
- "fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "lastModifyingUserName": "A String", # Name of the last user to modify this revision.
- "originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
- "id": "A String", # The ID of the revision.
- "md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
- "modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
- }
-
-
-Returns:
- An object of the form:
-
- { # A revision of a file.
- "mimeType": "A String", # The MIME type of the revision.
- "pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter.
- "kind": "drive#revision", # This is always drive#revision.
- "publishedLink": "A String", # A link to the published revision.
- "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.
- "lastModifyingUser": { # The JSON template for a user. # The last user to modify this revision.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
- },
- "kind": "drive#user", # This is always drive#user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- },
- "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.
- "published": True or False, # Whether this revision is published. This is only populated and can only be modified for Google Docs.
- "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
- "selfLink": "A String", # A link back to this revision.
- "etag": "A String", # The ETag of the revision.
- "fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "lastModifyingUserName": "A String", # Name of the last user to modify this revision.
- "originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
- "id": "A String", # The ID of the revision.
- "md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
- "modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
- }
-
Instance Methods
-
- text()
-
-Returns the text Resource.
-
-
- topic()
-
-Returns the topic Resource.
-
-
- image(id, maxwidth=None, maxheight=None, fallbackid=None, pad=None, mode=None)
-Returns the scaled/cropped image attached to a freebase node.
-
- image_media(id, maxwidth=None, maxheight=None, fallbackid=None, pad=None, mode=None)
-Returns the scaled/cropped image attached to a freebase node.
-
- mqlread(query, lang=None, indent=None, callback=None, uniqueness_failure=None, dateline=None, html_escape=None, cursor=None, cost=None, as_of_time=None)
-Performs MQL Queries.
-
- mqlread_media(query, lang=None, indent=None, callback=None, uniqueness_failure=None, dateline=None, html_escape=None, cursor=None, cost=None, as_of_time=None)
-Performs MQL Queries.
-
- mqlwrite(query, indent=None, callback=None, dateline=None, use_permission_of=None)
-Performs MQL Write Operations.
-
- mqlwrite_media(query, indent=None, callback=None, dateline=None, use_permission_of=None)
-Performs MQL Write Operations.
-Method Details
-
-
image(id, maxwidth=None, maxheight=None, fallbackid=None, pad=None, mode=None)
-
Returns the scaled/cropped image attached to a freebase node.
-
-Args:
- id: string, Freebase entity or content id, mid, or guid. (required) (repeated)
- maxwidth: integer, Maximum width in pixels for resulting image.
- maxheight: integer, Maximum height in pixels for resulting image.
- 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.
- Allowed values
- fill - Fill rectangle completely with image, relax constraint on one dimension if necessary.
- fillcrop - Fill rectangle with image, crop image to maintain rectangle dimensions.
- fillcropmid - Fill rectangle with image, center horizontally, crop left and right.
- fit - Fit image inside rectangle, leave empty space in one dimension if necessary.
-
-
-
image_media(id, maxwidth=None, maxheight=None, fallbackid=None, pad=None, mode=None)
-
Returns the scaled/cropped image attached to a freebase node.
-
-Args:
- id: string, Freebase entity or content id, mid, or guid. (required) (repeated)
- maxwidth: integer, Maximum width in pixels for resulting image.
- maxheight: integer, Maximum height in pixels for resulting image.
- 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.
- Allowed values
- fill - Fill rectangle completely with image, relax constraint on one dimension if necessary.
- fillcrop - Fill rectangle with image, crop image to maintain rectangle dimensions.
- fillcropmid - Fill rectangle with image, center horizontally, crop left and right.
- fit - Fit image inside rectangle, leave empty space in one dimension if necessary.
-
-
-
mqlread(query, lang=None, indent=None, callback=None, uniqueness_failure=None, dateline=None, html_escape=None, cursor=None, cost=None, as_of_time=None)
-
Performs MQL Queries.
-
-Args:
- query: string, An envelope containing a single MQL query. (required)
- lang: string, The language of the results - an id of a /type/lang object.
- indent: integer, How many spaces to indent the json.
- callback: string, JS method name for JSONP callbacks.
- uniqueness_failure: string, How MQL responds to uniqueness failures.
- Allowed values
- hard - Be strict - throw an error.
- 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.
- as_of_time: string, Run the query as it would've been run at the specified point in time.
-
-
-
mqlread_media(query, lang=None, indent=None, callback=None, uniqueness_failure=None, dateline=None, html_escape=None, cursor=None, cost=None, as_of_time=None)
-
Performs MQL Queries.
-
-Args:
- query: string, An envelope containing a single MQL query. (required)
- lang: string, The language of the results - an id of a /type/lang object.
- indent: integer, How many spaces to indent the json.
- callback: string, JS method name for JSONP callbacks.
- uniqueness_failure: string, How MQL responds to uniqueness failures.
- Allowed values
- hard - Be strict - throw an error.
- 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.
- as_of_time: string, Run the query as it would've been run at the specified point in time.
-
-
-
mqlwrite(query, indent=None, callback=None, dateline=None, use_permission_of=None)
-
Performs MQL Write Operations.
-
-Args:
- query: string, An MQL query with write directives. (required)
- indent: integer, How many spaces to indent the json.
- callback: string, JS method name for JSONP callbacks.
- dateline: string, The dateline that you get in a mqlwrite response to ensure consistent results.
- use_permission_of: string, Use the same permission node of the object with the specified id.
-
-
-
mqlwrite_media(query, indent=None, callback=None, dateline=None, use_permission_of=None)
-
Performs MQL Write Operations.
-
-Args:
- query: string, An MQL query with write directives. (required)
- indent: integer, How many spaces to indent the json.
- callback: string, JS method name for JSONP callbacks.
- dateline: string, The dateline that you get in a mqlwrite response to ensure consistent results.
- use_permission_of: string, Use the same permission node of the object with the specified id.
-
-
Instance Methods
-
- get(id, format=None, maxlength=None)
-Returns blob attached to node at specified id as HTML
-Method Details
-
-
get(id, format=None, maxlength=None)
-
Returns blob attached to node at specified id as HTML
-
-Args:
- id: string, The id of the item that you want data about (required) (repeated)
- 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.
- maxlength: integer, The max number of characters to return. Valid only for 'plain' format.
-
-Returns:
- An object of the form:
-
- {
- "result": "A String", # The text requested.
- }
-
Instance Methods
-
- lookup(id, lang=None, filter=None, raw=None, dateline=None, limit=None)
-Get properties and meta-data about a topic.
-Method Details
-
-
lookup(id, lang=None, filter=None, raw=None, dateline=None, limit=None)
-
Get properties and meta-data about a topic.
-
-Args:
- id: string, The id of the item that you want data about. (required) (repeated)
- lang: string, The language you 'd like the content in - a freebase /type/lang language key.
- filter: string, A frebase domain, type or property id, 'suggest', 'commons', or 'all'. Filter the results and returns only appropriate properties. (repeated)
- raw: boolean, Do not apply any constraints, or get any names.
- dateline: string, Determines how up-to-date the data returned is. A unix epoch time, a guid or a 'now'
- limit: integer, The maximum number of property values to return for each property.
-
-Returns:
- An object of the form:
-
- {
- "property": {
- "/freebase/object_profile/linkcount": {
- "values": [
- {
- "count": 42,
- "values": [
- {
- "count": 42,
- "values": [
- {
- "count": 42,
- "id": "A String",
- },
- ],
- "id": "A String",
- },
- ],
- "id": "A String",
- },
- ],
- "type": "custom",
- },
- },
- "id": "A String",
- }
-
Instance Methods
-
- delete(tableId, columnId)
-Deletes the column.
-
- get(tableId, columnId)
-Retrieves a specific column by its id.
-
- insert(tableId, body)
-Adds a new column to the table.
-
- list(tableId, pageToken=None, maxResults=None)
-Retrieves a list of columns.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(tableId, columnId, body)
-Updates the name or type of an existing column. This method supports patch semantics.
-
- update(tableId, columnId, body)
-Updates the name or type of an existing column.
-Method Details
-
-
delete(tableId, columnId)
-
Deletes the column.
-
-Args:
- tableId: string, Table from which the column is being deleted. (required)
- columnId: string, Name or identifier for the column being deleted. (required)
-
-
-
get(tableId, columnId)
-
Retrieves a specific column by its id.
-
-Args:
- tableId: string, Table to which the column belongs. (required)
- columnId: string, Name or identifier for the column that is being requested. (required)
-
-Returns:
- An object of the form:
-
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- }
-
-
insert(tableId, body)
-
Adds a new column to the table.
-
-Args:
- tableId: string, Table for which a new column is being added. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- }
-
-
list(tableId, pageToken=None, maxResults=None)
-
Retrieves a list of columns.
-
-Args:
- tableId: string, Table whose columns are being listed. (required)
- pageToken: string, Continuation token specifying which result page to return. Optional.
- maxResults: integer, Maximum number of columns to return. Optional. Default is 5.
-
-Returns:
- An object of the form:
-
- { # Represents a list of columns in a table.
- "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more tokens left.
- "items": [ # List of all requested columns.
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- },
- ],
- "kind": "fusiontables#columnList", # Type name: a list of all tables.
- "totalItems": 42, # Total number of columns for the table.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(tableId, columnId, body)
-
Updates the name or type of an existing column. This method supports patch semantics.
-
-Args:
- tableId: string, Table for which the column is being updated. (required)
- columnId: string, Name or identifier for the column that is being updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- }
-
-
update(tableId, columnId, body)
-
Updates the name or type of an existing column.
-
-Args:
- tableId: string, Table for which the column is being updated. (required)
- columnId: string, Name or identifier for the column that is being updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- }
-
Instance Methods
-
- column()
-
-Returns the column Resource.
-
-
- query()
-
-Returns the query Resource.
-
-
- style()
-
-Returns the style Resource.
-
-
- table()
-
-Returns the table Resource.
-
-
- template()
-
-Returns the template Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/fusiontables_v1.query.html b/docs/dyn/fusiontables_v1.query.html
deleted file mode 100644
index a4ac39a..0000000
--- a/docs/dyn/fusiontables_v1.query.html
+++ /dev/null
@@ -1,134 +0,0 @@
-
-
-
-
-Instance Methods
-
- sql(sql, hdrs=None, typed=None)
-Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE/CREATE statement.
-
- sqlGet(sql, hdrs=None, typed=None)
-Executes an SQL SELECT/SHOW/DESCRIBE statement.
-Method Details
-
-
sql(sql, hdrs=None, typed=None)
-
Executes an SQL SELECT/INSERT/UPDATE/DELETE/SHOW/DESCRIBE/CREATE statement.
-
-Args:
- sql: string, An SQL SELECT/SHOW/DESCRIBE/INSERT/UPDATE/DELETE/CREATE statement. (required)
- hdrs: boolean, Should column names be included (in the first row)?. Default is true.
- typed: boolean, Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true.
-
-Returns:
- An object of the form:
-
- { # Represents a response to an sql statement.
- "kind": "fusiontables#sqlresponse", # Type name: a template for an individual table.
- "rows": [ # The rows in the table. For each cell we print out whatever cell value (e.g., numeric, string) exists. Thus it is important that each cell contains only one value.
- [
- "",
- ],
- ],
- "columns": [ # Columns in the table.
- "A String",
- ],
- }
-
-
sqlGet(sql, hdrs=None, typed=None)
-
Executes an SQL SELECT/SHOW/DESCRIBE statement.
-
-Args:
- sql: string, An SQL SELECT/SHOW/DESCRIBE statement. (required)
- hdrs: boolean, Should column names be included (in the first row)?. Default is true.
- typed: boolean, Should typed values be returned in the (JSON) response -- numbers for numeric values and parsed geometries for KML values? Default is true.
-
-Returns:
- An object of the form:
-
- { # Represents a response to an sql statement.
- "kind": "fusiontables#sqlresponse", # Type name: a template for an individual table.
- "rows": [ # The rows in the table. For each cell we print out whatever cell value (e.g., numeric, string) exists. Thus it is important that each cell contains only one value.
- [
- "",
- ],
- ],
- "columns": [ # Columns in the table.
- "A String",
- ],
- }
-
Instance Methods
-
- delete(tableId, styleId)
-Deletes a style.
-
- get(tableId, styleId)
-Gets a specific style.
-
- insert(tableId, body)
-Adds a new style for the table.
-
- list(tableId, pageToken=None, maxResults=None)
-Retrieves a list of styles.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(tableId, styleId, body)
-Updates an existing style. This method supports patch semantics.
-
- update(tableId, styleId, body)
-Updates an existing style.
-Method Details
-
-
delete(tableId, styleId)
-
Deletes a style.
-
-Args:
- tableId: string, Table from which the style is being deleted (required)
- styleId: integer, Identifier (within a table) for the style being deleted (required)
-
-
-
get(tableId, styleId)
-
Gets a specific style.
-
-Args:
- tableId: string, Table to which the requested style belongs (required)
- styleId: integer, Identifier (integer) for a specific style in a table (required)
-
-Returns:
- An object of the form:
-
- { # Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId.
- "markerOptions": { # Represents a PointStyle within a StyleSetting # Style definition for points in the table.
- "iconStyler": { # Represents a StyleFunction within a StyleSetting # Column or a bucket value from which the icon name is to be determined.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
- },
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
- "name": "A String", # Optional name for the style setting.
- "polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeWeight": 42, # Width of the polyon border in pixels.
- "strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the polygon border.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
- "strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
- "fillOpacity": 3.14, # Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque).
- },
- "polylineOptions": { # Represents a LineStyle within a StyleSetting # Style definition for lines in the table.
- "strokeWeight": 42, # Width of the line in pixels.
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the line.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeColor": "A String", # Color of the line in #RRGGBB format.
- "strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the line color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- },
- "tableId": "A String", # Identifier for the table.
- "styleId": 42, # Identifier for the style setting (unique only within tables).
- }
-
-
insert(tableId, body)
-
Adds a new style for the table.
-
-Args:
- tableId: string, Table for which a new style is being added (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId.
- "markerOptions": { # Represents a PointStyle within a StyleSetting # Style definition for points in the table.
- "iconStyler": { # Represents a StyleFunction within a StyleSetting # Column or a bucket value from which the icon name is to be determined.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
- },
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
- "name": "A String", # Optional name for the style setting.
- "polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeWeight": 42, # Width of the polyon border in pixels.
- "strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the polygon border.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
- "strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
- "fillOpacity": 3.14, # Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque).
- },
- "polylineOptions": { # Represents a LineStyle within a StyleSetting # Style definition for lines in the table.
- "strokeWeight": 42, # Width of the line in pixels.
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the line.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeColor": "A String", # Color of the line in #RRGGBB format.
- "strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the line color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- },
- "tableId": "A String", # Identifier for the table.
- "styleId": 42, # Identifier for the style setting (unique only within tables).
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId.
- "markerOptions": { # Represents a PointStyle within a StyleSetting # Style definition for points in the table.
- "iconStyler": { # Represents a StyleFunction within a StyleSetting # Column or a bucket value from which the icon name is to be determined.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
- },
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
- "name": "A String", # Optional name for the style setting.
- "polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeWeight": 42, # Width of the polyon border in pixels.
- "strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the polygon border.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
- "strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
- "fillOpacity": 3.14, # Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque).
- },
- "polylineOptions": { # Represents a LineStyle within a StyleSetting # Style definition for lines in the table.
- "strokeWeight": 42, # Width of the line in pixels.
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the line.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeColor": "A String", # Color of the line in #RRGGBB format.
- "strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the line color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- },
- "tableId": "A String", # Identifier for the table.
- "styleId": 42, # Identifier for the style setting (unique only within tables).
- }
-
-
list(tableId, pageToken=None, maxResults=None)
-
Retrieves a list of styles.
-
-Args:
- tableId: string, Table whose styles are being listed (required)
- pageToken: string, Continuation token specifying which result page to return. Optional.
- maxResults: integer, Maximum number of styles to return. Optional. Default is 5.
-
-Returns:
- An object of the form:
-
- { # Represents a list of styles for a given table.
- "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more styles left.
- "items": [ # All requested style settings.
- { # Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId.
- "markerOptions": { # Represents a PointStyle within a StyleSetting # Style definition for points in the table.
- "iconStyler": { # Represents a StyleFunction within a StyleSetting # Column or a bucket value from which the icon name is to be determined.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
- },
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
- "name": "A String", # Optional name for the style setting.
- "polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeWeight": 42, # Width of the polyon border in pixels.
- "strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the polygon border.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
- "strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
- "fillOpacity": 3.14, # Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque).
- },
- "polylineOptions": { # Represents a LineStyle within a StyleSetting # Style definition for lines in the table.
- "strokeWeight": 42, # Width of the line in pixels.
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the line.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeColor": "A String", # Color of the line in #RRGGBB format.
- "strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the line color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- },
- "tableId": "A String", # Identifier for the table.
- "styleId": 42, # Identifier for the style setting (unique only within tables).
- },
- ],
- "kind": "fusiontables#styleSettingList", # Type name: in this case, a list of style settings.
- "totalItems": 42, # Total number of styles for the table.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(tableId, styleId, body)
-
Updates an existing style. This method supports patch semantics.
-
-Args:
- tableId: string, Table whose style is being updated. (required)
- styleId: integer, Identifier (within a table) for the style being updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId.
- "markerOptions": { # Represents a PointStyle within a StyleSetting # Style definition for points in the table.
- "iconStyler": { # Represents a StyleFunction within a StyleSetting # Column or a bucket value from which the icon name is to be determined.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
- },
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
- "name": "A String", # Optional name for the style setting.
- "polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeWeight": 42, # Width of the polyon border in pixels.
- "strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the polygon border.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
- "strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
- "fillOpacity": 3.14, # Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque).
- },
- "polylineOptions": { # Represents a LineStyle within a StyleSetting # Style definition for lines in the table.
- "strokeWeight": 42, # Width of the line in pixels.
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the line.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeColor": "A String", # Color of the line in #RRGGBB format.
- "strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the line color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- },
- "tableId": "A String", # Identifier for the table.
- "styleId": 42, # Identifier for the style setting (unique only within tables).
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId.
- "markerOptions": { # Represents a PointStyle within a StyleSetting # Style definition for points in the table.
- "iconStyler": { # Represents a StyleFunction within a StyleSetting # Column or a bucket value from which the icon name is to be determined.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
- },
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
- "name": "A String", # Optional name for the style setting.
- "polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeWeight": 42, # Width of the polyon border in pixels.
- "strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the polygon border.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
- "strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
- "fillOpacity": 3.14, # Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque).
- },
- "polylineOptions": { # Represents a LineStyle within a StyleSetting # Style definition for lines in the table.
- "strokeWeight": 42, # Width of the line in pixels.
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the line.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeColor": "A String", # Color of the line in #RRGGBB format.
- "strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the line color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- },
- "tableId": "A String", # Identifier for the table.
- "styleId": 42, # Identifier for the style setting (unique only within tables).
- }
-
-
update(tableId, styleId, body)
-
Updates an existing style.
-
-Args:
- tableId: string, Table whose style is being updated. (required)
- styleId: integer, Identifier (within a table) for the style being updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId.
- "markerOptions": { # Represents a PointStyle within a StyleSetting # Style definition for points in the table.
- "iconStyler": { # Represents a StyleFunction within a StyleSetting # Column or a bucket value from which the icon name is to be determined.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
- },
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
- "name": "A String", # Optional name for the style setting.
- "polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeWeight": 42, # Width of the polyon border in pixels.
- "strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the polygon border.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
- "strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
- "fillOpacity": 3.14, # Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque).
- },
- "polylineOptions": { # Represents a LineStyle within a StyleSetting # Style definition for lines in the table.
- "strokeWeight": 42, # Width of the line in pixels.
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the line.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeColor": "A String", # Color of the line in #RRGGBB format.
- "strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the line color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- },
- "tableId": "A String", # Identifier for the table.
- "styleId": 42, # Identifier for the style setting (unique only within tables).
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a complete StyleSettings object. The primary key is a combination of the tableId and a styleId.
- "markerOptions": { # Represents a PointStyle within a StyleSetting # Style definition for points in the table.
- "iconStyler": { # Represents a StyleFunction within a StyleSetting # Column or a bucket value from which the icon name is to be determined.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "iconName": "A String", # Name of the icon. Use values defined in http://www.google.com/fusiontables/DataSource?dsrcid=308519
- },
- "kind": "fusiontables#styleSetting", # Type name: an individual style setting. A StyleSetting contains the style defintions for points, lines, and polygons in a table. Since a table can have any one or all of them, a style definition can have point, line and polygon style definitions.
- "name": "A String", # Optional name for the style setting.
- "polygonOptions": { # Represents a PolygonStyle within a StyleSetting # Style definition for polygons in the table.
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the border color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeWeight": 42, # Width of the polyon border in pixels.
- "strokeOpacity": 3.14, # Opacity of the polygon border: 0.0 (transparent) to 1.0 (opaque).
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the polygon border.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient, or bucket styler that is used to determine the interior color and opacity of the polygon.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "fillColor": "A String", # Color of the interior of the polygon in #RRGGBB format.
- "strokeColor": "A String", # Color of the polygon border in #RRGGBB format.
- "fillOpacity": 3.14, # Opacity of the interior of the polygon: 0.0 (transparent) to 1.0 (opaque).
- },
- "polylineOptions": { # Represents a LineStyle within a StyleSetting # Style definition for lines in the table.
- "strokeWeight": 42, # Width of the line in pixels.
- "strokeWeightStyler": { # Represents a StyleFunction within a StyleSetting # Column-value or bucket styler that is used to determine the width of the line.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- "strokeColor": "A String", # Color of the line in #RRGGBB format.
- "strokeOpacity": 3.14, # Opacity of the line : 0.0 (transparent) to 1.0 (opaque).
- "strokeColorStyler": { # Represents a StyleFunction within a StyleSetting # Column-value, gradient or buckets styler that is used to determine the line color and opacity.
- "gradient": { # Gradient function that interpolates a range of colors based on column value.
- "max": 3.14, # Higher-end of the interpolation range: rows with this value will be assigned to colors[n-1].
- "colors": [ # Array with two or more colors.
- {
- "color": "A String", # Color in #RRGGBB format.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- },
- ],
- "min": 3.14, # Lower-end of the interpolation range: rows with this value will be assigned to colors[0].
- },
- "columnName": "A String", # Name of the column whose value is used in the style.
- "buckets": [ # Bucket function that assigns a style based on the range a column value falls into.
- { # Specifies the minimum and maximum values, the color, opacity, icon and weight of a bucket within a StyleSetting.
- "opacity": 3.14, # Opacity of the color: 0.0 (transparent) to 1.0 (opaque).
- "weight": 42, # Width of a line (in pixels).
- "min": 3.14, # Minimum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "color": "A String", # Color of line or the interior of a polygon in #RRGGBB format.
- "max": 3.14, # Maximum value in the selected column for a row to be styled according to the bucket color, opacity, icon, or weight.
- "icon": "A String", # Icon name used for a point.
- },
- ],
- "kind": "A String", # Stylers can be one of three kinds: "fusiontables#fromColumn" if the column value is to be used as is, i.e., the column values can have colors in #RRGGBBAA format or integer line widths or icon names; "fusiontables#gradient" if the styling of the row is to be based on applying the gradient function on the column value; or "fusiontables#buckets" if the styling is to based on the bucket into which the the column value falls.
- },
- },
- "tableId": "A String", # Identifier for the table.
- "styleId": 42, # Identifier for the style setting (unique only within tables).
- }
-
Instance Methods
-
- copy(tableId, copyPresentation=None)
-Copies a table.
-
- delete(tableId)
-Deletes a table.
-
- get(tableId)
-Retrieves a specific table by its id.
-
- importRows(tableId, media_body=None, startLine=None, isStrict=None, encoding=None, delimiter=None, endLine=None)
-Import more rows into a table.
-
- importTable(name, media_body=None, encoding=None, delimiter=None)
-Import a new table.
-
- insert(body)
-Creates a new table.
-
- list(pageToken=None, maxResults=None)
-Retrieves a list of tables a user owns.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(tableId, body, replaceViewDefinition=None)
-Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics.
-
- update(tableId, body, replaceViewDefinition=None)
-Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.
-Method Details
-
-
copy(tableId, copyPresentation=None)
-
Copies a table.
-
-Args:
- tableId: string, ID of the table that is being copied. (required)
- copyPresentation: boolean, Whether to also copy tabs, styles, and templates. Default is false.
-
-Returns:
- An object of the form:
-
- { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
- "attribution": "A String", # Optional attribution assigned to the table.
- "description": "A String", # Optional description assigned to the table.
- "isExportable": True or False, # Variable for whether table is exportable.
- "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
- "A String",
- ],
- "attributionLink": "A String", # Optional link for attribution.
- "sql": "A String", # Optional sql that encodes the table definition for derived tables.
- "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
- "columns": [ # Columns in the table.
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- },
- ],
- "name": "A String", # Name assigned to a table.
- }
-
-
delete(tableId)
-
Deletes a table.
-
-Args:
- tableId: string, ID of the table that is being deleted. (required)
-
-
-
get(tableId)
-
Retrieves a specific table by its id.
-
-Args:
- tableId: string, Identifier(ID) for the table being requested. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
- "attribution": "A String", # Optional attribution assigned to the table.
- "description": "A String", # Optional description assigned to the table.
- "isExportable": True or False, # Variable for whether table is exportable.
- "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
- "A String",
- ],
- "attributionLink": "A String", # Optional link for attribution.
- "sql": "A String", # Optional sql that encodes the table definition for derived tables.
- "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
- "columns": [ # Columns in the table.
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- },
- ],
- "name": "A String", # Name assigned to a table.
- }
-
-
importRows(tableId, media_body=None, startLine=None, isStrict=None, encoding=None, delimiter=None, endLine=None)
-
Import more rows into a table.
-
-Args:
- tableId: string, The table into which new rows are being imported. (required)
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- startLine: integer, The index of the first line from which to start importing, inclusive. Default is 0.
- isStrict: boolean, Whether the CSV must have the same number of values for each row. If false, rows with fewer values will be padded with empty values. Default is true.
- encoding: string, The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding.
- delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ','.
- endLine: integer, The index of the last line from which to start importing, exclusive. Thus, the number of imported lines is endLine - startLine. If this parameter is not provided, the file will be imported until the last line of the file. If endLine is negative, then the imported content will exclude the last endLine lines. That is, if endline is negative, no line will be imported whose index is greater than N + endLine where N is the number of lines in the file, and the number of imported lines will be N + endLine - startLine.
-
-Returns:
- An object of the form:
-
- { # Represents an import request.
- "numRowsReceived": "A String", # The number of rows received from the import request.
- "kind": "fusiontables#import", # Type name: a template for an import request.
- }
-
-
importTable(name, media_body=None, encoding=None, delimiter=None)
-
Import a new table.
-
-Args:
- name: string, The name to be assigned to the new table. (required)
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- encoding: string, The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding.
- delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ','.
-
-Returns:
- An object of the form:
-
- { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
- "attribution": "A String", # Optional attribution assigned to the table.
- "description": "A String", # Optional description assigned to the table.
- "isExportable": True or False, # Variable for whether table is exportable.
- "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
- "A String",
- ],
- "attributionLink": "A String", # Optional link for attribution.
- "sql": "A String", # Optional sql that encodes the table definition for derived tables.
- "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
- "columns": [ # Columns in the table.
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- },
- ],
- "name": "A String", # Name assigned to a table.
- }
-
-
insert(body)
-
Creates a new table.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
- "attribution": "A String", # Optional attribution assigned to the table.
- "description": "A String", # Optional description assigned to the table.
- "isExportable": True or False, # Variable for whether table is exportable.
- "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
- "A String",
- ],
- "attributionLink": "A String", # Optional link for attribution.
- "sql": "A String", # Optional sql that encodes the table definition for derived tables.
- "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
- "columns": [ # Columns in the table.
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- },
- ],
- "name": "A String", # Name assigned to a table.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
- "attribution": "A String", # Optional attribution assigned to the table.
- "description": "A String", # Optional description assigned to the table.
- "isExportable": True or False, # Variable for whether table is exportable.
- "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
- "A String",
- ],
- "attributionLink": "A String", # Optional link for attribution.
- "sql": "A String", # Optional sql that encodes the table definition for derived tables.
- "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
- "columns": [ # Columns in the table.
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- },
- ],
- "name": "A String", # Name assigned to a table.
- }
-
-
list(pageToken=None, maxResults=None)
-
Retrieves a list of tables a user owns.
-
-Args:
- pageToken: string, Continuation token specifying which result page to return. Optional.
- maxResults: integer, Maximum number of styles to return. Optional. Default is 5.
-
-Returns:
- An object of the form:
-
- { # Represents a list of tables.
- "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more tokens left.
- "items": [ # List of all requested tables.
- { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
- "attribution": "A String", # Optional attribution assigned to the table.
- "description": "A String", # Optional description assigned to the table.
- "isExportable": True or False, # Variable for whether table is exportable.
- "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
- "A String",
- ],
- "attributionLink": "A String", # Optional link for attribution.
- "sql": "A String", # Optional sql that encodes the table definition for derived tables.
- "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
- "columns": [ # Columns in the table.
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- },
- ],
- "name": "A String", # Name assigned to a table.
- },
- ],
- "kind": "fusiontables#tableList", # Type name: a list of all tables.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(tableId, body, replaceViewDefinition=None)
-
Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics.
-
-Args:
- tableId: string, ID of the table that is being updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
- "attribution": "A String", # Optional attribution assigned to the table.
- "description": "A String", # Optional description assigned to the table.
- "isExportable": True or False, # Variable for whether table is exportable.
- "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
- "A String",
- ],
- "attributionLink": "A String", # Optional link for attribution.
- "sql": "A String", # Optional sql that encodes the table definition for derived tables.
- "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
- "columns": [ # Columns in the table.
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- },
- ],
- "name": "A String", # Name assigned to a table.
- }
-
- replaceViewDefinition: boolean, Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition.
-
-Returns:
- An object of the form:
-
- { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
- "attribution": "A String", # Optional attribution assigned to the table.
- "description": "A String", # Optional description assigned to the table.
- "isExportable": True or False, # Variable for whether table is exportable.
- "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
- "A String",
- ],
- "attributionLink": "A String", # Optional link for attribution.
- "sql": "A String", # Optional sql that encodes the table definition for derived tables.
- "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
- "columns": [ # Columns in the table.
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- },
- ],
- "name": "A String", # Name assigned to a table.
- }
-
-
update(tableId, body, replaceViewDefinition=None)
-
Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.
-
-Args:
- tableId: string, ID of the table that is being updated. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
- "attribution": "A String", # Optional attribution assigned to the table.
- "description": "A String", # Optional description assigned to the table.
- "isExportable": True or False, # Variable for whether table is exportable.
- "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
- "A String",
- ],
- "attributionLink": "A String", # Optional link for attribution.
- "sql": "A String", # Optional sql that encodes the table definition for derived tables.
- "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
- "columns": [ # Columns in the table.
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- },
- ],
- "name": "A String", # Name assigned to a table.
- }
-
- replaceViewDefinition: boolean, Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition.
-
-Returns:
- An object of the form:
-
- { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
- "kind": "fusiontables#table", # Type name: a template for an individual table.
- "attribution": "A String", # Optional attribution assigned to the table.
- "description": "A String", # Optional description assigned to the table.
- "isExportable": True or False, # Variable for whether table is exportable.
- "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
- "A String",
- ],
- "attributionLink": "A String", # Optional link for attribution.
- "sql": "A String", # Optional sql that encodes the table definition for derived tables.
- "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
- "columns": [ # Columns in the table.
- { # Specifies the id, name and type of a column in a table.
- "kind": "fusiontables#column", # Type name: a template for an individual column.
- "type": "A String", # Required type of the column.
- "columnId": 42, # Identifier for the column.
- "name": "A String", # Required name of the column.
- "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
- "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
- "columnId": 42, # The id of the column in the base table from which this column is derived.
- },
- },
- ],
- "name": "A String", # Name assigned to a table.
- }
-
Instance Methods
-
- delete(tableId, templateId)
-Deletes a template
-
- get(tableId, templateId)
-Retrieves a specific template by its id
-
- insert(tableId, body)
-Creates a new template for the table.
-
- list(tableId, pageToken=None, maxResults=None)
-Retrieves a list of templates.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(tableId, templateId, body)
-Updates an existing template. This method supports patch semantics.
-
- update(tableId, templateId, body)
-Updates an existing template
-Method Details
-
-
delete(tableId, templateId)
-
Deletes a template
-
-Args:
- tableId: string, Table from which the template is being deleted (required)
- templateId: integer, Identifier for the template which is being deleted (required)
-
-
-
get(tableId, templateId)
-
Retrieves a specific template by its id
-
-Args:
- tableId: string, Table to which the template belongs (required)
- templateId: integer, Identifier for the template that is being requested (required)
-
-Returns:
- An object of the form:
-
- { # Represents the contents of InfoWindow templates.
- "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
- "name": "A String", # Optional name assigned to a template.
- "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
- "A String",
- ],
- "tableId": "A String", # Identifier for the table for which the template is defined.
- "templateId": 42, # Identifier for the template, unique within the context of a particular table.
- }
-
-
insert(tableId, body)
-
Creates a new template for the table.
-
-Args:
- tableId: string, Table for which a new template is being created (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents the contents of InfoWindow templates.
- "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
- "name": "A String", # Optional name assigned to a template.
- "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
- "A String",
- ],
- "tableId": "A String", # Identifier for the table for which the template is defined.
- "templateId": 42, # Identifier for the template, unique within the context of a particular table.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents the contents of InfoWindow templates.
- "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
- "name": "A String", # Optional name assigned to a template.
- "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
- "A String",
- ],
- "tableId": "A String", # Identifier for the table for which the template is defined.
- "templateId": 42, # Identifier for the template, unique within the context of a particular table.
- }
-
-
list(tableId, pageToken=None, maxResults=None)
-
Retrieves a list of templates.
-
-Args:
- tableId: string, Identifier for the table whose templates are being requested (required)
- pageToken: string, Continuation token specifying which results page to return. Optional.
- maxResults: integer, Maximum number of templates to return. Optional. Default is 5.
-
-Returns:
- An object of the form:
-
- { # Represents a list of templates for a given table.
- "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more tokens left.
- "items": [ # List of all requested templates.
- { # Represents the contents of InfoWindow templates.
- "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
- "name": "A String", # Optional name assigned to a template.
- "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
- "A String",
- ],
- "tableId": "A String", # Identifier for the table for which the template is defined.
- "templateId": 42, # Identifier for the template, unique within the context of a particular table.
- },
- ],
- "kind": "fusiontables#templateList", # Type name: a list of all templates.
- "totalItems": 42, # Total number of templates for the table.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(tableId, templateId, body)
-
Updates an existing template. This method supports patch semantics.
-
-Args:
- tableId: string, Table to which the updated template belongs (required)
- templateId: integer, Identifier for the template that is being updated (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents the contents of InfoWindow templates.
- "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
- "name": "A String", # Optional name assigned to a template.
- "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
- "A String",
- ],
- "tableId": "A String", # Identifier for the table for which the template is defined.
- "templateId": 42, # Identifier for the template, unique within the context of a particular table.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents the contents of InfoWindow templates.
- "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
- "name": "A String", # Optional name assigned to a template.
- "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
- "A String",
- ],
- "tableId": "A String", # Identifier for the table for which the template is defined.
- "templateId": 42, # Identifier for the template, unique within the context of a particular table.
- }
-
-
update(tableId, templateId, body)
-
Updates an existing template
-
-Args:
- tableId: string, Table to which the updated template belongs (required)
- templateId: integer, Identifier for the template that is being updated (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents the contents of InfoWindow templates.
- "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
- "name": "A String", # Optional name assigned to a template.
- "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
- "A String",
- ],
- "tableId": "A String", # Identifier for the table for which the template is defined.
- "templateId": 42, # Identifier for the template, unique within the context of a particular table.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents the contents of InfoWindow templates.
- "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
- "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
- "name": "A String", # Optional name assigned to a template.
- "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
- "A String",
- ],
- "tableId": "A String", # Identifier for the table for which the template is defined.
- "templateId": 42, # Identifier for the template, unique within the context of a particular table.
- }
-
Instance Methods
-
- reset(achievementId)
-Resets the achievement with the given ID. This method is only accessible to whitelisted tester accounts for your application.
-
- resetAll()
-Resets all achievements for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application.
-Method Details
-
-
reset(achievementId)
-
Resets the achievement with the given ID. This method is only accessible to whitelisted tester accounts for your application.
-
-Args:
- achievementId: string, The ID of the achievement used by this method. (required)
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for an achievement reset response.
- "definitionId": "A String", # The ID of an achievement for which player state has been updated.
- "kind": "gamesManagement#achievementResetResponse", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetResponse.
- "updateOccurred": True or False, # Flag to indicate if the requested update actually occurred.
- "currentState": "A String", # The current state of the achievement. This is the same as the initial state of the achievement.
- # Possible values are:
- # - "HIDDEN"- Achievement is hidden.
- # - "REVEALED" - Achievement is revealed.
- # - "UNLOCKED" - Achievement is unlocked.
- }
-
-
resetAll()
-
Resets all achievements for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for achievement reset all response.
- "kind": "gamesManagement#achievementResetAllResponse", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetAllResponse.
- "results": [ # The achievement reset results.
- { # This is a JSON template for an achievement reset response.
- "definitionId": "A String", # The ID of an achievement for which player state has been updated.
- "kind": "gamesManagement#achievementResetResponse", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetResponse.
- "updateOccurred": True or False, # Flag to indicate if the requested update actually occurred.
- "currentState": "A String", # The current state of the achievement. This is the same as the initial state of the achievement.
- # Possible values are:
- # - "HIDDEN"- Achievement is hidden.
- # - "REVEALED" - Achievement is revealed.
- # - "UNLOCKED" - Achievement is unlocked.
- },
- ],
- }
-
Instance Methods
-
- listHidden(applicationId, pageToken=None, maxResults=None)
-Get the list of players hidden from the given application. This method is only available to user accounts for your developer console.
-
- listHidden_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
listHidden(applicationId, pageToken=None, maxResults=None)
-
Get the list of players hidden from the given application. This method is only available to user accounts for your developer console.
-
-Args:
- applicationId: string, The application being requested. (required)
- pageToken: string, The token returned by the previous request.
- maxResults: integer, The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a list of hidden players.
- "nextPageToken": "A String", # The pagination token for the next page of results.
- "items": [ # The players.
- { # This is a JSON template for the HiddenPlayer resource.
- "player": { # This is a JSON template for a Player resource. # The player information.
- "playerId": "A String", # The ID of the player.
- "kind": "gamesManagement#player", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- },
- "kind": "gamesManagement#hiddenPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayer.
- "hiddenTimeMillis": "A String", # The time this player was hidden.
- },
- ],
- "kind": "gamesManagement#hiddenPlayerList", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayerList.
- }
-
-
listHidden_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- achievements()
-
-Returns the achievements Resource.
-
-
- applications()
-
-Returns the applications Resource.
-
-
- players()
-
-Returns the players Resource.
-
-
- rooms()
-
-Returns the rooms Resource.
-
-
- scores()
-
-Returns the scores Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/gamesManagement_v1management.players.html b/docs/dyn/gamesManagement_v1management.players.html
deleted file mode 100644
index 01976b6..0000000
--- a/docs/dyn/gamesManagement_v1management.players.html
+++ /dev/null
@@ -1,104 +0,0 @@
-
-
-
-
-Instance Methods
-
- hide(applicationId, playerId)
-Hide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console.
-
- unhide(applicationId, playerId)
-Unhide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console.
-Method Details
-
-
hide(applicationId, playerId)
-
Hide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console.
-
-Args:
- applicationId: string, The application being requested. (required)
- playerId: string, A player ID. A value of me may be used in place of the authenticated player's ID. (required)
-
-
-
unhide(applicationId, playerId)
-
Unhide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console.
-
-Args:
- applicationId: string, The application being requested. (required)
- playerId: string, A player ID. A value of me may be used in place of the authenticated player's ID. (required)
-
-
Instance Methods
-
- reset()
-Reset all rooms for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application.
-Method Details
-
-
reset()
-
Reset all rooms for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application.
-
-Args:
-
-
Instance Methods
-
- reset(leaderboardId)
-Reset scores for the specified leaderboard, resetting the leaderboard to empty. This method is only accessible to whitelisted tester accounts for your application.
-Method Details
-
-
reset(leaderboardId)
-
Reset scores for the specified leaderboard, resetting the leaderboard to empty. This method is only accessible to whitelisted tester accounts for your application.
-
-Args:
- leaderboardId: string, The ID of the leaderboard. (required)
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a list of reset leaderboard entry resources.
- "kind": "gamesManagement#playerScoreResetResponse", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#playerScoreResetResponse.
- "resetScoreTimeSpans": [ # The time spans of the updated score.
- # Possible values are:
- # - "ALL_TIME" - The score is an all-time score.
- # - "WEEKLY" - The score is a weekly score.
- # - "DAILY" - The score is a daily score.
- "A String",
- ],
- }
-
Instance Methods
-
- list(pageToken=None, language=None, maxResults=None)
-Lists all the achievement definitions for your application.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(pageToken=None, language=None, maxResults=None)
-
Lists all the achievement definitions for your application.
-
-Args:
- pageToken: string, The token returned by the previous request.
- language: string, The preferred language to use for strings returned by this method.
- maxResults: integer, The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified maxResults.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a list of achievement definition objects.
- "nextPageToken": "A String", # Token corresponding to the next page of results.
- "items": [ # The achievement definitions.
- { # This is a JSON template for an achievement definition object.
- "totalSteps": 42, # The total steps for an incremental achievement.
- "achievementType": "A String", # The type of the achievement.
- # Possible values are:
- # - "STANDARD" - Achievement is either locked or unlocked.
- # - "INCREMENTAL" - Achievement is incremental.
- "description": "A String", # The description of the achievement.
- "revealedIconUrl": "A String", # The image URL for the revealed achievement icon.
- "formattedTotalSteps": "A String", # The total steps for an incremental achievement as a string.
- "kind": "games#achievementDefinition", # Uniquely identifies the type of this resource. Value is always the fixed string games#achievementDefinition.
- "initialState": "A String", # The initial state of the achievement.
- # Possible values are:
- # - "HIDDEN" - Achievement is hidden.
- # - "REVEALED" - Achievement is revealed.
- # - "UNLOCKED" - Achievement is unlocked.
- "isRevealedIconUrlDefault": True or False, # Indicates whether the revealed icon image being returned is a default image, or is provided by the game.
- "unlockedIconUrl": "A String", # The image URL for the unlocked achievement icon.
- "id": "A String", # The ID of the achievement.
- "isUnlockedIconUrlDefault": True or False, # Indicates whether the unlocked icon image being returned is a default image, or is game-provided.
- "name": "A String", # The name of the achievement.
- },
- ],
- "kind": "games#achievementDefinitionsListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#achievementDefinitionsListResponse.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- increment(achievementId, stepsToIncrement, requestId=None)
-Increments the steps of the achievement with the given ID for the currently authenticated player.
-
- list(playerId, language=None, pageToken=None, state=None, maxResults=None)
-Lists the progress for all your application's achievements for the currently authenticated player.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- reveal(achievementId)
-Sets the state of the achievement with the given ID to REVEALED for the currently authenticated player.
-
- unlock(achievementId)
-Unlocks this achievement for the currently authenticated player.
-Method Details
-
-
increment(achievementId, stepsToIncrement, requestId=None)
-
Increments the steps of the achievement with the given ID for the currently authenticated player.
-
-Args:
- achievementId: string, The ID of the achievement used by this method. (required)
- stepsToIncrement: integer, The number of steps to increment. (required)
- requestId: string, A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the increment is performed correctly across retries.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for an achievement increment response
- "currentSteps": 42, # The current steps recorded for this incremental achievement.
- "newlyUnlocked": True or False, # Whether the the current steps for the achievement has reached the number of steps required to unlock.
- "kind": "games#achievementIncrementResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#achievementIncrementResponse.
- }
-
-
list(playerId, language=None, pageToken=None, state=None, maxResults=None)
-
Lists the progress for all your application's achievements for the currently authenticated player.
-
-Args:
- playerId: string, A player ID. A value of me may be used in place of the authenticated player's ID. (required)
- language: string, The preferred language to use for strings returned by this method.
- pageToken: string, The token returned by the previous request.
- state: string, Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned.
- Allowed values
- ALL - List all achievements. This is the default.
- HIDDEN - List only hidden achievements.
- REVEALED - List only revealed achievements.
- UNLOCKED - List only unlocked achievements.
- maxResults: integer, The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified maxResults.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a list of achievement objects.
- "nextPageToken": "A String", # Token corresponding to the next page of results.
- "items": [ # The achievements.
- { # This is a JSON template for an achievement object.
- "achievementState": "A String", # The state of the achievement.
- # Possible values are:
- # - "HIDDEN" - Achievement is hidden.
- # - "REVEALED" - Achievement is revealed.
- # - "UNLOCKED" - Achievement is unlocked.
- "kind": "games#playerAchievement", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerAchievement.
- "lastUpdatedTimestamp": "A String", # The timestamp of the last modification to this achievement's state.
- "currentSteps": 42, # The current steps for an incremental achievement.
- "formattedCurrentStepsString": "A String", # The current steps for an incremental achievement as a string.
- "id": "A String", # The ID of the achievement.
- },
- ],
- "kind": "games#playerAchievementListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerAchievementListResponse.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
reveal(achievementId)
-
Sets the state of the achievement with the given ID to REVEALED for the currently authenticated player.
-
-Args:
- achievementId: string, The ID of the achievement used by this method. (required)
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for an achievement reveal response
- "kind": "games#achievementRevealResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#achievementRevealResponse.
- "currentState": "A String", # The current state of the achievement for which a reveal was attempted. This might be UNLOCKED if the achievement was already unlocked.
- # Possible values are:
- # - "REVEALED" - Achievement is revealed.
- # - "UNLOCKED" - Achievement is unlocked.
- }
-
-
unlock(achievementId)
-
Unlocks this achievement for the currently authenticated player.
-
-Args:
- achievementId: string, The ID of the achievement used by this method. (required)
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for an achievement unlock response
- "newlyUnlocked": True or False, # Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player).
- "kind": "games#achievementUnlockResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUnlockResponse.
- }
-
Instance Methods
-
- get(applicationId, language=None, platformType=None)
-Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified platformType, the returned response will not include any instance data.
-
- played()
-Indicate that the the currently authenticated user is playing your application.
-Method Details
-
-
get(applicationId, language=None, platformType=None)
-
Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified platformType, the returned response will not include any instance data.
-
-Args:
- applicationId: string, The application being requested. (required)
- language: string, The preferred language to use for strings returned by this method.
- platformType: string, Restrict application details returned to the specific platform.
- Allowed values
- ANDROID - Retrieve applications that can be played on Android.
- IOS - Retrieve applications that can be played on iOS.
- WEB_APP - Retrieve applications that can be played on desktop web.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for the Application resource.
- "category": { # This is a JSON template for an application category object. # The category of the application.
- "kind": "games#applicationCategory", # Uniquely identifies the type of this resource. Value is always the fixed string games#applicationCategory.
- "primary": "A String", # The primary category.
- "secondary": "A String", # The secondary category.
- },
- "kind": "games#application", # Uniquely identifies the type of this resource. Value is always the fixed string games#application.
- "description": "A String", # The description of the application.
- "author": "A String", # The author of the application.
- "lastUpdatedTimestamp": "A String", # The last updated timestamp of the application.
- "name": "A String", # The name of the application.
- "instances": [ # The instances of the application.
- { # This is a JSON template for the Instance resource.
- "kind": "games#instance", # Uniquely identifies the type of this resource. Value is always the fixed string games#instance.
- "acquisitionUri": "A String", # URI which shows where a user can acquire this instance.
- "name": "A String", # Localized display name.
- "turnBasedPlay": True or False, # Flag to show if this game instance supports turn based play.
- "webInstance": { # This is a JSON template for the Web details resource. # Platform dependent details for Web.
- "kind": "games#instanceWebDetails", # Uniquely identifies the type of this resource. Value is always the fixed string games#instanceWebDetails.
- "launchUrl": "A String", # Launch URL for the game.
- "preferred": True or False, # Indicates that this instance is the default for new installations.
- },
- "androidInstance": { # This is a JSON template for the Android instance details resource. # Platform dependent details for Android.
- "kind": "games#instanceAndroidDetails", # Uniquely identifies the type of this resource. Value is always the fixed string games#instanceAndroidDetails.
- "enablePiracyCheck": True or False, # Flag indicating whether the anti-piracy check is enabled.
- "packageName": "A String", # Android package name which maps to Google Play URL.
- "preferred": True or False, # Indicates that this instance is the default for new installations.
- },
- "iosInstance": { # This is a JSON template for the iOS details resource. # Platform dependent details for iOS.
- "kind": "games#instanceIosDetails", # Uniquely identifies the type of this resource. Value is always the fixed string games#instanceIosDetails.
- "supportIphone": True or False, # Flag to indicate if this instance supports iPhone.
- "preferredForIpad": True or False, # Indicates that this instance is the default for new installations on iPad devices.
- "itunesAppId": "A String", # iTunes App ID.
- "bundleIdentifier": "A String", # Bundle identifier.
- "supportIpad": True or False, # Flag to indicate if this instance supports iPad.
- "preferredForIphone": True or False, # Indicates that this instance is the default for new installations on iPhone devices.
- },
- "platformType": "A String", # The platform type.
- # Possible values are:
- # - "ANDROID" - Instance is for Android.
- # - "IOS" - Instance is for iOS
- # - "WEB_APP" - Instance is for Web App.
- "realtimePlay": True or False, # Flag to show if this game instance supports realtime play.
- },
- ],
- "achievement_count": 42, # The number of achievements visible to the currently authenticated player.
- "leaderboard_count": 42, # The number of leaderboards visible to the currently authenticated player.
- "id": "A String", # The ID of the application.
- "assets": [ # The assets of the application.
- { # This is a JSON template for an image asset object.
- "url": "A String", # The URL of the asset.
- "width": 42, # The width of the asset.
- "kind": "games#imageAsset", # Uniquely identifies the type of this resource. Value is always the fixed string games#imageAsset.
- "name": "A String", # The name of the asset.
- "height": 42, # The height of the asset.
- },
- ],
- }
-
-
played()
-
Indicate that the the currently authenticated user is playing your application.
-
-Args:
-
-
Instance Methods
-
- achievementDefinitions()
-
-Returns the achievementDefinitions Resource.
-
-
- achievements()
-
-Returns the achievements Resource.
-
-
- applications()
-
-Returns the applications Resource.
-
-
- leaderboards()
-
-Returns the leaderboards Resource.
-
-
- players()
-
-Returns the players Resource.
-
-
- revisions()
-
-Returns the revisions Resource.
-
-
- rooms()
-
-Returns the rooms Resource.
-
-
- scores()
-
-Returns the scores Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/games_v1.leaderboards.html b/docs/dyn/games_v1.leaderboards.html
deleted file mode 100644
index e23f328..0000000
--- a/docs/dyn/games_v1.leaderboards.html
+++ /dev/null
@@ -1,156 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(leaderboardId, language=None)
-Retrieves the metadata of the leaderboard with the given ID.
-
- list(pageToken=None, language=None, maxResults=None)
-Lists all the leaderboard metadata for your application.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(leaderboardId, language=None)
-
Retrieves the metadata of the leaderboard with the given ID.
-
-Args:
- leaderboardId: string, The ID of the leaderboard. (required)
- language: string, The preferred language to use for strings returned by this method.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for the Leaderboard resource.
- "kind": "games#leaderboard", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboard.
- "isIconUrlDefault": True or False, # Indicates whether the icon image being returned is a default image, or is game-provided.
- "name": "A String", # The name of the leaderboard.
- "id": "A String", # The leaderboard ID.
- "iconUrl": "A String", # The icon for the leaderboard.
- "order": "A String", # How scores are ordered.
- # Possible values are:
- # - "LARGER_IS_BETTER" - Larger values are better; scores are sorted in descending order.
- # - "SMALLER_IS_BETTER" - Smaller values are better; scores are sorted in ascending order.
- }
-
-
list(pageToken=None, language=None, maxResults=None)
-
Lists all the leaderboard metadata for your application.
-
-Args:
- pageToken: string, The token returned by the previous request.
- language: string, The preferred language to use for strings returned by this method.
- maxResults: integer, The maximum number of leaderboards to return in the response. For any response, the actual number of leaderboards returned may be less than the specified maxResults.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a list of leaderboard objects.
- "nextPageToken": "A String", # Token corresponding to the next page of results.
- "items": [ # The leaderboards.
- { # This is a JSON template for the Leaderboard resource.
- "kind": "games#leaderboard", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboard.
- "isIconUrlDefault": True or False, # Indicates whether the icon image being returned is a default image, or is game-provided.
- "name": "A String", # The name of the leaderboard.
- "id": "A String", # The leaderboard ID.
- "iconUrl": "A String", # The icon for the leaderboard.
- "order": "A String", # How scores are ordered.
- # Possible values are:
- # - "LARGER_IS_BETTER" - Larger values are better; scores are sorted in descending order.
- # - "SMALLER_IS_BETTER" - Smaller values are better; scores are sorted in ascending order.
- },
- ],
- "kind": "games#leaderboardListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardListResponse.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(playerId)
-Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set playerId to me.
-Method Details
-
-
get(playerId)
-
Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set playerId to me.
-
-Args:
- playerId: string, A player ID. A value of me may be used in place of the authenticated player's ID. (required)
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a Player resource.
- "playerId": "A String", # The ID of the player.
- "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- }
-
Instance Methods
-
- check(clientRevision)
-Checks whether the games client is out of date.
-Method Details
-
-
check(clientRevision)
-
Checks whether the games client is out of date.
-
-Args:
- clientRevision: string, The revision of the client SDK used by your application. (required)
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for the result of checking a revision.
- "kind": "games#revisionCheckResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#revisionCheckResponse.
- "revisionStatus": "A String", # The result of the revision check.
- # Possible values are:
- # - "OK" - The revision being used is current.
- # - "DEPRECATED" - There is currently a newer version available, but the revision being used still works.
- # - "INVALID" - The revision being used is not supported in any released version.
- }
-
Instance Methods
-
- create(body, language=None)
-Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
-
- decline(roomId)
-Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
-
- dismiss(roomId)
-Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
-
- get(roomId, language=None)
-Get the data for a room.
-
- join(roomId, body)
-Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
-
- leave(roomId, body)
-Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
-
- list(pageToken=None, language=None, maxResults=None)
-Returns invitations to join rooms.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- reportStatus(roomId, body)
-Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
-Method Details
-
-
create(body, language=None)
-
Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # This is a JSON template for a room creation request.
- "kind": "games#roomCreateRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomCreateRequest.
- "autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.
- "kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.
- "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.
- "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game.
- "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.
- },
- "invitedPlayerIds": [ # The player IDs to invite to the room.
- "A String",
- ],
- "variant": 42, # The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible.
- "capabilities": [ # The capabilities that this client supports for realtime communication.
- "A String",
- ],
- "networkDiagnostics": { # This is a JSON template for network diagnostics reported for a client. # Network diagnostics for the client creating the room.
- "registrationLatencyMillis": 42, # The amount of time in milliseconds it took for the client to establish a connection with the XMPP server.
- "kind": "games#networkDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#networkDiagnostics.
- "androidNetworkSubtype": 42, # The Android network subtype.
- "androidNetworkType": 42, # The Android network type.
- },
- "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the player creating the room.
- "kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.
- "xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.
- },
- }
-
- language: string, The preferred language to use for strings returned by this method.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a room resource object.
- "status": "A String", # The status of the room.
- # Possible values are:
- # - "ROOM_INVITING" - One or more players have been invited and not responded.
- # - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.
- # - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching).
- # - "ROOM_ACTIVE" - All players have joined and connected to each other.
- # - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.
- "kind": "games#room", # Uniquely identifies the type of this resource. Value is always the fixed string games#room.
- "autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.
- "kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.
- "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.
- "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game.
- "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.
- },
- "creationDetails": { # This is a JSON template for room modification metadata. # Details about the room creation.
- "kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
- "modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
- "participantId": "A String", # The ID of the participant that modified the room.
- },
- "description": "A String", # This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)
- "roomId": "A String", # Globally unique ID for a room.
- "autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the automatching status.
- "kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.
- "waitEstimateSeconds": 42, # An estimate for the amount of time that automatching is expected to take to complete.
- },
- "participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.
- { # This is a JSON template for a participant in a room.
- "status": "A String", # The status of the participant with respect to the room.
- # Possible values are:
- # - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.
- # - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)
- # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.
- # - "PARTICIPANT_LEFT" - The participant joined the room and then left it.
- "kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.
- "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.
- "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.
- "displayName": "A String", # The name to display for the anonymous player.
- },
- "leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.
- # Possible values are:
- # - "PLAYER_LEFT" - The player explicitly chose to leave the room.
- # - "GAME_LEFT" - The game chose to remove the player from the room.
- # - "ABANDONED" - The player switched to another application and abandoned the room.
- # - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.
- # - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.
- # - "TIMEOUT" - The client timed out while waiting for players to join and connect.
- # - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.
- "capabilities": [ # The capabilities which can be used when communicating with this participant.
- "A String",
- ],
- "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "playerId": "A String", # The ID of the player.
- "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- },
- "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.
- "kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.
- "xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.
- },
- "connected": True or False, # True if this participant is in the fully connected set of peers in the room.
- "id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.
- },
- ],
- "roomStatusVersion": 42, # The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.
- "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank.
- "lastUpdateDetails": { # This is a JSON template for room modification metadata. # Details about the last update to the room.
- "kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
- "modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
- "participantId": "A String", # The ID of the participant that modified the room.
- },
- "applicationId": "A String", # The ID of the application being played.
- }
-
-
decline(roomId)
-
Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
-
-Args:
- roomId: string, The ID of the room. (required)
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a room resource object.
- "status": "A String", # The status of the room.
- # Possible values are:
- # - "ROOM_INVITING" - One or more players have been invited and not responded.
- # - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.
- # - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching).
- # - "ROOM_ACTIVE" - All players have joined and connected to each other.
- # - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.
- "kind": "games#room", # Uniquely identifies the type of this resource. Value is always the fixed string games#room.
- "autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.
- "kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.
- "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.
- "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game.
- "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.
- },
- "creationDetails": { # This is a JSON template for room modification metadata. # Details about the room creation.
- "kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
- "modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
- "participantId": "A String", # The ID of the participant that modified the room.
- },
- "description": "A String", # This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)
- "roomId": "A String", # Globally unique ID for a room.
- "autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the automatching status.
- "kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.
- "waitEstimateSeconds": 42, # An estimate for the amount of time that automatching is expected to take to complete.
- },
- "participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.
- { # This is a JSON template for a participant in a room.
- "status": "A String", # The status of the participant with respect to the room.
- # Possible values are:
- # - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.
- # - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)
- # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.
- # - "PARTICIPANT_LEFT" - The participant joined the room and then left it.
- "kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.
- "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.
- "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.
- "displayName": "A String", # The name to display for the anonymous player.
- },
- "leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.
- # Possible values are:
- # - "PLAYER_LEFT" - The player explicitly chose to leave the room.
- # - "GAME_LEFT" - The game chose to remove the player from the room.
- # - "ABANDONED" - The player switched to another application and abandoned the room.
- # - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.
- # - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.
- # - "TIMEOUT" - The client timed out while waiting for players to join and connect.
- # - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.
- "capabilities": [ # The capabilities which can be used when communicating with this participant.
- "A String",
- ],
- "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "playerId": "A String", # The ID of the player.
- "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- },
- "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.
- "kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.
- "xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.
- },
- "connected": True or False, # True if this participant is in the fully connected set of peers in the room.
- "id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.
- },
- ],
- "roomStatusVersion": 42, # The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.
- "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank.
- "lastUpdateDetails": { # This is a JSON template for room modification metadata. # Details about the last update to the room.
- "kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
- "modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
- "participantId": "A String", # The ID of the participant that modified the room.
- },
- "applicationId": "A String", # The ID of the application being played.
- }
-
-
dismiss(roomId)
-
Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
-
-Args:
- roomId: string, The ID of the room. (required)
-
-
-
get(roomId, language=None)
-
Get the data for a room.
-
-Args:
- roomId: string, The ID of the room. (required)
- language: string, Specify the preferred language to use to format room info.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a room resource object.
- "status": "A String", # The status of the room.
- # Possible values are:
- # - "ROOM_INVITING" - One or more players have been invited and not responded.
- # - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.
- # - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching).
- # - "ROOM_ACTIVE" - All players have joined and connected to each other.
- # - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.
- "kind": "games#room", # Uniquely identifies the type of this resource. Value is always the fixed string games#room.
- "autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.
- "kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.
- "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.
- "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game.
- "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.
- },
- "creationDetails": { # This is a JSON template for room modification metadata. # Details about the room creation.
- "kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
- "modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
- "participantId": "A String", # The ID of the participant that modified the room.
- },
- "description": "A String", # This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)
- "roomId": "A String", # Globally unique ID for a room.
- "autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the automatching status.
- "kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.
- "waitEstimateSeconds": 42, # An estimate for the amount of time that automatching is expected to take to complete.
- },
- "participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.
- { # This is a JSON template for a participant in a room.
- "status": "A String", # The status of the participant with respect to the room.
- # Possible values are:
- # - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.
- # - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)
- # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.
- # - "PARTICIPANT_LEFT" - The participant joined the room and then left it.
- "kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.
- "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.
- "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.
- "displayName": "A String", # The name to display for the anonymous player.
- },
- "leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.
- # Possible values are:
- # - "PLAYER_LEFT" - The player explicitly chose to leave the room.
- # - "GAME_LEFT" - The game chose to remove the player from the room.
- # - "ABANDONED" - The player switched to another application and abandoned the room.
- # - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.
- # - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.
- # - "TIMEOUT" - The client timed out while waiting for players to join and connect.
- # - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.
- "capabilities": [ # The capabilities which can be used when communicating with this participant.
- "A String",
- ],
- "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "playerId": "A String", # The ID of the player.
- "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- },
- "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.
- "kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.
- "xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.
- },
- "connected": True or False, # True if this participant is in the fully connected set of peers in the room.
- "id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.
- },
- ],
- "roomStatusVersion": 42, # The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.
- "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank.
- "lastUpdateDetails": { # This is a JSON template for room modification metadata. # Details about the last update to the room.
- "kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
- "modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
- "participantId": "A String", # The ID of the participant that modified the room.
- },
- "applicationId": "A String", # The ID of the application being played.
- }
-
-
join(roomId, body)
-
Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
-
-Args:
- roomId: string, The ID of the room. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # This is a JSON template for a join room request.
- "networkDiagnostics": { # This is a JSON template for network diagnostics reported for a client. # Network diagnostics for the client joining the room.
- "registrationLatencyMillis": 42, # The amount of time in milliseconds it took for the client to establish a connection with the XMPP server.
- "kind": "games#networkDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#networkDiagnostics.
- "androidNetworkSubtype": 42, # The Android network subtype.
- "androidNetworkType": 42, # The Android network type.
- },
- "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the player joining the room.
- "kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.
- "xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.
- },
- "kind": "games#roomJoinRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomJoinRequest.
- "capabilities": [ # The capabilities that this client supports for realtime communication.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a room resource object.
- "status": "A String", # The status of the room.
- # Possible values are:
- # - "ROOM_INVITING" - One or more players have been invited and not responded.
- # - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.
- # - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching).
- # - "ROOM_ACTIVE" - All players have joined and connected to each other.
- # - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.
- "kind": "games#room", # Uniquely identifies the type of this resource. Value is always the fixed string games#room.
- "autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.
- "kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.
- "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.
- "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game.
- "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.
- },
- "creationDetails": { # This is a JSON template for room modification metadata. # Details about the room creation.
- "kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
- "modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
- "participantId": "A String", # The ID of the participant that modified the room.
- },
- "description": "A String", # This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)
- "roomId": "A String", # Globally unique ID for a room.
- "autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the automatching status.
- "kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.
- "waitEstimateSeconds": 42, # An estimate for the amount of time that automatching is expected to take to complete.
- },
- "participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.
- { # This is a JSON template for a participant in a room.
- "status": "A String", # The status of the participant with respect to the room.
- # Possible values are:
- # - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.
- # - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)
- # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.
- # - "PARTICIPANT_LEFT" - The participant joined the room and then left it.
- "kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.
- "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.
- "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.
- "displayName": "A String", # The name to display for the anonymous player.
- },
- "leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.
- # Possible values are:
- # - "PLAYER_LEFT" - The player explicitly chose to leave the room.
- # - "GAME_LEFT" - The game chose to remove the player from the room.
- # - "ABANDONED" - The player switched to another application and abandoned the room.
- # - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.
- # - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.
- # - "TIMEOUT" - The client timed out while waiting for players to join and connect.
- # - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.
- "capabilities": [ # The capabilities which can be used when communicating with this participant.
- "A String",
- ],
- "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "playerId": "A String", # The ID of the player.
- "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- },
- "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.
- "kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.
- "xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.
- },
- "connected": True or False, # True if this participant is in the fully connected set of peers in the room.
- "id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.
- },
- ],
- "roomStatusVersion": 42, # The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.
- "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank.
- "lastUpdateDetails": { # This is a JSON template for room modification metadata. # Details about the last update to the room.
- "kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
- "modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
- "participantId": "A String", # The ID of the participant that modified the room.
- },
- "applicationId": "A String", # The ID of the application being played.
- }
-
-
leave(roomId, body)
-
Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
-
-Args:
- roomId: string, The ID of the room. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # This is a JSON template for a leave room request.
- "kind": "games#roomLeaveRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomLeaveRequest.
- "reason": "A String", # Reason for leaving the match.
- # Possible values are:
- # - "PLAYER_LEFT" - The player chose to leave the room..
- # - "GAME_LEFT" - The game chose to remove the player from the room.
- # - "REALTIME_ABANDONED" - The player switched to another application and abandoned the room.
- # - "REALTIME_PEER_CONNECTION_FAILURE" - The client was unable to establish a connection to other peer(s).
- # - "REALTIME_SERVER_CONNECTION_FAILURE" - The client was unable to communicate with the server.
- # - "REALTIME_SERVER_ERROR" - The client received an error response when it tried to communicate with the server.
- # - "REALTIME_TIMEOUT" - The client timed out while waiting for a room.
- "leaveDiagnostics": { # This is a JSON template for room leave diagnostics. # Diagnostics for a player leaving the room.
- "kind": "games#roomLeaveDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomLeaveDiagnostics.
- "peerSession": [ # Diagnostics about all peer sessions.
- { # This is a JSON template for peer session diagnostics.
- "unreliableChannel": { # This is a JSON template for peer channel diagnostics. # Unreliable channel diagnostics.
- "bytesReceived": { # This is a JSON template for aggregate stats. # Number of bytes received.
- "count": "A String", # The number of messages sent between a pair of peers.
- "max": "A String", # The maximum amount.
- "kind": "games#aggregateStats", # Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.
- "sum": "A String", # The total number of bytes sent for messages between a pair of peers.
- "min": "A String", # The minimum amount.
- },
- "kind": "games#peerChannelDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#peerChannelDiagnostics.
- "bytesSent": { # This is a JSON template for aggregate stats. # Number of bytes sent.
- "count": "A String", # The number of messages sent between a pair of peers.
- "max": "A String", # The maximum amount.
- "kind": "games#aggregateStats", # Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.
- "sum": "A String", # The total number of bytes sent for messages between a pair of peers.
- "min": "A String", # The minimum amount.
- },
- "numSendFailures": 42, # Number of send failures.
- "numMessagesLost": 42, # Number of messages lost.
- "numMessagesReceived": 42, # Number of messages received.
- "numMessagesSent": 42, # Number of messages sent.
- "roundtripLatencyMillis": { # This is a JSON template for aggregate stats. # Roundtrip latency stats in milliseconds.
- "count": "A String", # The number of messages sent between a pair of peers.
- "max": "A String", # The maximum amount.
- "kind": "games#aggregateStats", # Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.
- "sum": "A String", # The total number of bytes sent for messages between a pair of peers.
- "min": "A String", # The minimum amount.
- },
- },
- "kind": "games#peerSessionDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#peerSessionDiagnostics.
- "reliableChannel": { # This is a JSON template for peer channel diagnostics. # Reliable channel diagnostics.
- "bytesReceived": { # This is a JSON template for aggregate stats. # Number of bytes received.
- "count": "A String", # The number of messages sent between a pair of peers.
- "max": "A String", # The maximum amount.
- "kind": "games#aggregateStats", # Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.
- "sum": "A String", # The total number of bytes sent for messages between a pair of peers.
- "min": "A String", # The minimum amount.
- },
- "kind": "games#peerChannelDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#peerChannelDiagnostics.
- "bytesSent": { # This is a JSON template for aggregate stats. # Number of bytes sent.
- "count": "A String", # The number of messages sent between a pair of peers.
- "max": "A String", # The maximum amount.
- "kind": "games#aggregateStats", # Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.
- "sum": "A String", # The total number of bytes sent for messages between a pair of peers.
- "min": "A String", # The minimum amount.
- },
- "numSendFailures": 42, # Number of send failures.
- "numMessagesLost": 42, # Number of messages lost.
- "numMessagesReceived": 42, # Number of messages received.
- "numMessagesSent": 42, # Number of messages sent.
- "roundtripLatencyMillis": { # This is a JSON template for aggregate stats. # Roundtrip latency stats in milliseconds.
- "count": "A String", # The number of messages sent between a pair of peers.
- "max": "A String", # The maximum amount.
- "kind": "games#aggregateStats", # Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.
- "sum": "A String", # The total number of bytes sent for messages between a pair of peers.
- "min": "A String", # The minimum amount.
- },
- },
- "connectedTimestampMillis": "A String", # Connected time in milliseconds.
- "participantId": "A String", # The participant ID of the peer.
- },
- ],
- "androidNetworkSubtype": 42, # Android network subtype. http://developer.android.com/reference/android/net/NetworkInfo.html#getSubtype()
- "socketsUsed": True or False, # Whether or not sockets were used.
- "androidNetworkType": 42, # Android network type. http://developer.android.com/reference/android/net/NetworkInfo.html#getType()
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a room resource object.
- "status": "A String", # The status of the room.
- # Possible values are:
- # - "ROOM_INVITING" - One or more players have been invited and not responded.
- # - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.
- # - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching).
- # - "ROOM_ACTIVE" - All players have joined and connected to each other.
- # - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.
- "kind": "games#room", # Uniquely identifies the type of this resource. Value is always the fixed string games#room.
- "autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.
- "kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.
- "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.
- "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game.
- "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.
- },
- "creationDetails": { # This is a JSON template for room modification metadata. # Details about the room creation.
- "kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
- "modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
- "participantId": "A String", # The ID of the participant that modified the room.
- },
- "description": "A String", # This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)
- "roomId": "A String", # Globally unique ID for a room.
- "autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the automatching status.
- "kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.
- "waitEstimateSeconds": 42, # An estimate for the amount of time that automatching is expected to take to complete.
- },
- "participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.
- { # This is a JSON template for a participant in a room.
- "status": "A String", # The status of the participant with respect to the room.
- # Possible values are:
- # - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.
- # - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)
- # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.
- # - "PARTICIPANT_LEFT" - The participant joined the room and then left it.
- "kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.
- "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.
- "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.
- "displayName": "A String", # The name to display for the anonymous player.
- },
- "leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.
- # Possible values are:
- # - "PLAYER_LEFT" - The player explicitly chose to leave the room.
- # - "GAME_LEFT" - The game chose to remove the player from the room.
- # - "ABANDONED" - The player switched to another application and abandoned the room.
- # - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.
- # - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.
- # - "TIMEOUT" - The client timed out while waiting for players to join and connect.
- # - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.
- "capabilities": [ # The capabilities which can be used when communicating with this participant.
- "A String",
- ],
- "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "playerId": "A String", # The ID of the player.
- "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- },
- "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.
- "kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.
- "xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.
- },
- "connected": True or False, # True if this participant is in the fully connected set of peers in the room.
- "id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.
- },
- ],
- "roomStatusVersion": 42, # The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.
- "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank.
- "lastUpdateDetails": { # This is a JSON template for room modification metadata. # Details about the last update to the room.
- "kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
- "modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
- "participantId": "A String", # The ID of the participant that modified the room.
- },
- "applicationId": "A String", # The ID of the application being played.
- }
-
-
list(pageToken=None, language=None, maxResults=None)
-
Returns invitations to join rooms.
-
-Args:
- pageToken: string, The token returned by the previous request.
- language: string, The preferred language to use for strings returned by this method.
- maxResults: integer, The maximum number of rooms to return in the response, used for paging. For any response, the actual number of rooms to return may be less than the specified maxResults.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a list of rooms.
- "nextPageToken": "A String", # The pagination token for the next page of results.
- "items": [ # The rooms.
- { # This is a JSON template for a room resource object.
- "status": "A String", # The status of the room.
- # Possible values are:
- # - "ROOM_INVITING" - One or more players have been invited and not responded.
- # - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.
- # - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching).
- # - "ROOM_ACTIVE" - All players have joined and connected to each other.
- # - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.
- "kind": "games#room", # Uniquely identifies the type of this resource. Value is always the fixed string games#room.
- "autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.
- "kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.
- "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.
- "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game.
- "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.
- },
- "creationDetails": { # This is a JSON template for room modification metadata. # Details about the room creation.
- "kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
- "modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
- "participantId": "A String", # The ID of the participant that modified the room.
- },
- "description": "A String", # This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)
- "roomId": "A String", # Globally unique ID for a room.
- "autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the automatching status.
- "kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.
- "waitEstimateSeconds": 42, # An estimate for the amount of time that automatching is expected to take to complete.
- },
- "participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.
- { # This is a JSON template for a participant in a room.
- "status": "A String", # The status of the participant with respect to the room.
- # Possible values are:
- # - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.
- # - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)
- # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.
- # - "PARTICIPANT_LEFT" - The participant joined the room and then left it.
- "kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.
- "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.
- "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.
- "displayName": "A String", # The name to display for the anonymous player.
- },
- "leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.
- # Possible values are:
- # - "PLAYER_LEFT" - The player explicitly chose to leave the room.
- # - "GAME_LEFT" - The game chose to remove the player from the room.
- # - "ABANDONED" - The player switched to another application and abandoned the room.
- # - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.
- # - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.
- # - "TIMEOUT" - The client timed out while waiting for players to join and connect.
- # - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.
- "capabilities": [ # The capabilities which can be used when communicating with this participant.
- "A String",
- ],
- "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "playerId": "A String", # The ID of the player.
- "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- },
- "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.
- "kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.
- "xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.
- },
- "connected": True or False, # True if this participant is in the fully connected set of peers in the room.
- "id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.
- },
- ],
- "roomStatusVersion": 42, # The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.
- "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank.
- "lastUpdateDetails": { # This is a JSON template for room modification metadata. # Details about the last update to the room.
- "kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
- "modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
- "participantId": "A String", # The ID of the participant that modified the room.
- },
- "applicationId": "A String", # The ID of the application being played.
- },
- ],
- "kind": "games#roomList", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomList.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
reportStatus(roomId, body)
-
Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
-
-Args:
- roomId: string, The ID of the room. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # This is a JSON template for an update on the status of peers in a room.
- "kind": "games#roomP2PStatuses", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomP2PStatuses.
- "updates": [ # The updates for the peers.
- { # This is a JSON template for an update on the status of a peer in a room.
- "status": "A String", # The status of the peer in the room.
- # Possible values are:
- # - "CONNECTION_ESTABLISHED" - The client established a P2P connection with the peer.
- # - "CONNECTION_FAILED" - The client failed to establish directed presence with the peer.
- "kind": "games#roomP2PStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomP2PStatus.
- "participantId": "A String", # The ID of the participant.
- "unreliableRoundtripLatencyMillis": 42, # The amount of time in milliseconds it took to send packets back and forth on the unreliable channel with this peer.
- "connectionSetupLatencyMillis": 42, # The amount of time in milliseconds it took to establish connections with this peer.
- "error": "A String", # The error code in event of a failure.
- # Possible values are:
- # - "P2P_FAILED" - The client failed to establish a P2P connection with the peer.
- # - "PRESENCE_FAILED" - The client failed to register to receive P2P connections.
- # - "RELAY_SERVER_FAILED" - The client received an error when trying to use the relay server to establish a P2P connection with the peer.
- "error_reason": "A String", # More detailed diagnostic message returned in event of a failure.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for the status of a room that the player has joined.
- "status": "A String", # The status of the room.
- # Possible values are:
- # - "ROOM_INVITING" - One or more players have been invited and not responded.
- # - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.
- # - "ROOM_CONNECTING" - Players have joined are connecting to each other (either before or after auto-matching).
- # - "ROOM_ACTIVE" - All players have joined and connected to each other.
- # - "ROOM_DELETED" - All joined players have left.
- "kind": "games#roomStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomStatus.
- "autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the automatching queue.
- "kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.
- "waitEstimateSeconds": 42, # An estimate for the amount of time that automatching is expected to take to complete.
- },
- "participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.
- { # This is a JSON template for a participant in a room.
- "status": "A String", # The status of the participant with respect to the room.
- # Possible values are:
- # - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.
- # - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)
- # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.
- # - "PARTICIPANT_LEFT" - The participant joined the room and then left it.
- "kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.
- "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.
- "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.
- "displayName": "A String", # The name to display for the anonymous player.
- },
- "leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.
- # Possible values are:
- # - "PLAYER_LEFT" - The player explicitly chose to leave the room.
- # - "GAME_LEFT" - The game chose to remove the player from the room.
- # - "ABANDONED" - The player switched to another application and abandoned the room.
- # - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.
- # - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.
- # - "TIMEOUT" - The client timed out while waiting for players to join and connect.
- # - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.
- "capabilities": [ # The capabilities which can be used when communicating with this participant.
- "A String",
- ],
- "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
- "playerId": "A String", # The ID of the player.
- "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- },
- "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.
- "kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.
- "xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.
- },
- "connected": True or False, # True if this participant is in the fully connected set of peers in the room.
- "id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.
- },
- ],
- "statusVersion": 42, # The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status.
- "roomId": "A String", # Globally unique ID for a room.
- }
-
Instance Methods
-
- get(playerId, leaderboardId, timeSpan, includeRankType=None, language=None, maxResults=None, pageToken=None)
-Get high scores and optionally, ranks in leaderboards for the currently authenticated player. For a specific time span, leaderboardId can be set to ALL to retrieve data for all leaderboards in a given time span.
-
- get_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- list(leaderboardId, collection, timeSpan, language=None, maxResults=None, pageToken=None)
-Lists the scores in a leaderboard, starting from the top.
-
- listWindow(leaderboardId, collection, timeSpan, language=None, returnTopIfAbsent=None, resultsAbove=None, maxResults=None, pageToken=None)
-Lists the scores in a leaderboard around (and including) a player's score.
-
- listWindow_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- submit(leaderboardId, score, language=None)
-Submits a score to the specified leaderboard.
-
- submitMultiple(body, language=None)
-Submits multiple scores to leaderboards.
-Method Details
-
-
get(playerId, leaderboardId, timeSpan, includeRankType=None, language=None, maxResults=None, pageToken=None)
-
Get high scores and optionally, ranks in leaderboards for the currently authenticated player. For a specific time span, leaderboardId can be set to ALL to retrieve data for all leaderboards in a given time span.
-
-Args:
- playerId: string, A player ID. A value of me may be used in place of the authenticated player's ID. (required)
- leaderboardId: string, The ID of the leaderboard. (required)
- timeSpan: string, The time span for the scores and ranks you're requesting. (required)
- Allowed values
- ALL - Get the high scores for all time spans. If this is used, maxResults values will be ignored.
- ALL_TIME - Get the all time high score.
- DAILY - List the top scores for the current day.
- WEEKLY - List the top scores for the current week.
- includeRankType: string, The types of ranks to return. If the parameter is omitted, no ranks will be returned.
- Allowed values
- ALL - Retrieve public and social ranks.
- PUBLIC - Retrieve public ranks, if the player is sharing their gameplay activity publicly.
- SOCIAL - Retrieve the social rank.
- language: string, The preferred language to use for strings returned by this method.
- maxResults: integer, The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.
- pageToken: string, The token returned by the previous request.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a list of player leaderboard scores.
- "nextPageToken": "A String", # The pagination token for the next page of results.
- "items": [ # The leaderboard scores.
- { # This is a JSON template for a player leaderboard score object.
- "writeTimestamp": "A String", # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
- "kind": "games#playerLeaderboardScore", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLeaderboardScore.
- "publicRank": { # This is a JSON template for a score rank in a leaderboard. # The public rank of the score in this leaderboard. This object will not be present if the user is not sharing their scores publicly.
- "numScores": "A String", # The number of scores in the leaderboard.
- "kind": "games#leaderboardScoreRank", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardScoreRank.
- "formattedRank": "A String", # The rank in the leaderboard as a string.
- "rank": "A String", # The rank in the leaderboard.
- "formattedNumScores": "A String", # The number of scores in the leaderboard as a string.
- },
- "timeSpan": "A String", # The time span of this score.
- # Possible values are:
- # - "ALL_TIME" - The score is an all-time score.
- # - "WEEKLY" - The score is a weekly score.
- # - "DAILY" - The score is a daily score.
- "scoreString": "A String", # The formatted value of this score.
- "leaderboard_id": "A String", # The ID of the leaderboard this score is in.
- "scoreValue": "A String", # The numerical value of this score.
- "socialRank": { # This is a JSON template for a score rank in a leaderboard. # The social rank of the score in this leaderboard.
- "numScores": "A String", # The number of scores in the leaderboard.
- "kind": "games#leaderboardScoreRank", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardScoreRank.
- "formattedRank": "A String", # The rank in the leaderboard as a string.
- "rank": "A String", # The rank in the leaderboard.
- "formattedNumScores": "A String", # The number of scores in the leaderboard as a string.
- },
- },
- ],
- "kind": "games#playerLeaderboardScoreListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLeaderboardScoreListResponse.
- }
-
-
get_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
list(leaderboardId, collection, timeSpan, language=None, maxResults=None, pageToken=None)
-
Lists the scores in a leaderboard, starting from the top.
-
-Args:
- leaderboardId: string, The ID of the leaderboard. (required)
- collection: string, The collection of scores you're requesting. (required)
- Allowed values
- PUBLIC - List all scores in the public leaderboard.
- SOCIAL - List only social scores.
- timeSpan: string, The time span for the scores and ranks you're requesting. (required)
- Allowed values
- ALL_TIME - List the all-time top scores.
- DAILY - List the top scores for the current day.
- WEEKLY - List the top scores for the current week.
- language: string, The preferred language to use for strings returned by this method.
- maxResults: integer, The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.
- pageToken: string, The token returned by the previous request.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a ListScores response.
- "nextPageToken": "A String", # The pagination token for the next page of results.
- "kind": "games#leaderboardScores", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardScores.
- "numScores": "A String", # The total number of scores in the leaderboard.
- "items": [ # The scores in the leaderboard.
- { # This is a JSON template for the Leaderboard Entry resource.
- "kind": "games#leaderboardEntry", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardEntry.
- "scoreValue": "A String", # The numerical value of this score.
- "timeSpan": "A String", # The time span of this high score.
- # Possible values are:
- # - "ALL_TIME" - The score is an all-time high score.
- # - "WEEKLY" - The score is a weekly high score.
- # - "DAILY" - The score is a daily high score.
- "formattedScore": "A String", # The localized string for the numerical value of this score.
- "player": { # This is a JSON template for a Player resource. # The player who holds this score.
- "playerId": "A String", # The ID of the player.
- "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- },
- "formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard.
- "scoreRank": "A String", # The rank of this score for this leaderboard.
- "writeTimestampMillis": "A String", # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
- },
- ],
- "playerScore": { # This is a JSON template for the Leaderboard Entry resource. # The score of the requesting player on the leaderboard. The player's score may appear both here and in the list of scores above. If you are viewing a public leaderboard and the player is not sharing their gameplay information publicly, the scoreRank and formattedScoreRank values will not be present.
- "kind": "games#leaderboardEntry", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardEntry.
- "scoreValue": "A String", # The numerical value of this score.
- "timeSpan": "A String", # The time span of this high score.
- # Possible values are:
- # - "ALL_TIME" - The score is an all-time high score.
- # - "WEEKLY" - The score is a weekly high score.
- # - "DAILY" - The score is a daily high score.
- "formattedScore": "A String", # The localized string for the numerical value of this score.
- "player": { # This is a JSON template for a Player resource. # The player who holds this score.
- "playerId": "A String", # The ID of the player.
- "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- },
- "formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard.
- "scoreRank": "A String", # The rank of this score for this leaderboard.
- "writeTimestampMillis": "A String", # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
- },
- "prevPageToken": "A String", # The pagination token for the previous page of results.
- }
-
-
listWindow(leaderboardId, collection, timeSpan, language=None, returnTopIfAbsent=None, resultsAbove=None, maxResults=None, pageToken=None)
-
Lists the scores in a leaderboard around (and including) a player's score.
-
-Args:
- leaderboardId: string, The ID of the leaderboard. (required)
- collection: string, The collection of scores you're requesting. (required)
- Allowed values
- PUBLIC - List all scores in the public leaderboard.
- SOCIAL - List only social scores.
- timeSpan: string, The time span for the scores and ranks you're requesting. (required)
- Allowed values
- ALL_TIME - List the all-time top scores.
- DAILY - List the top scores for the current day.
- WEEKLY - List the top scores for the current week.
- language: string, The preferred language to use for strings returned by this method.
- returnTopIfAbsent: boolean, True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.
- resultsAbove: integer, The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.
- maxResults: integer, The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.
- pageToken: string, The token returned by the previous request.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a ListScores response.
- "nextPageToken": "A String", # The pagination token for the next page of results.
- "kind": "games#leaderboardScores", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardScores.
- "numScores": "A String", # The total number of scores in the leaderboard.
- "items": [ # The scores in the leaderboard.
- { # This is a JSON template for the Leaderboard Entry resource.
- "kind": "games#leaderboardEntry", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardEntry.
- "scoreValue": "A String", # The numerical value of this score.
- "timeSpan": "A String", # The time span of this high score.
- # Possible values are:
- # - "ALL_TIME" - The score is an all-time high score.
- # - "WEEKLY" - The score is a weekly high score.
- # - "DAILY" - The score is a daily high score.
- "formattedScore": "A String", # The localized string for the numerical value of this score.
- "player": { # This is a JSON template for a Player resource. # The player who holds this score.
- "playerId": "A String", # The ID of the player.
- "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- },
- "formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard.
- "scoreRank": "A String", # The rank of this score for this leaderboard.
- "writeTimestampMillis": "A String", # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
- },
- ],
- "playerScore": { # This is a JSON template for the Leaderboard Entry resource. # The score of the requesting player on the leaderboard. The player's score may appear both here and in the list of scores above. If you are viewing a public leaderboard and the player is not sharing their gameplay information publicly, the scoreRank and formattedScoreRank values will not be present.
- "kind": "games#leaderboardEntry", # Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardEntry.
- "scoreValue": "A String", # The numerical value of this score.
- "timeSpan": "A String", # The time span of this high score.
- # Possible values are:
- # - "ALL_TIME" - The score is an all-time high score.
- # - "WEEKLY" - The score is a weekly high score.
- # - "DAILY" - The score is a daily high score.
- "formattedScore": "A String", # The localized string for the numerical value of this score.
- "player": { # This is a JSON template for a Player resource. # The player who holds this score.
- "playerId": "A String", # The ID of the player.
- "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.
- "avatarImageUrl": "A String", # The base URL for the image that represents the player.
- "displayName": "A String", # The name to display for the player.
- },
- "formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard.
- "scoreRank": "A String", # The rank of this score for this leaderboard.
- "writeTimestampMillis": "A String", # The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
- },
- "prevPageToken": "A String", # The pagination token for the previous page of results.
- }
-
-
listWindow_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
submit(leaderboardId, score, language=None)
-
Submits a score to the specified leaderboard.
-
-Args:
- leaderboardId: string, The ID of the leaderboard. (required)
- score: string, The score you're submitting. The submitted score is ignored if it is worse than a previously submitted score, where worse depends on the leaderboard sort order. The meaning of the score value depends on the leaderboard format type. For fixed-point, the score represents the raw value. For time, the score represents elapsed time in milliseconds. For currency, the score represents a value in micro units. (required)
- language: string, The preferred language to use for strings returned by this method.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a list of leaderboard entry resources.
- "kind": "games#playerScoreResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreResponse.
- "leaderboardId": "A String", # The leaderboard ID that this score was submitted to.
- "formattedScore": "A String", # The formatted value of the submitted score.
- "beatenScoreTimeSpans": [ # The time spans where the submitted score is better than the existing score for that time span.
- # Possible values are:
- # - "ALL_TIME" - The score is an all-time score.
- # - "WEEKLY" - The score is a weekly score.
- # - "DAILY" - The score is a daily score.
- "A String",
- ],
- "unbeatenScores": [ # The scores in time spans that have not been beaten. As an example, the submitted score may be better than the player's DAILY score, but not better than the player's scores for the WEEKLY or ALL_TIME time spans.
- { # This is a JSON template for a player score.
- "kind": "games#playerScore", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerScore.
- "score": "A String", # The numerical value for this player score.
- "formattedScore": "A String", # The formatted score for this player score.
- "timeSpan": "A String", # The time span for this player score.
- # Possible values are:
- # - "ALL_TIME" - The score is an all-time score.
- # - "WEEKLY" - The score is a weekly score.
- # - "DAILY" - The score is a daily score.
- },
- ],
- }
-
-
submitMultiple(body, language=None)
-
Submits multiple scores to leaderboards.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # This is a JSON template for a list of score submission requests
- "kind": "games#playerScoreSubmissionList", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreSubmissionList.
- "scores": [ # The score submissions.
- { # This is a JSON template for a request to submit a score to leaderboards.
- "kind": "games#scoreSubmission", # Uniquely identifies the type of this resource. Value is always the fixed string games#scoreSubmission.
- "leaderboardId": "A String", # The leaderboard this score is being submitted to.
- "score": "A String", # The new score being submitted.
- },
- ],
- }
-
- language: string, The preferred language to use for strings returned by this method.
-
-Returns:
- An object of the form:
-
- { # This is a JSON template for a list of score submission statuses.
- "submittedScores": [ # The score submissions statuses.
- { # This is a JSON template for a list of leaderboard entry resources.
- "kind": "games#playerScoreResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreResponse.
- "leaderboardId": "A String", # The leaderboard ID that this score was submitted to.
- "formattedScore": "A String", # The formatted value of the submitted score.
- "beatenScoreTimeSpans": [ # The time spans where the submitted score is better than the existing score for that time span.
- # Possible values are:
- # - "ALL_TIME" - The score is an all-time score.
- # - "WEEKLY" - The score is a weekly score.
- # - "DAILY" - The score is a daily score.
- "A String",
- ],
- "unbeatenScores": [ # The scores in time spans that have not been beaten. As an example, the submitted score may be better than the player's DAILY score, but not better than the player's scores for the WEEKLY or ALL_TIME time spans.
- { # This is a JSON template for a player score.
- "kind": "games#playerScore", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerScore.
- "score": "A String", # The numerical value for this player score.
- "formattedScore": "A String", # The formatted score for this player score.
- "timeSpan": "A String", # The time span for this player score.
- # Possible values are:
- # - "ALL_TIME" - The score is an all-time score.
- # - "WEEKLY" - The score is a weekly score.
- # - "DAILY" - The score is a daily score.
- },
- ],
- },
- ],
- "kind": "games#playerScoreListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreListResponse.
- }
-
Instance Methods
-
- get(role, roleId, advertiserId=None)
-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.
-
- list(role, roleId, relationshipStatus=None, pageToken=None, minNinetyDayEpc=None, advertiserCategory=None, maxResults=None, minSevenDayEpc=None, minPayoutRank=None)
-Retrieves data about all advertisers that the requesting advertiser/publisher has access to.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(role, roleId, advertiserId=None)
-
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:
- 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)
- advertiserId: string, The ID of the advertiser to look up. Optional.
-
-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
- "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.
- "merchantCenterIds": [ # List of merchant center ids for this advertiser
- "A String",
- ],
- "defaultLinkId": "A String", # The default link id for this advertiser.
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "commissionDuration": 42, # The longest possible length of a commission (how long the cookies on the customer's browser last before they expire).
- "status": "A String", # The status of the requesting publisher's relationship this advertiser.
- "payoutRank": "A String", # A rank based on commissions paid to publishers over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid).
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "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.
- "redirectDomains": [ # List of redirect URLs for this advertiser
- "A String",
- ],
- "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.
- }
-
-
list(role, roleId, relationshipStatus=None, pageToken=None, minNinetyDayEpc=None, advertiserCategory=None, maxResults=None, minSevenDayEpc=None, minPayoutRank=None)
-
Retrieves data about all advertisers that the requesting advertiser/publisher has access to.
-
-Args:
- 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)
- relationshipStatus: string, Filters out all advertisers for which do not have the given relationship status with the requesting publisher.
- Allowed values
- approved - An advertiser that has approved your application.
- available - An advertiser program that's accepting new publishers.
- 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.
- pageToken: string, The value of 'nextPageToken' from the previous page. 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.
- 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.
- 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.
- 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:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
- "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
- "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.
- "merchantCenterIds": [ # List of merchant center ids for this advertiser
- "A String",
- ],
- "defaultLinkId": "A String", # The default link id for this advertiser.
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "commissionDuration": 42, # The longest possible length of a commission (how long the cookies on the customer's browser last before they expire).
- "status": "A String", # The status of the requesting publisher's relationship this advertiser.
- "payoutRank": "A String", # A rank based on commissions paid to publishers over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid).
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "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.
- "redirectDomains": [ # List of redirect URLs for this advertiser
- "A String",
- ],
- "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.
- },
- ],
- "kind": "gan#advertisers", # The kind for a page of advertisers.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(publisher, advertiser=None, projection=None)
-Retrieves credit card offers for the given publisher.
-Method Details
-
-
list(publisher, advertiser=None, projection=None)
-
Retrieves credit card offers for the given publisher.
-
-Args:
- publisher: string, The ID of the publisher in question. (required)
- advertiser: string, The advertiser ID of a card issuer whose offers to include. Optional, may be repeated. (repeated)
- projection: string, The set of fields to return.
- Allowed values
- full - Include all offer fields. This is the default.
- summary - Include only the basic fields needed to display an offer.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # The credit card offers.
- { # A credit card offer. There are many possible result fields. We provide two different views of the data, or "projections." The "full" projection includes every result field. And the "summary" projection, which is the default, includes a smaller subset of the fields. The fields included in the summary projection are marked as such in their descriptions.
- "luggageInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
- "creditLimitMin": 3.14, # The low end for credit limits the issuer imposes on recipients of this card.
- "cardName": "A String", # The issuer's name for the card, including any trademark or service mark designators. A summary field.
- "creditLimitMax": 3.14, # The high end for credit limits the issuer imposes on recipients of this card.
- "gracePeriodDisplay": "A String", # Text describing the grace period before finance charges apply. A summary field.
- "offerId": "A String", # This offer's ID. A summary field.
- "rewardUnit": "A String", # For cards with rewards programs, the unit of reward. For example, miles, cash back, points.
- "minPurchaseRate": 3.14, # The lowest interest rate the issuer charges on this card. Expressed as an absolute number, not as a percentage.
- "cardBenefits": [ # A list of what the issuer thinks are the most important benefits of the card. Usually summarizes the rewards program, if there is one. A summary field.
- "A String",
- ],
- "rewards": [ # For cards with rewards programs, detailed rules about how the program works.
- {
- "category": "A String", # The kind of purchases covered by this rule.
- "minRewardTier": 3.14, # The minimum purchase amount in the given category before this rule applies.
- "maxRewardTier": 3.14, # The maximum purchase amount in the given category for this rule to apply.
- "expirationMonths": 3.14, # How long rewards granted by this rule last.
- "amount": 3.14, # The number of units rewarded per purchase dollar.
- "additionalDetails": "A String", # Other limits, for example, if this rule only applies during an introductory period.
- },
- ],
- "offersImmediateCashReward": True or False, # Whether a cash reward program lets you get cash back sooner than end of year or other longish period.
- "travelInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
- "returnedPaymentFee": "A String", # Text describing the fee for a payment that doesn't clear. A summary field.
- "kind": "gan#ccOffer", # The kind for one credit card offer. A summary field.
- "issuer": "A String", # Name of card issuer. A summary field.
- "maxPurchaseRate": 3.14, # The highest interest rate the issuer charges on this card. Expressed as an absolute number, not as a percentage.
- "minimumFinanceCharge": "A String", # Text describing how much missing the grace period will cost.
- "existingCustomerOnly": True or False, # Whether this card is only available to existing customers of the issuer.
- "annualFeeDisplay": "A String", # Text describing the annual fee, including any difference for the first year. A summary field.
- "initialSetupAndProcessingFee": "A String", # Fee for setting up the card.
- "issuerId": "A String", # The Google Affiliate Network ID of the advertiser making this offer.
- "purchaseRateAdditionalDetails": "A String", # Text describing any additional details for the purchase rate. A summary field.
- "prohibitedCategories": [ # Categories in which the issuer does not wish the card to be displayed. A summary field.
- "A String",
- ],
- "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.
- "introCashAdvanceTerms": "A String", # Text describing the terms for introductory period cash advances. A summary field.
- "rewardsExpire": True or False, # Whether accumulated rewards ever expire.
- "introPurchaseTerms": "A String", # Text describing the terms for introductory period purchases. A summary field.
- "defaultFees": [ # Fees for defaulting on your payments.
- {
- "category": "A String", # The type of charge, for example Purchases.
- "maxRate": 3.14, # The highest rate the issuer may charge for defaulting on debt in this category. Expressed as an absolute number, not as a percentage.
- "minRate": 3.14, # The lowest rate the issuer may charge for defaulting on debt in this category. Expressed as an absolute number, not as a percentage.
- "rateType": "A String", # Fixed or variable.
- },
- ],
- "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.
- "overLimitFee": "A String", # Fee for exceeding the card's charge limit.
- "cardType": "A String", # What kind of credit card this is, for example secured or unsecured.
- "approvedCategories": [ # Possible categories for this card, eg "Low Interest" or "Good." A summary field.
- "A String",
- ],
- "rewardPartner": "A String", # The company that redeems the rewards, if different from the issuer.
- "introBalanceTransferTerms": "A String", # Text describing the terms for introductory period balance transfers. A summary field.
- "foreignCurrencyTransactionFee": "A String", # Fee for each transaction involving a foreign currency.
- "annualFee": 3.14, # The ongoing annual fee, in dollars.
- "issuerWebsite": "A String", # The generic link to the issuer's site.
- "variableRatesUpdateFrequency": "A String", # How often variable rates are updated.
- "carRentalInsurance": "A String", # If you get coverage when you use the card for the given activity, this field describes it.
- "additionalCardBenefits": [ # More marketing copy about the card's benefits. A summary field.
- "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.
- "network": "A String", # Which network (eg Visa) the card belongs to. A summary field.
- "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.
- "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.
- "bonusRewards": [ # For cards with rewards programs, extra circumstances whereby additional rewards may be granted.
- {
- "amount": 3.14, # How many units of reward will be granted.
- "details": "A String", # The circumstances under which this rule applies, for example, booking a flight via Orbitz.
- },
- ],
- "imageUrl": "A String", # The link to the image of the card that is shown on Connect Commerce. A summary field.
- "ageMinimumDetails": "A String", # Text describing the details of the age minimum restriction.
- "disclaimer": "A String", # A notice that, if present, is referenced via an asterisk by many of the other summary fields. If this field is present, it will always start with an asterisk ("*"), and must be prominently displayed with the offer. A summary field.
- },
- ],
- "kind": "gan#ccOffers", # The kind for a page of credit card offers.
- }
-
Instance Methods
-
- list(role, roleId, orderId=None, chargeType=None, linkId=None, advertiserId=None, sku=None, pageToken=None, productCategory=None, modifyDateMin=None, type=None, status=None, modifyDateMax=None, eventDateMin=None, maxResults=None, eventDateMax=None, memberId=None, publisherId=None)
-Retrieves event data for a given advertiser/publisher.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
list(role, roleId, orderId=None, chargeType=None, linkId=None, advertiserId=None, sku=None, pageToken=None, productCategory=None, modifyDateMin=None, type=None, status=None, modifyDateMax=None, eventDateMin=None, maxResults=None, eventDateMax=None, memberId=None, publisherId=None)
-
Retrieves event data for a given advertiser/publisher.
-
-Args:
- 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)
- 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.
- pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
- 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.
- modifyDateMin: string, Filters out all events modified earlier than given date. Optional. Defaults to 24 hours before the current modifyDateMax, if modifyDateMax is explicitly set.
- type: string, Filters out all events that are not of the given type. Valid values: 'action', 'transaction', 'charge'. Optional.
- Allowed values
- action - The completion of an application, sign-up, or other process. For example, an action occurs if a user clicks an ad for a credit card and completes an application for that card.
- charge - A charge event is typically a payment between an advertiser, publisher or Google.
- transaction - A conversion event, typically an e-commerce transaction. Some advertisers use a transaction to record other types of events, such as magazine subscriptions.
- status: string, Filters out all events that do not have the given status. Valid values: 'active', 'canceled'. Optional.
- Allowed values
- active - Event is currently active.
- canceled - Event is currently canceled.
- 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.
- 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.
- 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:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
- "items": [ # The event list.
- { # An EventResource.
- "networkFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the Google Affiliate Network.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "advertiserName": "A String", # The name of the advertiser for this event.
- "kind": "gan#event", # The kind for one event.
- "modifyDate": "A String", # The date-time this event was last modified as a RFC 3339 date-time value.
- "type": "A String", # Type of the event (action|transaction|charge).
- "orderId": "A String", # The order ID for this event. Only returned for conversion events.
- "publisherName": "A String", # The name of the publisher for this event.
- "memberId": "A String", # The ID of the member attached to this event. Only returned for conversion events.
- "advertiserId": "A String", # The ID of advertiser for this event.
- "status": "A String", # Status of the event (active|canceled). Only returned for charge and conversion events.
- "chargeId": "A String", # The charge ID for this event. Only returned for charge events.
- "products": [ # Products associated with the event.
- {
- "networkFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the Google Affiliate Network for this product.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "sku": "A String", # Sku of this product.
- "categoryName": "A String", # Name of the category this product belongs to.
- "skuName": "A String", # Sku name of this product.
- "publisherFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the publisehr for this product.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "earnings": { # An ApiMoneyProto. # Amount earned by the publisher on this product.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "unitPrice": { # An ApiMoneyProto. # Price per unit of this product.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "categoryId": "A String", # Id of the category this product belongs to.
- "quantity": "A String", # Quantity of this product bought/exchanged.
- },
- ],
- "earnings": { # An ApiMoneyProto. # Earnings by the publisher.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "chargeType": "A String", # Charge type of the event (other|slotting_fee|monthly_minimum|tier_bonus|debit|credit). Only returned for charge events.
- "publisherFee": { # An ApiMoneyProto. # Fee that the advertiser paid to the publisher.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "commissionableSales": { # An ApiMoneyProto. # Amount of money exchanged during the transaction. Only returned for charge and conversion events.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "publisherId": "A String", # The ID of the publisher for this event.
- "eventDate": "A String", # The date-time this event was initiated as a RFC 3339 date-time value.
- },
- ],
- "kind": "gan#events", # The kind for a page of events.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- advertisers()
-
-Returns the advertisers Resource.
-
-
- ccOffers()
-
-Returns the ccOffers Resource.
-
-
- events()
-
-Returns the events Resource.
-
-
- links()
-
-Returns the links Resource.
-
-
- publishers()
-
-Returns the publishers Resource.
-
-
- reports()
-
-Returns the reports Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/gan_v1beta1.links.html b/docs/dyn/gan_v1beta1.links.html
deleted file mode 100644
index db91bd8..0000000
--- a/docs/dyn/gan_v1beta1.links.html
+++ /dev/null
@@ -1,399 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(role, roleId, linkId)
-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.
-
- insert(role, roleId, body)
-Inserts a new link.
-
- list(role, roleId, linkType=None, promotionType=None, createDateMax=None, advertiserId=None, pageToken=None, relationshipStatus=None, maxResults=None, authorship=None, startDateMin=None, assetSize=None, searchText=None, startDateMax=None, createDateMin=None)
-Retrieves all links that match the query parameters.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(role, roleId, linkId)
-
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:
- 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)
- linkId: string, The ID of the link to look up. (required)
-
-Returns:
- An object of the form:
-
- { # A LinkResource.
- "isActive": True or False, # Flag for if this link is active.
- "linkType": "A String", # The link type.
- "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.
- "specialOffers": { # Special offers on the link.
- "priceCut": { # An ApiMoneyProto. # Price cut on the purchase
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "priceCutMin": { # An ApiMoneyProto. # Minimum purchase amount for price cut promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeShipping": True or False, # Whether there is free shipping
- "promotionCodes": [ # List of promotion code associated with the link
- "A String",
- ],
- "percentOff": 3.14, # Percent off on the purchase
- "percentOffMin": { # An ApiMoneyProto. # Minimum purchase amount for percent off promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeGift": True or False, # Whether there is a free gift
- "freeShippingMin": { # An ApiMoneyProto. # Minimum purchase amount for free shipping promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- },
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "createDate": "A String", # Date that this link was created.
- "imageAltText": "A String", # image alt text.
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "advertiserId": "A String", # The advertiser id for the advertiser who owns this link.
- "id": "A String", # The ID of this link.
- "impressionTrackingUrl": "A String", # Tracking url for impressions.
- "promotionType": "A String", # Promotion Type
- "duration": "A String", # Duration
- "authorship": "A String", # Authorship
- "startDate": "A String", # Date that this link becomes active.
- "availability": "A String", # Availability.
- "clickTrackingUrl": "A String", # Tracking url for clicks.
- "destinationUrl": "A String", # The destination URL for the link.
- }
-
-
insert(role, roleId, body)
-
Inserts a new link.
-
-Args:
- 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)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A LinkResource.
- "isActive": True or False, # Flag for if this link is active.
- "linkType": "A String", # The link type.
- "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.
- "specialOffers": { # Special offers on the link.
- "priceCut": { # An ApiMoneyProto. # Price cut on the purchase
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "priceCutMin": { # An ApiMoneyProto. # Minimum purchase amount for price cut promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeShipping": True or False, # Whether there is free shipping
- "promotionCodes": [ # List of promotion code associated with the link
- "A String",
- ],
- "percentOff": 3.14, # Percent off on the purchase
- "percentOffMin": { # An ApiMoneyProto. # Minimum purchase amount for percent off promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeGift": True or False, # Whether there is a free gift
- "freeShippingMin": { # An ApiMoneyProto. # Minimum purchase amount for free shipping promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- },
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "createDate": "A String", # Date that this link was created.
- "imageAltText": "A String", # image alt text.
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "advertiserId": "A String", # The advertiser id for the advertiser who owns this link.
- "id": "A String", # The ID of this link.
- "impressionTrackingUrl": "A String", # Tracking url for impressions.
- "promotionType": "A String", # Promotion Type
- "duration": "A String", # Duration
- "authorship": "A String", # Authorship
- "startDate": "A String", # Date that this link becomes active.
- "availability": "A String", # Availability.
- "clickTrackingUrl": "A String", # Tracking url for clicks.
- "destinationUrl": "A String", # The destination URL for the link.
- }
-
-
-Returns:
- An object of the form:
-
- { # A LinkResource.
- "isActive": True or False, # Flag for if this link is active.
- "linkType": "A String", # The link type.
- "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.
- "specialOffers": { # Special offers on the link.
- "priceCut": { # An ApiMoneyProto. # Price cut on the purchase
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "priceCutMin": { # An ApiMoneyProto. # Minimum purchase amount for price cut promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeShipping": True or False, # Whether there is free shipping
- "promotionCodes": [ # List of promotion code associated with the link
- "A String",
- ],
- "percentOff": 3.14, # Percent off on the purchase
- "percentOffMin": { # An ApiMoneyProto. # Minimum purchase amount for percent off promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeGift": True or False, # Whether there is a free gift
- "freeShippingMin": { # An ApiMoneyProto. # Minimum purchase amount for free shipping promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- },
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "createDate": "A String", # Date that this link was created.
- "imageAltText": "A String", # image alt text.
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "advertiserId": "A String", # The advertiser id for the advertiser who owns this link.
- "id": "A String", # The ID of this link.
- "impressionTrackingUrl": "A String", # Tracking url for impressions.
- "promotionType": "A String", # Promotion Type
- "duration": "A String", # Duration
- "authorship": "A String", # Authorship
- "startDate": "A String", # Date that this link becomes active.
- "availability": "A String", # Availability.
- "clickTrackingUrl": "A String", # Tracking url for clicks.
- "destinationUrl": "A String", # The destination URL for the link.
- }
-
-
list(role, roleId, linkType=None, promotionType=None, createDateMax=None, advertiserId=None, pageToken=None, relationshipStatus=None, maxResults=None, authorship=None, startDateMin=None, assetSize=None, searchText=None, startDateMax=None, createDateMin=None)
-
Retrieves all links that match the query parameters.
-
-Args:
- 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)
- linkType: string, The type of the link.
- Allowed values
- banner -
- text -
- promotionType: string, The promotion type. (repeated)
- Allowed values
- coupon -
- free_gift -
- free_shipping -
- percent_off -
- price_cut -
- createDateMax: string, The end of the create date range.
- advertiserId: string, Limits the resulting links to the ones belonging to the listed advertisers. (repeated)
- pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
- 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.
- 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)
- searchText: string, Field for full text search across title and merchandising text, supports link id search.
- startDateMax: string, The end of the start date range.
- createDateMin: string, The beginning of the create date range.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The next page token.
- "items": [ # The links.
- { # A LinkResource.
- "isActive": True or False, # Flag for if this link is active.
- "linkType": "A String", # The link type.
- "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.
- "specialOffers": { # Special offers on the link.
- "priceCut": { # An ApiMoneyProto. # Price cut on the purchase
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "priceCutMin": { # An ApiMoneyProto. # Minimum purchase amount for price cut promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeShipping": True or False, # Whether there is free shipping
- "promotionCodes": [ # List of promotion code associated with the link
- "A String",
- ],
- "percentOff": 3.14, # Percent off on the purchase
- "percentOffMin": { # An ApiMoneyProto. # Minimum purchase amount for percent off promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "freeGift": True or False, # Whether there is a free gift
- "freeShippingMin": { # An ApiMoneyProto. # Minimum purchase amount for free shipping promotion
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- },
- "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "createDate": "A String", # Date that this link was created.
- "imageAltText": "A String", # image alt text.
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months on this link. This value should be multiplied by 100 at the time of display.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "advertiserId": "A String", # The advertiser id for the advertiser who owns this link.
- "id": "A String", # The ID of this link.
- "impressionTrackingUrl": "A String", # Tracking url for impressions.
- "promotionType": "A String", # Promotion Type
- "duration": "A String", # Duration
- "authorship": "A String", # Authorship
- "startDate": "A String", # Date that this link becomes active.
- "availability": "A String", # Availability.
- "clickTrackingUrl": "A String", # Tracking url for clicks.
- "destinationUrl": "A String", # The destination URL for the link.
- },
- ],
- "kind": "gan#links", # The kind for a page of links.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(role, roleId, publisherId=None)
-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.
-
- list(role, roleId, publisherCategory=None, relationshipStatus=None, pageToken=None, minSevenDayEpc=None, minNinetyDayEpc=None, maxResults=None, minPayoutRank=None)
-Retrieves data about all publishers that the requesting advertiser/publisher has access to.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(role, roleId, publisherId=None)
-
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:
- 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)
- publisherId: string, The ID of the publisher to look up. Optional.
-
-Returns:
- An object of the form:
-
- { # A PublisherResource.
- "status": "A String", # The status of the requesting advertiser's relationship with this 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.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "payoutRank": "A String", # A rank based on commissions paid to this publisher over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid).
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher divided by the total number of clicks over the past three months. Values are multiplied by 100 for display purposes.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "item": # Object with schema name: Publisher # The requested publisher.
- "joinDate": "A String", # Date that this publisher was approved as a Google Affiliate Network publisher.
- "sites": [ # Websites that this publisher uses to advertise.
- "A String",
- ],
- "id": "A String", # The ID of this publisher.
- }
-
-
list(role, roleId, publisherCategory=None, relationshipStatus=None, pageToken=None, minSevenDayEpc=None, minNinetyDayEpc=None, maxResults=None, minPayoutRank=None)
-
Retrieves data about all publishers that the requesting advertiser/publisher has access to.
-
-Args:
- 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)
- publisherCategory: string, Caret(^) delimted list of publisher categories. Valid categories: (unclassified|community_and_content|shopping_and_promotion|loyalty_and_rewards|network|search_specialist|comparison_shopping|email). Filters out all publishers not in one of the given advertiser categories. Optional.
- relationshipStatus: string, Filters out all publishers for which do not have the given relationship status with the requesting publisher.
- Allowed values
- approved - Publishers you've approved to your program.
- available - Publishers available for you to recruit.
- 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.
- 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.
- minNinetyDayEpc: number, Filters out all publishers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
- maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.
- 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:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
- "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 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.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "payoutRank": "A String", # A rank based on commissions paid to this publisher over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid).
- "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher divided by the total number of clicks over the past three months. Values are multiplied by 100 for display purposes.
- "amount": 3.14, # The amount of money.
- "currencyCode": "A String", # The 3-letter code of the currency in question.
- },
- "item": # Object with schema name: Publisher # The requested publisher.
- "joinDate": "A String", # Date that this publisher was approved as a Google Affiliate Network publisher.
- "sites": [ # Websites that this publisher uses to advertise.
- "A String",
- ],
- "id": "A String", # The ID of this publisher.
- },
- ],
- "kind": "gan#publishers", # The kind for a page of entities.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(role, roleId, reportType, startDate=None, endDate=None, eventType=None, advertiserId=None, startIndex=None, calculateTotals=None, linkId=None, orderId=None, maxResults=None, status=None, publisherId=None)
-Retrieves a report of the specified type.
-Method Details
-
-
get(role, roleId, reportType, startDate=None, endDate=None, eventType=None, advertiserId=None, startIndex=None, calculateTotals=None, linkId=None, orderId=None, maxResults=None, status=None, publisherId=None)
-
Retrieves a report of the specified type.
-
-Args:
- 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)
- reportType: string, The type of report being requested. Valid values: 'order_delta'. Required. (required)
- Allowed values
- order_delta - The order delta report type.
- startDate: string, The start date (inclusive), in RFC 3339 format, for the report data to be returned. Defaults to one day before endDate, if that is given, or yesterday. Optional.
- endDate: string, The end date (exclusive), in RFC 3339 format, for the report data to be returned. Defaults to one day after startDate, if that is given, or today. Optional.
- eventType: string, Filters out all events that are not of the given type. Valid values: 'action', 'transaction', or 'charge'. Optional.
- Allowed values
- action - Event type is action.
- charge - Event type is charge.
- transaction - Event type is transaction.
- advertiserId: string, The IDs of the advertisers to look up, if applicable. (repeated)
- startIndex: integer, Offset on which to return results when paging. Optional.
- calculateTotals: boolean, Whether or not to calculate totals rows. Optional.
- linkId: string, Filters to capture one of given link IDs. Optional. (repeated)
- orderId: string, Filters to capture one of the given order IDs. Optional. (repeated)
- maxResults: integer, Max number of items to return in this page. Optional. Defaults to return all results.
- status: string, Filters out all events that do not have the given status. Valid values: 'active', 'canceled', or 'invalid'. Optional.
- Allowed values
- active - Event is currently active.
- canceled - Event is currently canceled.
- invalid - Event is currently invalid.
- publisherId: string, The IDs of the publishers to look up, if applicable. (repeated)
-
-Returns:
- An object of the form:
-
- { # A ReportResource representing a report of a certain type either for an advertiser or publisher.
- "totals_rows": [ # The totals rows for the report
- [ # Loop over each column in the row.
- "",
- ],
- ],
- "kind": "gan#report", # The kind for a report.
- "rows": [ # The rows of data for the report
- [ # Loop over each column in the row.
- "",
- ],
- ],
- "end_date": "A String", # The end of the date range for this report, exclusive.
- "matching_row_count": "A String", # The number of matching rows before paging is applied.
- "column_names": [ # The column names for the report
- "A String",
- ],
- "type": "A String", # The report type.
- "start_date": "A String", # The start of the date range for this report, inclusive.
- }
-
Instance Methods
-
- insert(groupId, media_body=None)
-Inserts a new mail into the archive of the Google group.
-Method Details
-
-
insert(groupId, media_body=None)
-
Inserts a new mail into the archive of the Google group.
-
-Args:
- groupId: string, The group ID (required)
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
-
-Returns:
- An object of the form:
-
- { # JSON response template for groups migration API.
- "kind": "groupsmigration#groups", # The kind of insert resource this is.
- "responseCode": "A String", # The status of the insert request.
- }
-
Instance Methods
-
- archive()
-
-Returns the archive Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/groupssettings_v1.groups.html b/docs/dyn/groupssettings_v1.groups.html
deleted file mode 100644
index b816e79..0000000
--- a/docs/dyn/groupssettings_v1.groups.html
+++ /dev/null
@@ -1,271 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(groupUniqueId)
-Gets one resource by id.
-
- patch(groupUniqueId, body)
-Updates an existing resource. This method supports patch semantics.
-
- update(groupUniqueId, body)
-Updates an existing resource.
-Method Details
-
-
get(groupUniqueId)
-
Gets one resource by id.
-
-Args:
- groupUniqueId: string, The resource ID (required)
-
-Returns:
- An object of the form:
-
- { # JSON template for Group resource
- "allowExternalMembers": "A String", # Are external members allowed to join the group.
- "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST
- "primaryLanguage": "A String", # Primary language for the group.
- "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
- "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
- "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
- "archiveOnly": "A String", # If the group is archive only
- "isArchived": "A String", # If the contents of the group are archived.
- "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
- "allowWebPosting": "A String", # If posting from web is allowed.
- "email": "A String", # Email id of the group
- "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
- "description": "A String", # Description of the group
- "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS
- "customReplyTo": "A String", # Default email to which reply to any message should go.
- "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
- "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
- "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN
- "name": "A String", # Name of the Group
- "kind": "groupsSettings#groups", # The type of the resource.
- "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
- "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
- "whoCanViewGroup": "A String", # Permissions to view group. Possbile values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
- "showInGroupDirectory": "A String", # Is the group listed in groups directory
- "maxMessageBytes": 42, # Maximum message size allowed.
- "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
- }
-
-
patch(groupUniqueId, body)
-
Updates an existing resource. This method supports patch semantics.
-
-Args:
- groupUniqueId: string, The resource ID (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # JSON template for Group resource
- "allowExternalMembers": "A String", # Are external members allowed to join the group.
- "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST
- "primaryLanguage": "A String", # Primary language for the group.
- "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
- "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
- "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
- "archiveOnly": "A String", # If the group is archive only
- "isArchived": "A String", # If the contents of the group are archived.
- "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
- "allowWebPosting": "A String", # If posting from web is allowed.
- "email": "A String", # Email id of the group
- "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
- "description": "A String", # Description of the group
- "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS
- "customReplyTo": "A String", # Default email to which reply to any message should go.
- "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
- "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
- "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN
- "name": "A String", # Name of the Group
- "kind": "groupsSettings#groups", # The type of the resource.
- "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
- "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
- "whoCanViewGroup": "A String", # Permissions to view group. Possbile values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
- "showInGroupDirectory": "A String", # Is the group listed in groups directory
- "maxMessageBytes": 42, # Maximum message size allowed.
- "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
- }
-
-
-Returns:
- An object of the form:
-
- { # JSON template for Group resource
- "allowExternalMembers": "A String", # Are external members allowed to join the group.
- "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST
- "primaryLanguage": "A String", # Primary language for the group.
- "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
- "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
- "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
- "archiveOnly": "A String", # If the group is archive only
- "isArchived": "A String", # If the contents of the group are archived.
- "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
- "allowWebPosting": "A String", # If posting from web is allowed.
- "email": "A String", # Email id of the group
- "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
- "description": "A String", # Description of the group
- "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS
- "customReplyTo": "A String", # Default email to which reply to any message should go.
- "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
- "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
- "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN
- "name": "A String", # Name of the Group
- "kind": "groupsSettings#groups", # The type of the resource.
- "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
- "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
- "whoCanViewGroup": "A String", # Permissions to view group. Possbile values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
- "showInGroupDirectory": "A String", # Is the group listed in groups directory
- "maxMessageBytes": 42, # Maximum message size allowed.
- "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
- }
-
-
update(groupUniqueId, body)
-
Updates an existing resource.
-
-Args:
- groupUniqueId: string, The resource ID (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # JSON template for Group resource
- "allowExternalMembers": "A String", # Are external members allowed to join the group.
- "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST
- "primaryLanguage": "A String", # Primary language for the group.
- "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
- "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
- "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
- "archiveOnly": "A String", # If the group is archive only
- "isArchived": "A String", # If the contents of the group are archived.
- "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
- "allowWebPosting": "A String", # If posting from web is allowed.
- "email": "A String", # Email id of the group
- "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
- "description": "A String", # Description of the group
- "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS
- "customReplyTo": "A String", # Default email to which reply to any message should go.
- "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
- "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
- "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN
- "name": "A String", # Name of the Group
- "kind": "groupsSettings#groups", # The type of the resource.
- "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
- "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
- "whoCanViewGroup": "A String", # Permissions to view group. Possbile values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
- "showInGroupDirectory": "A String", # Is the group listed in groups directory
- "maxMessageBytes": 42, # Maximum message size allowed.
- "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
- }
-
-
-Returns:
- An object of the form:
-
- { # JSON template for Group resource
- "allowExternalMembers": "A String", # Are external members allowed to join the group.
- "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST
- "primaryLanguage": "A String", # Primary language for the group.
- "whoCanViewMembership": "A String", # Permissions to view membership. Possbile values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
- "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
- "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
- "archiveOnly": "A String", # If the group is archive only
- "isArchived": "A String", # If the contents of the group are archived.
- "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
- "allowWebPosting": "A String", # If posting from web is allowed.
- "email": "A String", # Email id of the group
- "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
- "description": "A String", # Description of the group
- "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS
- "customReplyTo": "A String", # Default email to which reply to any message should go.
- "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
- "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
- "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN
- "name": "A String", # Name of the Group
- "kind": "groupsSettings#groups", # The type of the resource.
- "whoCanInvite": "A String", # Permissions to invite members. Possbile values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE
- "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
- "whoCanViewGroup": "A String", # Permissions to view group. Possbile values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
- "showInGroupDirectory": "A String", # Is the group listed in groups directory
- "maxMessageBytes": 42, # Maximum message size allowed.
- "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
- }
-
Instance Methods
-
- groups()
-
-Returns the groups Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/identitytoolkit_v3.html b/docs/dyn/identitytoolkit_v3.html
deleted file mode 100644
index 5922397..0000000
--- a/docs/dyn/identitytoolkit_v3.html
+++ /dev/null
@@ -1,82 +0,0 @@
-
-
-
-
-Instance Methods
-
- relyingparty()
-
-Returns the relyingparty Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/identitytoolkit_v3.relyingparty.html b/docs/dyn/identitytoolkit_v3.relyingparty.html
deleted file mode 100644
index 45f8db6..0000000
--- a/docs/dyn/identitytoolkit_v3.relyingparty.html
+++ /dev/null
@@ -1,412 +0,0 @@
-
-
-
-
-Instance Methods
-
- createAuthUri(body)
-Creates the URI used by the IdP to authenticate the user.
-
- deleteAccount(body)
-Delete user account.
-
- getAccountInfo(body)
-Returns the account info.
-
- getOobConfirmationCode(body)
-Get a code for user action confirmation.
-
- resetPassword(body)
-Set account info for a user.
-
- setAccountInfo(body)
-Set account info for a user.
-
- uploadAccount(body)
-Batch upload existing user accounts.
-
- verifyAssertion(body)
-Verifies the assertion returned by the IdP.
-
- verifyPassword(body)
-Verifies the user entered password.
-Method Details
-
-
createAuthUri(body)
-
Creates the URI used by the IdP to authenticate the user.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Request to get the IDP authentication URL.
- "openidRealm": "A String", # Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set.
- "clientId": "A String", # The relying party OAuth client ID.
- "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
- "context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
- "continueUri": "A String", # The URI to which the IDP redirects the user after the federated login flow.
- "identifier": "A String", # The email or federated ID of the user.
- }
-
-
-Returns:
- An object of the form:
-
- { # Response of creating the IDP authentication URL.
- "kind": "identitytoolkit#CreateAuthUriResponse", # The fixed string identitytoolkit#CreateAuthUriResponse".
- "providers": [ # Existing IDP's for the user.
- "A String",
- ],
- "registered": True or False, # Whether the user is registered if the identifier is an email.
- "authUri": "A String", # The URI used by the IDP to authenticate the user.
- }
-
-
deleteAccount(body)
-
Delete user account.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Request to delete account.
- "localId": "A String", # The local ID of the user.
- }
-
-
-Returns:
- An object of the form:
-
- { # Respone of deleting account.
- "kind": "identitytoolkit#DeleteAccountResponse", # The fixed string "identitytoolkit#DeleteAccountResponse".
- }
-
-
getAccountInfo(body)
-
Returns the account info.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Request to get the account information.
- "idToken": "A String", # The GITKit token of the authenticated user.
- "email": [ # The list of emails of the users to inquiry.
- "A String",
- ],
- "localId": [ # The list of local ID's of the users to inquiry.
- "A String",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- { # Response of getting account information.
- "kind": "identitytoolkit#GetAccountInfoResponse", # The fixed string "identitytoolkit#GetAccountInfoResponse".
- "users": [ # The info of the users.
- {
- "displayName": "A String", # The name of the user.
- "localId": "A String", # The local ID of the user.
- "language": "A String", # The language of the user.
- "photoUrl": "A String", # The URL of the user profile photo.
- "dateOfBirth": "A String", # The user's date of birth.
- "version": 42, # Version of the user's password.
- "providerUserInfo": [ # The IDP of the user.
- {
- "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
- "displayName": "A String", # The user's display name at the IDP.
- "photoUrl": "A String", # The user's photo url at the IDP.
- },
- ],
- "timeZone": "A String", # The time zone of the user.
- "passwordUpdatedAt": "A String", # The timestamp when the password was last updated.
- "password": "A String", # The user's hashed password.
- "salt": "A String", # The user's password salt.
- "email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
- },
- ],
- }
-
-
getOobConfirmationCode(body)
-
Get a code for user action confirmation.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Request of getting a code for user confirmation (reset password, change email etc.)
- "kind": "identitytoolkit#relyingparty", # The fixed string "identitytoolkit#relyingparty".
- "requestType": "A String", # The request type.
- "idToken": "A String", # The user's Gitkit login token for email change.
- "challenge": "A String", # The recaptcha challenge presented to the user.
- "newEmail": "A String", # The new email if the code is for email change.
- "userIp": "A String", # The IP address of the user.
- "email": "A String", # The email of the user.
- "captchaResp": "A String", # The recaptcha response from the user.
- }
-
-
-Returns:
- An object of the form:
-
- { # Response of getting a code for user confirmation (reset password, change email etc.).
- "kind": "identitytoolkit#GetOobConfirmationCodeResponse", # The fixed string "identitytoolkit#GetOobConfirmationCodeResponse".
- "oobCode": "A String", # The code to be send to the user.
- }
-
-
resetPassword(body)
-
Set account info for a user.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Request to reset the password.
- "newPassword": "A String", # The new password inputted by the user.
- "oldPassword": "A String", # The old password inputted by the user.
- "oobCode": "A String", # The confirmation code.
- "email": "A String", # The email address of the user.
- }
-
-
-Returns:
- An object of the form:
-
- { # Response of resetting the password.
- "kind": "identitytoolkit#ResetPasswordResponse", # The fixed string "identitytoolkit#ResetPasswordResponse".
- "email": "A String", # The user's email.
- }
-
-
setAccountInfo(body)
-
Set account info for a user.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Request to set the account information.
- "oobCode": "A String", # The out-of-band code of the change email request.
- "localId": "A String", # The local ID of the user.
- "upgradeToFederatedLogin": True or False, # Mark the user to upgrade to federated login.
- "emailVerified": True or False, # Mark the email as verified or not.
- "provider": [ # The associated IDPs of the user.
- "A String",
- ],
- "idToken": "A String", # The GITKit token of the authenticated user.
- "displayName": "A String", # The name of the user.
- "password": "A String", # The new password of the user.
- "email": "A String", # The email of the user.
- }
-
-
-Returns:
- An object of the form:
-
- { # Respone of setting the account information.
- "kind": "identitytoolkit#SetAccountInfoResponse", # The fixed string "identitytoolkit#SetAccountInfoResponse".
- "displayName": "A String", # The name of the user.
- "email": "A String", # The email of the user.
- "provider": [ # The associated IDPs of the user.
- "A String",
- ],
- }
-
-
uploadAccount(body)
-
Batch upload existing user accounts.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Request to upload user account in batch.
- "hashAlgorithm": "A String",
- "signerKey": "A String",
- "memoryCost": 42,
- "saltSeparator": "A String",
- "userAccount": [ # The account info to be stored.
- { # Template for an individual account info.
- "kind": "identitytoolkit#userinfo", # Identifies this object as a user info.
- "password": "A String", # password
- "salt": "A String", # salt
- "email": "A String", # email
- "localId": "A String", # user's id at the site
- },
- ],
- "rounds": 42,
- }
-
-
-Returns:
- An object of the form:
-
- { # Respone of uploading accounts in batch.
- "kind": "identitytoolkit#UploadAccountResponse", # The fixed string "identitytoolkit#UploadAccountResponse".
- "error": [ # The error encountered while processing the account info.
- {
- "index": 42, # The index of the malformed account, starting from 0.
- "message": "A String", # Detailed error message for the account info.
- },
- ],
- }
-
-
verifyAssertion(body)
-
Verifies the assertion returned by the IdP.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Request to verify the IDP assertion.
- "requestUri": "A String", # The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP.
- "postBody": "A String", # The post body if the request is a HTTP POST.
- "pendingIdToken": "A String", # The GITKit token for the non-trusted IDP pending to be confirmed by the user.
- }
-
-
-Returns:
- An object of the form:
-
- { # Response of verifying the IDP assertion.
- "federatedId": "A String", # The unique ID identifies the IdP account.
- "localId": "A String", # The RP local ID if it's already been mapped to the IdP account identified by the federated ID.
- "photoUrl": "A String", # The URI of the public accessible profiel picture.
- "inputEmail": "A String", # It's the identifier param in the createAuthUri request if the identifier is an email. It can be used to check whether the user input email is different from the asserted email.
- "verifiedProvider": [ # When action is 'map', contains the idps which can be used for confirmation.
- "A String",
- ],
- "originalEmail": "A String", # The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email.
- "dateOfBirth": "A String", # The birth date of the IdP account.
- "nickName": "A String", # The nick name of the user.
- "email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
- "idToken": "A String", # The ID token.
- "fullName": "A String", # The full name of the user.
- "kind": "identitytoolkit#VerifyAssertionResponse", # The fixed string "identitytoolkit#VerifyAssertionResponse".
- "displayName": "A String", # The display name of the user.
- "firstName": "A String", # The first name of the user.
- "language": "A String", # The language preference of the user.
- "emailVerified": True or False, # The value is true if the IDP is also the email provider. It means the user owns the email.
- "oauthScope": "A String", # The scope for the OpenID OAuth extension.
- "oauthRequestToken": "A String", # The user approved request token for the OpenID OAuth extension.
- "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. If the "providerId" param is set to OpenID OP identifer other than the whilte listed IdPs the OP identifier is returned. If the "identifier" param is federated ID in the createAuthUri request. The domain part of the federated ID is returned.
- "context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
- "lastName": "A String", # The last name of the user.
- "action": "A String", # The action code.
- "timeZone": "A String", # The timezone of the user.
- "emailRecycled": True or False, # It's true if the email is recycled.
- }
-
-
verifyPassword(body)
-
Verifies the user entered password.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Request to verify the password.
- "password": "A String", # The password inputed by the user.
- "email": "A String", # The email of the user.
- "pendingIdToken": "A String", # The GITKit token for the non-trusted IDP, which is to be confirmed by the user.
- }
-
-
-Returns:
- An object of the form:
-
- { # Request of verifying the password.
- "kind": "identitytoolkit#VerifyPasswordResponse", # The fixed string "identitytoolkit#VerifyPasswordResponse".
- "displayName": "A String", # The name of the user.
- "localId": "A String", # The RP local ID if it's already been mapped to the IdP account identified by the federated ID.
- "idToken": "A String", # The GITKit token for authenticated user.
- "registered": True or False, # Whether the email is registered.
- "email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
- }
-
Instance Methods
-
- delete()
-Deletes the authenticated user's current location.
-
- get(granularity=None)
-Returns the authenticated user's current location.
-
- insert(body)
-Updates or creates the user's current location.
-Method Details
-
-
delete()
-
Deletes the authenticated user's current location.
-
-Args:
-
-
-
get(granularity=None)
-
Returns the authenticated user's current location.
-
-Args:
- granularity: string, Granularity of the requested location.
- Allowed values
- best - Request best available granularity.
- city - Request city-level granularty.
-
-Returns:
- An object of the form:
-
- { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
- "kind": "latitude#location", # Kind of this item.
- "altitude": "", # Altitude of the location, in meters. Optional.
- "longitude": "", # Longitude of the location, in decimal degrees.
- "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
- "latitude": "", # Latitude of the location, in decimal degrees.
- "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
- "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
- "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
- "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
- "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
- }
-
-
insert(body)
-
Updates or creates the user's current location.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
- "kind": "latitude#location", # Kind of this item.
- "altitude": "", # Altitude of the location, in meters. Optional.
- "longitude": "", # Longitude of the location, in decimal degrees.
- "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
- "latitude": "", # Latitude of the location, in decimal degrees.
- "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
- "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
- "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
- "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
- "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
- }
-
-
-Returns:
- An object of the form:
-
- { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
- "kind": "latitude#location", # Kind of this item.
- "altitude": "", # Altitude of the location, in meters. Optional.
- "longitude": "", # Longitude of the location, in decimal degrees.
- "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
- "latitude": "", # Latitude of the location, in decimal degrees.
- "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
- "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
- "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
- "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
- "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
- }
-
Instance Methods
-
- currentLocation()
-
-Returns the currentLocation Resource.
-
-
- location()
-
-Returns the location Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/latitude_v1.location.html b/docs/dyn/latitude_v1.location.html
deleted file mode 100644
index ca84101..0000000
--- a/docs/dyn/latitude_v1.location.html
+++ /dev/null
@@ -1,201 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(locationId)
-Deletes a location from the user's location history.
-
- get(locationId, granularity=None)
-Reads a location from the user's location history.
-
- insert(body)
-Inserts or updates a location in the user's location history.
-
- list(min_time=None, max_results=None, granularity=None, max_time=None)
-Lists the user's location history.
-Method Details
-
-
delete(locationId)
-
Deletes a location from the user's location history.
-
-Args:
- locationId: string, Timestamp of the location to delete (ms since epoch). (required)
-
-
-
get(locationId, granularity=None)
-
Reads a location from the user's location history.
-
-Args:
- 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.
-
-Returns:
- An object of the form:
-
- { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
- "kind": "latitude#location", # Kind of this item.
- "altitude": "", # Altitude of the location, in meters. Optional.
- "longitude": "", # Longitude of the location, in decimal degrees.
- "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
- "latitude": "", # Latitude of the location, in decimal degrees.
- "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
- "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
- "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
- "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
- "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
- }
-
-
insert(body)
-
Inserts or updates a location in the user's location history.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
- "kind": "latitude#location", # Kind of this item.
- "altitude": "", # Altitude of the location, in meters. Optional.
- "longitude": "", # Longitude of the location, in decimal degrees.
- "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
- "latitude": "", # Latitude of the location, in decimal degrees.
- "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
- "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
- "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
- "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
- "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
-}
-
-
-Returns:
- An object of the form:
-
- { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
- "kind": "latitude#location", # Kind of this item.
- "altitude": "", # Altitude of the location, in meters. Optional.
- "longitude": "", # Longitude of the location, in decimal degrees.
- "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
- "latitude": "", # Latitude of the location, in decimal degrees.
- "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
- "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
- "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
- "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
- "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
- }
-
-
list(min_time=None, max_results=None, granularity=None, max_time=None)
-
Lists the user's location history.
-
-Args:
- min_time: string, Minimum timestamp of locations to return (ms since epoch).
- max_results: string, Maximum number of locations to return.
- 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:
-
- {
- "items": [
- { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.
- "kind": "latitude#location", # Kind of this item.
- "altitude": "", # Altitude of the location, in meters. Optional.
- "longitude": "", # Longitude of the location, in decimal degrees.
- "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
- "latitude": "", # Latitude of the location, in decimal degrees.
- "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
- "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
- "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
- "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
- "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
- },
- ],
- "kind": "latitude#locationFeed",
- }
-
Instance Methods
-
- licenseAssignments()
-
-Returns the licenseAssignments Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/licensing_v1.licenseAssignments.html b/docs/dyn/licensing_v1.licenseAssignments.html
deleted file mode 100644
index c0df2a5..0000000
--- a/docs/dyn/licensing_v1.licenseAssignments.html
+++ /dev/null
@@ -1,323 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(productId, skuId, userId)
-Revoke License.
-
- get(productId, skuId, userId)
-Get license assignment of a particular product and sku for a user
-
- insert(productId, skuId, body)
-Assign License.
-
- listForProduct(productId, customerId, pageToken=None, maxResults=None)
-List license assignments for given product of the customer.
-
- listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)
-List license assignments for given product and sku of the customer.
-
- listForProductAndSku_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- listForProduct_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(productId, skuId, userId, body)
-Assign License. This method supports patch semantics.
-
- update(productId, skuId, userId, body)
-Assign License.
-Method Details
-
-
delete(productId, skuId, userId)
-
Revoke License.
-
-Args:
- productId: string, Name for product (required)
- skuId: string, Name for sku (required)
- userId: string, email id or unique Id of the user (required)
-
-
-
get(productId, skuId, userId)
-
Get license assignment of a particular product and sku for a user
-
-Args:
- productId: string, Name for product (required)
- skuId: string, Name for sku (required)
- userId: string, email id or unique Id of the user (required)
-
-Returns:
- An object of the form:
-
- { # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # Email id of the user.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
- }
-
-
insert(productId, skuId, body)
-
Assign License.
-
-Args:
- productId: string, Name for product (required)
- skuId: string, Name for sku (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Template for LicenseAssignment Insert request
- "userId": "A String", # Email id of the user
- }
-
-
-Returns:
- An object of the form:
-
- { # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # Email id of the user.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
- }
-
-
listForProduct(productId, customerId, pageToken=None, maxResults=None)
-
List license assignments for given product of the customer.
-
-Args:
- productId: string, Name for product (required)
- customerId: string, CustomerId represents the customer for whom licenseassignments are queried (required)
- pageToken: string, Token to fetch the next page.Optional. By default server will return first page
- maxResults: integer, Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
-
-Returns:
- An object of the form:
-
- { # LicesnseAssignment List for a given product/sku for a customer.
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "items": [ # The LicenseAssignments in this page of results.
- { # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # Email id of the user.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
- },
- ],
- "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
- "etag": "A String", # ETag of the resource.
- }
-
-
listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)
-
List license assignments for given product and sku of the customer.
-
-Args:
- productId: string, Name for product (required)
- skuId: string, Name for sku (required)
- customerId: string, CustomerId represents the customer for whom licenseassignments are queried (required)
- pageToken: string, Token to fetch the next page.Optional. By default server will return first page
- maxResults: integer, Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.
-
-Returns:
- An object of the form:
-
- { # LicesnseAssignment List for a given product/sku for a customer.
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "items": [ # The LicenseAssignments in this page of results.
- { # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # Email id of the user.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
- },
- ],
- "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
- "etag": "A String", # ETag of the resource.
- }
-
-
listForProductAndSku_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
listForProduct_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(productId, skuId, userId, body)
-
Assign License. This method supports patch semantics.
-
-Args:
- productId: string, Name for product (required)
- skuId: string, Name for sku for which license would be revoked (required)
- userId: string, email id or unique Id of the user (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # Email id of the user.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
-}
-
-
-Returns:
- An object of the form:
-
- { # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # Email id of the user.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
- }
-
-
update(productId, skuId, userId, body)
-
Assign License.
-
-Args:
- productId: string, Name for product (required)
- skuId: string, Name for sku for which license would be revoked (required)
- userId: string, email id or unique Id of the user (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # Email id of the user.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
-}
-
-
-Returns:
- An object of the form:
-
- { # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
- "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
- "userId": "A String", # Email id of the user.
- "etags": "A String", # ETag of the resource.
- "selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
- }
-
Instance Methods
-
- delete(id)
-Deletes a contact.
-
- get(id)
-Gets a single contact by ID.
-
- insert(body)
-Inserts a new contact.
-
- list()
-Retrieves a list of contacts for the authenticated user.
-
- patch(id, body)
-Updates a contact in place. This method supports patch semantics.
-
- update(id, body)
-Updates a contact in place.
-Method Details
-
-
delete(id)
-
Deletes a contact.
-
-Args:
- id: string, The ID of the contact. (required)
-
-
-
get(id)
-
Gets a single contact by ID.
-
-Args:
- id: string, The ID of the contact. (required)
-
-Returns:
- An object of the form:
-
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- }
-
-
insert(body)
-
Inserts a new contact.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- }
-
-
-Returns:
- An object of the form:
-
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- }
-
-
list()
-
Retrieves a list of contacts for the authenticated user.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # A list of Contacts representing contacts. This is the response from the server to GET requests on the contacts collection.
- "items": [ # Contact list.
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- ],
- "kind": "mirror#contacts", # The type of resource. This is always mirror#contacts.
- }
-
-
patch(id, body)
-
Updates a contact in place. This method supports patch semantics.
-
-Args:
- id: string, The ID of the contact. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- }
-
-
-Returns:
- An object of the form:
-
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- }
-
-
update(id, body)
-
Updates a contact in place.
-
-Args:
- id: string, The ID of the contact. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- }
-
-
-Returns:
- An object of the form:
-
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- }
-
Instance Methods
-
- contacts()
-
-Returns the contacts Resource.
-
-
- locations()
-
-Returns the locations Resource.
-
-
- subscriptions()
-
-Returns the subscriptions Resource.
-
-
- timeline()
-
-Returns the timeline Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/mirror_v1.locations.html b/docs/dyn/mirror_v1.locations.html
deleted file mode 100644
index f43929e..0000000
--- a/docs/dyn/mirror_v1.locations.html
+++ /dev/null
@@ -1,132 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(id)
-Gets a single location by ID.
-
- list()
-Retrieves a list of locations for the user.
-Method Details
-
-
get(id)
-
Gets a single location by ID.
-
-Args:
- id: string, The ID of the location or latest for the last known location. (required)
-
-Returns:
- An object of the form:
-
- { # A geographic location that can be associated with a timeline item.
- "kind": "mirror#location", # The type of resource. This is always mirror#location.
- "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home".
- "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339.
- "longitude": 3.14, # The longitude, in degrees.
- "address": "A String", # The full address of the location.
- "latitude": 3.14, # The latitude, in degrees.
- "id": "A String", # The ID of the location.
- "accuracy": 3.14, # The accuracy of the location fix in meters.
- }
-
-
list()
-
Retrieves a list of locations for the user.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # A list of Locations. This is the response from the server to GET requests on the locations collection.
- "items": [ # The list of locations.
- { # A geographic location that can be associated with a timeline item.
- "kind": "mirror#location", # The type of resource. This is always mirror#location.
- "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home".
- "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339.
- "longitude": 3.14, # The longitude, in degrees.
- "address": "A String", # The full address of the location.
- "latitude": 3.14, # The latitude, in degrees.
- "id": "A String", # The ID of the location.
- "accuracy": 3.14, # The accuracy of the location fix in meters.
- },
- ],
- "kind": "mirror#locationsList", # The type of resource. This is always mirror#locationsList.
- }
-
Instance Methods
-
- delete(id)
-Deletes a subscription.
-
- insert(body)
-Creates a new subscription.
-
- list()
-Retrieves a list of subscriptions for the authenticated user and service.
-
- update(id, body)
-Updates an existing subscription in place.
-Method Details
-
-
delete(id)
-
Deletes a subscription.
-
-Args:
- id: string, The ID of the subscription. (required)
-
-
-
insert(body)
-
Creates a new subscription.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A subscription to events on a collection.
- "kind": "mirror#subscription", # The type of resource. This is always mirror#subscription.
- "notification": { # A notification delivered by the API. # Container object for notifications. This is not populated in the Subscription resource.
- "itemId": "A String", # The ID of the item that generated the notification.
- "collection": "A String", # The collection that generated the notification.
- "verifyToken": "A String", # The secret verify token provided by the service when it subscribed for notifications.
- "userToken": "A String", # The user token provided by the service when it subscribed for notifications.
- "userActions": [ # A list of actions taken by the user that triggered the notification.
- { # Represents an action taken by the user that triggered a notification.
- "type": "A String", # The type of action. The value of this can be:
- # - SHARE - the user shared an item.
- # - REPLY - the user replied to an item.
- # - REPLY_ALL - the user replied to all recipients of an item.
- # - CUSTOM - the user selected a custom menu item on the timeline item.
- # - DELETE - the user deleted the item.
- # - PIN - the user pinned the item.
- # - UNPIN - the user unpinned the item. In the future, additional types may be added. UserActions with unrecognized types should be ignored.
- "payload": "A String", # An optional payload for the action.
- #
- # For actions of type CUSTOM, this is the ID of the custom menu item that was selected.
- },
- ],
- "operation": "A String", # The type of operation that generated the notification.
- },
- "updated": "A String", # The time at which this subscription was last modified, formatted according to RFC 3339.
- "collection": "A String", # The collection to subscribe to. Allowed values are:
- # - timeline - Changes in the timeline including insertion, deletion, and updates.
- # - locations - Location updates.
- "verifyToken": "A String", # A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google.
- "userToken": "A String", # An opaque token sent to the subscriber in notifications so that it can determine the ID of the user.
- "operation": [ # A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are:
- # - UPDATE - The item has been updated.
- # - INSERT - A new item has been inserted.
- # - DELETE - The item has been deleted.
- # - MENU_ACTION - A custom menu item has been triggered by the user.
- "A String",
- ],
- "id": "A String", # The ID of the subscription.
- "callbackUrl": "A String", # The URL where notifications should be delivered (must start with https://).
- }
-
-
-Returns:
- An object of the form:
-
- { # A subscription to events on a collection.
- "kind": "mirror#subscription", # The type of resource. This is always mirror#subscription.
- "notification": { # A notification delivered by the API. # Container object for notifications. This is not populated in the Subscription resource.
- "itemId": "A String", # The ID of the item that generated the notification.
- "collection": "A String", # The collection that generated the notification.
- "verifyToken": "A String", # The secret verify token provided by the service when it subscribed for notifications.
- "userToken": "A String", # The user token provided by the service when it subscribed for notifications.
- "userActions": [ # A list of actions taken by the user that triggered the notification.
- { # Represents an action taken by the user that triggered a notification.
- "type": "A String", # The type of action. The value of this can be:
- # - SHARE - the user shared an item.
- # - REPLY - the user replied to an item.
- # - REPLY_ALL - the user replied to all recipients of an item.
- # - CUSTOM - the user selected a custom menu item on the timeline item.
- # - DELETE - the user deleted the item.
- # - PIN - the user pinned the item.
- # - UNPIN - the user unpinned the item. In the future, additional types may be added. UserActions with unrecognized types should be ignored.
- "payload": "A String", # An optional payload for the action.
- #
- # For actions of type CUSTOM, this is the ID of the custom menu item that was selected.
- },
- ],
- "operation": "A String", # The type of operation that generated the notification.
- },
- "updated": "A String", # The time at which this subscription was last modified, formatted according to RFC 3339.
- "collection": "A String", # The collection to subscribe to. Allowed values are:
- # - timeline - Changes in the timeline including insertion, deletion, and updates.
- # - locations - Location updates.
- "verifyToken": "A String", # A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google.
- "userToken": "A String", # An opaque token sent to the subscriber in notifications so that it can determine the ID of the user.
- "operation": [ # A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are:
- # - UPDATE - The item has been updated.
- # - INSERT - A new item has been inserted.
- # - DELETE - The item has been deleted.
- # - MENU_ACTION - A custom menu item has been triggered by the user.
- "A String",
- ],
- "id": "A String", # The ID of the subscription.
- "callbackUrl": "A String", # The URL where notifications should be delivered (must start with https://).
- }
-
-
list()
-
Retrieves a list of subscriptions for the authenticated user and service.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # A list of Subscriptions. This is the response from the server to GET requests on the subscription collection.
- "items": [ # The list of subscriptions.
- { # A subscription to events on a collection.
- "kind": "mirror#subscription", # The type of resource. This is always mirror#subscription.
- "notification": { # A notification delivered by the API. # Container object for notifications. This is not populated in the Subscription resource.
- "itemId": "A String", # The ID of the item that generated the notification.
- "collection": "A String", # The collection that generated the notification.
- "verifyToken": "A String", # The secret verify token provided by the service when it subscribed for notifications.
- "userToken": "A String", # The user token provided by the service when it subscribed for notifications.
- "userActions": [ # A list of actions taken by the user that triggered the notification.
- { # Represents an action taken by the user that triggered a notification.
- "type": "A String", # The type of action. The value of this can be:
- # - SHARE - the user shared an item.
- # - REPLY - the user replied to an item.
- # - REPLY_ALL - the user replied to all recipients of an item.
- # - CUSTOM - the user selected a custom menu item on the timeline item.
- # - DELETE - the user deleted the item.
- # - PIN - the user pinned the item.
- # - UNPIN - the user unpinned the item. In the future, additional types may be added. UserActions with unrecognized types should be ignored.
- "payload": "A String", # An optional payload for the action.
- #
- # For actions of type CUSTOM, this is the ID of the custom menu item that was selected.
- },
- ],
- "operation": "A String", # The type of operation that generated the notification.
- },
- "updated": "A String", # The time at which this subscription was last modified, formatted according to RFC 3339.
- "collection": "A String", # The collection to subscribe to. Allowed values are:
- # - timeline - Changes in the timeline including insertion, deletion, and updates.
- # - locations - Location updates.
- "verifyToken": "A String", # A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google.
- "userToken": "A String", # An opaque token sent to the subscriber in notifications so that it can determine the ID of the user.
- "operation": [ # A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are:
- # - UPDATE - The item has been updated.
- # - INSERT - A new item has been inserted.
- # - DELETE - The item has been deleted.
- # - MENU_ACTION - A custom menu item has been triggered by the user.
- "A String",
- ],
- "id": "A String", # The ID of the subscription.
- "callbackUrl": "A String", # The URL where notifications should be delivered (must start with https://).
- },
- ],
- "kind": "mirror#subscriptionsList", # The type of resource. This is always mirror#subscriptionsList.
- }
-
-
update(id, body)
-
Updates an existing subscription in place.
-
-Args:
- id: string, The ID of the subscription. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A subscription to events on a collection.
- "kind": "mirror#subscription", # The type of resource. This is always mirror#subscription.
- "notification": { # A notification delivered by the API. # Container object for notifications. This is not populated in the Subscription resource.
- "itemId": "A String", # The ID of the item that generated the notification.
- "collection": "A String", # The collection that generated the notification.
- "verifyToken": "A String", # The secret verify token provided by the service when it subscribed for notifications.
- "userToken": "A String", # The user token provided by the service when it subscribed for notifications.
- "userActions": [ # A list of actions taken by the user that triggered the notification.
- { # Represents an action taken by the user that triggered a notification.
- "type": "A String", # The type of action. The value of this can be:
- # - SHARE - the user shared an item.
- # - REPLY - the user replied to an item.
- # - REPLY_ALL - the user replied to all recipients of an item.
- # - CUSTOM - the user selected a custom menu item on the timeline item.
- # - DELETE - the user deleted the item.
- # - PIN - the user pinned the item.
- # - UNPIN - the user unpinned the item. In the future, additional types may be added. UserActions with unrecognized types should be ignored.
- "payload": "A String", # An optional payload for the action.
- #
- # For actions of type CUSTOM, this is the ID of the custom menu item that was selected.
- },
- ],
- "operation": "A String", # The type of operation that generated the notification.
- },
- "updated": "A String", # The time at which this subscription was last modified, formatted according to RFC 3339.
- "collection": "A String", # The collection to subscribe to. Allowed values are:
- # - timeline - Changes in the timeline including insertion, deletion, and updates.
- # - locations - Location updates.
- "verifyToken": "A String", # A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google.
- "userToken": "A String", # An opaque token sent to the subscriber in notifications so that it can determine the ID of the user.
- "operation": [ # A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are:
- # - UPDATE - The item has been updated.
- # - INSERT - A new item has been inserted.
- # - DELETE - The item has been deleted.
- # - MENU_ACTION - A custom menu item has been triggered by the user.
- "A String",
- ],
- "id": "A String", # The ID of the subscription.
- "callbackUrl": "A String", # The URL where notifications should be delivered (must start with https://).
- }
-
-
-Returns:
- An object of the form:
-
- { # A subscription to events on a collection.
- "kind": "mirror#subscription", # The type of resource. This is always mirror#subscription.
- "notification": { # A notification delivered by the API. # Container object for notifications. This is not populated in the Subscription resource.
- "itemId": "A String", # The ID of the item that generated the notification.
- "collection": "A String", # The collection that generated the notification.
- "verifyToken": "A String", # The secret verify token provided by the service when it subscribed for notifications.
- "userToken": "A String", # The user token provided by the service when it subscribed for notifications.
- "userActions": [ # A list of actions taken by the user that triggered the notification.
- { # Represents an action taken by the user that triggered a notification.
- "type": "A String", # The type of action. The value of this can be:
- # - SHARE - the user shared an item.
- # - REPLY - the user replied to an item.
- # - REPLY_ALL - the user replied to all recipients of an item.
- # - CUSTOM - the user selected a custom menu item on the timeline item.
- # - DELETE - the user deleted the item.
- # - PIN - the user pinned the item.
- # - UNPIN - the user unpinned the item. In the future, additional types may be added. UserActions with unrecognized types should be ignored.
- "payload": "A String", # An optional payload for the action.
- #
- # For actions of type CUSTOM, this is the ID of the custom menu item that was selected.
- },
- ],
- "operation": "A String", # The type of operation that generated the notification.
- },
- "updated": "A String", # The time at which this subscription was last modified, formatted according to RFC 3339.
- "collection": "A String", # The collection to subscribe to. Allowed values are:
- # - timeline - Changes in the timeline including insertion, deletion, and updates.
- # - locations - Location updates.
- "verifyToken": "A String", # A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google.
- "userToken": "A String", # An opaque token sent to the subscriber in notifications so that it can determine the ID of the user.
- "operation": [ # A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are:
- # - UPDATE - The item has been updated.
- # - INSERT - A new item has been inserted.
- # - DELETE - The item has been deleted.
- # - MENU_ACTION - A custom menu item has been triggered by the user.
- "A String",
- ],
- "id": "A String", # The ID of the subscription.
- "callbackUrl": "A String", # The URL where notifications should be delivered (must start with https://).
- }
-
Instance Methods
-
- delete(itemId, attachmentId)
-Deletes an attachment from a timeline item.
-
- get(itemId, attachmentId)
-Retrieves an attachment on a timeline item by item ID and attachment ID.
-
- get_media(itemId, attachmentId)
-Retrieves an attachment on a timeline item by item ID and attachment ID.
-
- insert(itemId, media_body=None)
-Adds a new attachment to a timeline item.
-
- list(itemId)
-Returns a list of attachments for a timeline item.
-Method Details
-
-
delete(itemId, attachmentId)
-
Deletes an attachment from a timeline item.
-
-Args:
- itemId: string, The ID of the timeline item the attachment belongs to. (required)
- attachmentId: string, The ID of the attachment. (required)
-
-
-
get(itemId, attachmentId)
-
Retrieves an attachment on a timeline item by item ID and attachment ID.
-
-Args:
- itemId: string, The ID of the timeline item the attachment belongs to. (required)
- attachmentId: string, The ID of the attachment. (required)
-
-Returns:
- An object of the form:
-
- { # Represents media content, such as a photo, that can be attached to a timeline item.
- "contentUrl": "A String", # The URL for the content.
- "contentType": "A String", # The MIME type of the attachment.
- "id": "A String", # The ID of the attachment.
- "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.
- }
-
-
get_media(itemId, attachmentId)
-
Retrieves an attachment on a timeline item by item ID and attachment ID.
-
-Args:
- itemId: string, The ID of the timeline item the attachment belongs to. (required)
- attachmentId: string, The ID of the attachment. (required)
-
-Returns:
- The media object as a string.
-
-
-
-
insert(itemId, media_body=None)
-
Adds a new attachment to a timeline item.
-
-Args:
- itemId: string, The ID of the timeline item the attachment belongs to. (required)
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
-
-Returns:
- An object of the form:
-
- { # Represents media content, such as a photo, that can be attached to a timeline item.
- "contentUrl": "A String", # The URL for the content.
- "contentType": "A String", # The MIME type of the attachment.
- "id": "A String", # The ID of the attachment.
- "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.
- }
-
-
list(itemId)
-
Returns a list of attachments for a timeline item.
-
-Args:
- itemId: string, The ID of the timeline item whose attachments should be listed. (required)
-
-Returns:
- An object of the form:
-
- { # A list of Attachments. This is the response from the server to GET requests on the attachments collection.
- "items": [ # The list of attachments.
- { # Represents media content, such as a photo, that can be attached to a timeline item.
- "contentUrl": "A String", # The URL for the content.
- "contentType": "A String", # The MIME type of the attachment.
- "id": "A String", # The ID of the attachment.
- "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.
- },
- ],
- "kind": "mirror#attachmentsList", # The type of resource. This is always mirror#attachmentsList.
- }
-
Instance Methods
-
- attachments()
-
-Returns the attachments Resource.
-
-
- delete(id)
-Deletes a timeline item.
-
- get(id)
-Gets a single timeline item by ID.
-
- insert(body=None, media_body=None)
-Inserts a new item into the timeline.
-
- list(orderBy=None, includeDeleted=None, pageToken=None, maxResults=None, pinnedOnly=None, sourceItemId=None, bundleId=None)
-Retrieves a list of timeline items for the authenticated user.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(id, body)
-Updates a timeline item in place. This method supports patch semantics.
-
- update(id, body=None, media_body=None)
-Updates a timeline item in place.
-Method Details
-
-
delete(id)
-
Deletes a timeline item.
-
-Args:
- id: string, The ID of the timeline item. (required)
-
-
-
get(id)
-
Gets a single timeline item by ID.
-
-Args:
- id: string, The ID of the timeline item. (required)
-
-Returns:
- An object of the form:
-
- { # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below.
- "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example:
- # - attachment: 
where attachment_index is the 0-based index of this array.
- # - cid: 
where attachment_id is the ID of the attachment.
- { # Represents media content, such as a photo, that can be attached to a timeline item.
- "contentUrl": "A String", # The URL for the content.
- "contentType": "A String", # The MIME type of the attachment.
- "id": "A String", # The ID of the attachment.
- "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.
- },
- ],
- "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time.
- "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- "text": "A String", # Text content of this item.
- "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline.
- { # A custom menu item that can be presented to the user by a timeline item.
- "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are:
- # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value.
- # - Built-in actions:
- # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available.
- # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item.
- # - DELETE - Delete the timeline item.
- # - SHARE - Share the timeline item with the available contacts.
- # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored.
- # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phone_number attribute as recipient.
- # - NAVIGATE - Navigate to the timeline item's location.
- # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
- "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected.
- "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown.
- { # A single value that is part of a MenuItem.
- "iconUrl": "A String", # URL of an icon to display with the menu item.
- "state": "A String", # The state that this value applies to. Allowed values are:
- # - DEFAULT - Default value shown when displayed in the menuItems list.
- # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled.
- # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled.
- "displayName": "A String", # The name to display for the menu item.
- },
- ],
- "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token.
- },
- ],
- "isBundleCover": True or False, # Whether this item is a bundle cover.
- #
- # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle.
- #
- # On the main timeline, items that are shown are:
- # - Items that have isBundleCover set to true
- # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are:
- # - Items that have the bundleId in question AND isBundleCover set to false
- "etag": "A String", # ETag for this item.
- "id": "A String", # The ID of the timeline item. This is unique within a user's timeline.
- "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set.
- "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device.
- "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item.
- "title": "A String", # The title of this item.
- "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated.
- "level": "A String", # Describes how important the notification is. Allowed values are:
- # - DEFAULT - Notifications of default importance. A chime will be played to alert users.
- "deliveryTime": "A String", # The time at which the notification should be delivered.
- },
- "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass.
- #
- # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline.
- # Allowed HTML elements - You can use these elements in your timeline cards.
- #
- # - Headers: h1, h2, h3, h4, h5, h6
- # - Images: img
- # - Lists: li, ol, ul
- # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time
- # - Structural: blockquote, br, div, hr, p, span
- # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup
- # - Tables: table, tbody, td, tfoot, th, thead, tr
- # Blocked HTML elements: These elements and their contents are removed from HTML payloads.
- #
- # - Document headers: head, title
- # - Embeds: audio, embed, object, source, video
- # - Frames: frame, frameset
- # - Scripting: applet, script
- # Other elements: Any elements that aren't listed are removed, but their contents are preserved.
- "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item.
- "kind": "mirror#location", # The type of resource. This is always mirror#location.
- "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home".
- "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339.
- "longitude": 3.14, # The longitude, in degrees.
- "address": "A String", # The full address of the location.
- "latitude": 3.14, # The latitude, in degrees.
- "id": "A String", # The ID of the location.
- "accuracy": 3.14, # The accuracy of the location fix in meters.
- },
- "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service.
- "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post.
- "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339.
- "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item.
- "recipients": [ # A list of users or groups that this item has been shared with.
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- ],
- "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem.
- "created": "A String", # The time at which this item was created, formatted according to RFC 3339.
- "htmlPages": [ # Additional pages of HTML content associated with this item. If this field is specified, the item will be displayed as a bundle, with the html field as the cover. It is an error to specify this field without specifying the html field.
- "A String",
- ],
- "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported.
- "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- #
- # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update".
- #
- # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen.
- "selfLink": "A String", # A URL that can be used to retrieve this item.
- }
-
-
insert(body=None, media_body=None)
-
Inserts a new item into the timeline.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{ # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below.
- "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example:
- # - attachment: where attachment_index is the 0-based index of this array.
- # - cid: where attachment_id is the ID of the attachment.
- { # Represents media content, such as a photo, that can be attached to a timeline item.
- "contentUrl": "A String", # The URL for the content.
- "contentType": "A String", # The MIME type of the attachment.
- "id": "A String", # The ID of the attachment.
- "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.
- },
- ],
- "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time.
- "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- "text": "A String", # Text content of this item.
- "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline.
- { # A custom menu item that can be presented to the user by a timeline item.
- "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are:
- # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value.
- # - Built-in actions:
- # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available.
- # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item.
- # - DELETE - Delete the timeline item.
- # - SHARE - Share the timeline item with the available contacts.
- # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored.
- # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phone_number attribute as recipient.
- # - NAVIGATE - Navigate to the timeline item's location.
- # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
- "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected.
- "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown.
- { # A single value that is part of a MenuItem.
- "iconUrl": "A String", # URL of an icon to display with the menu item.
- "state": "A String", # The state that this value applies to. Allowed values are:
- # - DEFAULT - Default value shown when displayed in the menuItems list.
- # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled.
- # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled.
- "displayName": "A String", # The name to display for the menu item.
- },
- ],
- "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token.
- },
- ],
- "isBundleCover": True or False, # Whether this item is a bundle cover.
- #
- # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle.
- #
- # On the main timeline, items that are shown are:
- # - Items that have isBundleCover set to true
- # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are:
- # - Items that have the bundleId in question AND isBundleCover set to false
- "etag": "A String", # ETag for this item.
- "id": "A String", # The ID of the timeline item. This is unique within a user's timeline.
- "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set.
- "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device.
- "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item.
- "title": "A String", # The title of this item.
- "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated.
- "level": "A String", # Describes how important the notification is. Allowed values are:
- # - DEFAULT - Notifications of default importance. A chime will be played to alert users.
- "deliveryTime": "A String", # The time at which the notification should be delivered.
- },
- "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass.
- #
- # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline.
- # Allowed HTML elements - You can use these elements in your timeline cards.
- #
- # - Headers: h1, h2, h3, h4, h5, h6
- # - Images: img
- # - Lists: li, ol, ul
- # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time
- # - Structural: blockquote, br, div, hr, p, span
- # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup
- # - Tables: table, tbody, td, tfoot, th, thead, tr
- # Blocked HTML elements: These elements and their contents are removed from HTML payloads.
- #
- # - Document headers: head, title
- # - Embeds: audio, embed, object, source, video
- # - Frames: frame, frameset
- # - Scripting: applet, script
- # Other elements: Any elements that aren't listed are removed, but their contents are preserved.
- "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item.
- "kind": "mirror#location", # The type of resource. This is always mirror#location.
- "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home".
- "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339.
- "longitude": 3.14, # The longitude, in degrees.
- "address": "A String", # The full address of the location.
- "latitude": 3.14, # The latitude, in degrees.
- "id": "A String", # The ID of the location.
- "accuracy": 3.14, # The accuracy of the location fix in meters.
- },
- "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service.
- "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post.
- "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339.
- "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item.
- "recipients": [ # A list of users or groups that this item has been shared with.
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- ],
- "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem.
- "created": "A String", # The time at which this item was created, formatted according to RFC 3339.
- "htmlPages": [ # Additional pages of HTML content associated with this item. If this field is specified, the item will be displayed as a bundle, with the html field as the cover. It is an error to specify this field without specifying the html field.
- "A String",
- ],
- "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported.
- "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- #
- # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update".
- #
- # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen.
- "selfLink": "A String", # A URL that can be used to retrieve this item.
- }
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
-
-Returns:
- An object of the form:
-
- { # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below.
- "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example:
- # - attachment: where attachment_index is the 0-based index of this array.
- # - cid: where attachment_id is the ID of the attachment.
- { # Represents media content, such as a photo, that can be attached to a timeline item.
- "contentUrl": "A String", # The URL for the content.
- "contentType": "A String", # The MIME type of the attachment.
- "id": "A String", # The ID of the attachment.
- "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.
- },
- ],
- "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time.
- "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- "text": "A String", # Text content of this item.
- "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline.
- { # A custom menu item that can be presented to the user by a timeline item.
- "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are:
- # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value.
- # - Built-in actions:
- # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available.
- # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item.
- # - DELETE - Delete the timeline item.
- # - SHARE - Share the timeline item with the available contacts.
- # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored.
- # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phone_number attribute as recipient.
- # - NAVIGATE - Navigate to the timeline item's location.
- # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
- "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected.
- "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown.
- { # A single value that is part of a MenuItem.
- "iconUrl": "A String", # URL of an icon to display with the menu item.
- "state": "A String", # The state that this value applies to. Allowed values are:
- # - DEFAULT - Default value shown when displayed in the menuItems list.
- # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled.
- # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled.
- "displayName": "A String", # The name to display for the menu item.
- },
- ],
- "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token.
- },
- ],
- "isBundleCover": True or False, # Whether this item is a bundle cover.
- #
- # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle.
- #
- # On the main timeline, items that are shown are:
- # - Items that have isBundleCover set to true
- # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are:
- # - Items that have the bundleId in question AND isBundleCover set to false
- "etag": "A String", # ETag for this item.
- "id": "A String", # The ID of the timeline item. This is unique within a user's timeline.
- "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set.
- "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device.
- "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item.
- "title": "A String", # The title of this item.
- "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated.
- "level": "A String", # Describes how important the notification is. Allowed values are:
- # - DEFAULT - Notifications of default importance. A chime will be played to alert users.
- "deliveryTime": "A String", # The time at which the notification should be delivered.
- },
- "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass.
- #
- # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline.
- # Allowed HTML elements - You can use these elements in your timeline cards.
- #
- # - Headers: h1, h2, h3, h4, h5, h6
- # - Images: img
- # - Lists: li, ol, ul
- # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time
- # - Structural: blockquote, br, div, hr, p, span
- # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup
- # - Tables: table, tbody, td, tfoot, th, thead, tr
- # Blocked HTML elements: These elements and their contents are removed from HTML payloads.
- #
- # - Document headers: head, title
- # - Embeds: audio, embed, object, source, video
- # - Frames: frame, frameset
- # - Scripting: applet, script
- # Other elements: Any elements that aren't listed are removed, but their contents are preserved.
- "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item.
- "kind": "mirror#location", # The type of resource. This is always mirror#location.
- "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home".
- "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339.
- "longitude": 3.14, # The longitude, in degrees.
- "address": "A String", # The full address of the location.
- "latitude": 3.14, # The latitude, in degrees.
- "id": "A String", # The ID of the location.
- "accuracy": 3.14, # The accuracy of the location fix in meters.
- },
- "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service.
- "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post.
- "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339.
- "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item.
- "recipients": [ # A list of users or groups that this item has been shared with.
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- ],
- "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem.
- "created": "A String", # The time at which this item was created, formatted according to RFC 3339.
- "htmlPages": [ # Additional pages of HTML content associated with this item. If this field is specified, the item will be displayed as a bundle, with the html field as the cover. It is an error to specify this field without specifying the html field.
- "A String",
- ],
- "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported.
- "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- #
- # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update".
- #
- # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen.
- "selfLink": "A String", # A URL that can be used to retrieve this item.
- }
-
-
list(orderBy=None, includeDeleted=None, pageToken=None, maxResults=None, pinnedOnly=None, sourceItemId=None, bundleId=None)
-
Retrieves a list of timeline items for the authenticated user.
-
-Args:
- orderBy: string, Controls the order in which timeline items are returned.
- Allowed values
- displayTime - Results will be ordered by displayTime (default). This is the same ordering as is used in the timeline on the device.
- writeTime - Results will be ordered by the time at which they were last written to the data store.
- includeDeleted: boolean, If true, tombstone records for deleted items will be returned.
- pageToken: string, Token for the page of results to return.
- maxResults: integer, The maximum number of items to include in the response, used for paging.
- pinnedOnly: boolean, If true, only pinned items will be returned.
- sourceItemId: string, If provided, only items with the given sourceItemId will be returned.
- bundleId: string, If provided, only items with the given bundleId will be returned.
-
-Returns:
- An object of the form:
-
- { # A list of timeline items. This is the response from the server to GET requests on the timeline collection.
- "nextPageToken": "A String", # The next page token. Provide this as the pageToken parameter in the request to retrieve the next page of results.
- "items": [ # Items in the timeline.
- { # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below.
- "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example:
- # - attachment: where attachment_index is the 0-based index of this array.
- # - cid: where attachment_id is the ID of the attachment.
- { # Represents media content, such as a photo, that can be attached to a timeline item.
- "contentUrl": "A String", # The URL for the content.
- "contentType": "A String", # The MIME type of the attachment.
- "id": "A String", # The ID of the attachment.
- "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.
- },
- ],
- "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time.
- "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- "text": "A String", # Text content of this item.
- "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline.
- { # A custom menu item that can be presented to the user by a timeline item.
- "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are:
- # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value.
- # - Built-in actions:
- # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available.
- # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item.
- # - DELETE - Delete the timeline item.
- # - SHARE - Share the timeline item with the available contacts.
- # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored.
- # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phone_number attribute as recipient.
- # - NAVIGATE - Navigate to the timeline item's location.
- # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
- "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected.
- "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown.
- { # A single value that is part of a MenuItem.
- "iconUrl": "A String", # URL of an icon to display with the menu item.
- "state": "A String", # The state that this value applies to. Allowed values are:
- # - DEFAULT - Default value shown when displayed in the menuItems list.
- # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled.
- # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled.
- "displayName": "A String", # The name to display for the menu item.
- },
- ],
- "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token.
- },
- ],
- "isBundleCover": True or False, # Whether this item is a bundle cover.
- #
- # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle.
- #
- # On the main timeline, items that are shown are:
- # - Items that have isBundleCover set to true
- # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are:
- # - Items that have the bundleId in question AND isBundleCover set to false
- "etag": "A String", # ETag for this item.
- "id": "A String", # The ID of the timeline item. This is unique within a user's timeline.
- "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set.
- "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device.
- "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item.
- "title": "A String", # The title of this item.
- "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated.
- "level": "A String", # Describes how important the notification is. Allowed values are:
- # - DEFAULT - Notifications of default importance. A chime will be played to alert users.
- "deliveryTime": "A String", # The time at which the notification should be delivered.
- },
- "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass.
- #
- # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline.
- # Allowed HTML elements - You can use these elements in your timeline cards.
- #
- # - Headers: h1, h2, h3, h4, h5, h6
- # - Images: img
- # - Lists: li, ol, ul
- # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time
- # - Structural: blockquote, br, div, hr, p, span
- # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup
- # - Tables: table, tbody, td, tfoot, th, thead, tr
- # Blocked HTML elements: These elements and their contents are removed from HTML payloads.
- #
- # - Document headers: head, title
- # - Embeds: audio, embed, object, source, video
- # - Frames: frame, frameset
- # - Scripting: applet, script
- # Other elements: Any elements that aren't listed are removed, but their contents are preserved.
- "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item.
- "kind": "mirror#location", # The type of resource. This is always mirror#location.
- "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home".
- "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339.
- "longitude": 3.14, # The longitude, in degrees.
- "address": "A String", # The full address of the location.
- "latitude": 3.14, # The latitude, in degrees.
- "id": "A String", # The ID of the location.
- "accuracy": 3.14, # The accuracy of the location fix in meters.
- },
- "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service.
- "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post.
- "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339.
- "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item.
- "recipients": [ # A list of users or groups that this item has been shared with.
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- ],
- "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem.
- "created": "A String", # The time at which this item was created, formatted according to RFC 3339.
- "htmlPages": [ # Additional pages of HTML content associated with this item. If this field is specified, the item will be displayed as a bundle, with the html field as the cover. It is an error to specify this field without specifying the html field.
- "A String",
- ],
- "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported.
- "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- #
- # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update".
- #
- # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen.
- "selfLink": "A String", # A URL that can be used to retrieve this item.
- },
- ],
- "kind": "mirror#timeline", # The type of resource. This is always mirror#timeline.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(id, body)
-
Updates a timeline item in place. This method supports patch semantics.
-
-Args:
- id: string, The ID of the timeline item. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below.
- "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example:
- # - attachment: where attachment_index is the 0-based index of this array.
- # - cid: where attachment_id is the ID of the attachment.
- { # Represents media content, such as a photo, that can be attached to a timeline item.
- "contentUrl": "A String", # The URL for the content.
- "contentType": "A String", # The MIME type of the attachment.
- "id": "A String", # The ID of the attachment.
- "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.
- },
- ],
- "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time.
- "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- "text": "A String", # Text content of this item.
- "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline.
- { # A custom menu item that can be presented to the user by a timeline item.
- "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are:
- # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value.
- # - Built-in actions:
- # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available.
- # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item.
- # - DELETE - Delete the timeline item.
- # - SHARE - Share the timeline item with the available contacts.
- # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored.
- # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phone_number attribute as recipient.
- # - NAVIGATE - Navigate to the timeline item's location.
- # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
- "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected.
- "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown.
- { # A single value that is part of a MenuItem.
- "iconUrl": "A String", # URL of an icon to display with the menu item.
- "state": "A String", # The state that this value applies to. Allowed values are:
- # - DEFAULT - Default value shown when displayed in the menuItems list.
- # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled.
- # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled.
- "displayName": "A String", # The name to display for the menu item.
- },
- ],
- "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token.
- },
- ],
- "isBundleCover": True or False, # Whether this item is a bundle cover.
- #
- # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle.
- #
- # On the main timeline, items that are shown are:
- # - Items that have isBundleCover set to true
- # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are:
- # - Items that have the bundleId in question AND isBundleCover set to false
- "etag": "A String", # ETag for this item.
- "id": "A String", # The ID of the timeline item. This is unique within a user's timeline.
- "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set.
- "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device.
- "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item.
- "title": "A String", # The title of this item.
- "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated.
- "level": "A String", # Describes how important the notification is. Allowed values are:
- # - DEFAULT - Notifications of default importance. A chime will be played to alert users.
- "deliveryTime": "A String", # The time at which the notification should be delivered.
- },
- "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass.
- #
- # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline.
- # Allowed HTML elements - You can use these elements in your timeline cards.
- #
- # - Headers: h1, h2, h3, h4, h5, h6
- # - Images: img
- # - Lists: li, ol, ul
- # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time
- # - Structural: blockquote, br, div, hr, p, span
- # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup
- # - Tables: table, tbody, td, tfoot, th, thead, tr
- # Blocked HTML elements: These elements and their contents are removed from HTML payloads.
- #
- # - Document headers: head, title
- # - Embeds: audio, embed, object, source, video
- # - Frames: frame, frameset
- # - Scripting: applet, script
- # Other elements: Any elements that aren't listed are removed, but their contents are preserved.
- "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item.
- "kind": "mirror#location", # The type of resource. This is always mirror#location.
- "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home".
- "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339.
- "longitude": 3.14, # The longitude, in degrees.
- "address": "A String", # The full address of the location.
- "latitude": 3.14, # The latitude, in degrees.
- "id": "A String", # The ID of the location.
- "accuracy": 3.14, # The accuracy of the location fix in meters.
- },
- "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service.
- "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post.
- "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339.
- "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item.
- "recipients": [ # A list of users or groups that this item has been shared with.
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- ],
- "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem.
- "created": "A String", # The time at which this item was created, formatted according to RFC 3339.
- "htmlPages": [ # Additional pages of HTML content associated with this item. If this field is specified, the item will be displayed as a bundle, with the html field as the cover. It is an error to specify this field without specifying the html field.
- "A String",
- ],
- "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported.
- "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- #
- # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update".
- #
- # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen.
- "selfLink": "A String", # A URL that can be used to retrieve this item.
- }
-
-
-Returns:
- An object of the form:
-
- { # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below.
- "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example:
- # - attachment: where attachment_index is the 0-based index of this array.
- # - cid: where attachment_id is the ID of the attachment.
- { # Represents media content, such as a photo, that can be attached to a timeline item.
- "contentUrl": "A String", # The URL for the content.
- "contentType": "A String", # The MIME type of the attachment.
- "id": "A String", # The ID of the attachment.
- "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.
- },
- ],
- "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time.
- "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- "text": "A String", # Text content of this item.
- "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline.
- { # A custom menu item that can be presented to the user by a timeline item.
- "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are:
- # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value.
- # - Built-in actions:
- # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available.
- # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item.
- # - DELETE - Delete the timeline item.
- # - SHARE - Share the timeline item with the available contacts.
- # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored.
- # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phone_number attribute as recipient.
- # - NAVIGATE - Navigate to the timeline item's location.
- # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
- "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected.
- "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown.
- { # A single value that is part of a MenuItem.
- "iconUrl": "A String", # URL of an icon to display with the menu item.
- "state": "A String", # The state that this value applies to. Allowed values are:
- # - DEFAULT - Default value shown when displayed in the menuItems list.
- # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled.
- # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled.
- "displayName": "A String", # The name to display for the menu item.
- },
- ],
- "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token.
- },
- ],
- "isBundleCover": True or False, # Whether this item is a bundle cover.
- #
- # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle.
- #
- # On the main timeline, items that are shown are:
- # - Items that have isBundleCover set to true
- # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are:
- # - Items that have the bundleId in question AND isBundleCover set to false
- "etag": "A String", # ETag for this item.
- "id": "A String", # The ID of the timeline item. This is unique within a user's timeline.
- "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set.
- "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device.
- "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item.
- "title": "A String", # The title of this item.
- "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated.
- "level": "A String", # Describes how important the notification is. Allowed values are:
- # - DEFAULT - Notifications of default importance. A chime will be played to alert users.
- "deliveryTime": "A String", # The time at which the notification should be delivered.
- },
- "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass.
- #
- # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline.
- # Allowed HTML elements - You can use these elements in your timeline cards.
- #
- # - Headers: h1, h2, h3, h4, h5, h6
- # - Images: img
- # - Lists: li, ol, ul
- # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time
- # - Structural: blockquote, br, div, hr, p, span
- # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup
- # - Tables: table, tbody, td, tfoot, th, thead, tr
- # Blocked HTML elements: These elements and their contents are removed from HTML payloads.
- #
- # - Document headers: head, title
- # - Embeds: audio, embed, object, source, video
- # - Frames: frame, frameset
- # - Scripting: applet, script
- # Other elements: Any elements that aren't listed are removed, but their contents are preserved.
- "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item.
- "kind": "mirror#location", # The type of resource. This is always mirror#location.
- "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home".
- "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339.
- "longitude": 3.14, # The longitude, in degrees.
- "address": "A String", # The full address of the location.
- "latitude": 3.14, # The latitude, in degrees.
- "id": "A String", # The ID of the location.
- "accuracy": 3.14, # The accuracy of the location fix in meters.
- },
- "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service.
- "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post.
- "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339.
- "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item.
- "recipients": [ # A list of users or groups that this item has been shared with.
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- ],
- "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem.
- "created": "A String", # The time at which this item was created, formatted according to RFC 3339.
- "htmlPages": [ # Additional pages of HTML content associated with this item. If this field is specified, the item will be displayed as a bundle, with the html field as the cover. It is an error to specify this field without specifying the html field.
- "A String",
- ],
- "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported.
- "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- #
- # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update".
- #
- # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen.
- "selfLink": "A String", # A URL that can be used to retrieve this item.
- }
-
-
update(id, body=None, media_body=None)
-
Updates a timeline item in place.
-
-Args:
- id: string, The ID of the timeline item. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below.
- "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example:
- # - attachment: where attachment_index is the 0-based index of this array.
- # - cid: where attachment_id is the ID of the attachment.
- { # Represents media content, such as a photo, that can be attached to a timeline item.
- "contentUrl": "A String", # The URL for the content.
- "contentType": "A String", # The MIME type of the attachment.
- "id": "A String", # The ID of the attachment.
- "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.
- },
- ],
- "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time.
- "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- "text": "A String", # Text content of this item.
- "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline.
- { # A custom menu item that can be presented to the user by a timeline item.
- "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are:
- # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value.
- # - Built-in actions:
- # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available.
- # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item.
- # - DELETE - Delete the timeline item.
- # - SHARE - Share the timeline item with the available contacts.
- # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored.
- # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phone_number attribute as recipient.
- # - NAVIGATE - Navigate to the timeline item's location.
- # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
- "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected.
- "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown.
- { # A single value that is part of a MenuItem.
- "iconUrl": "A String", # URL of an icon to display with the menu item.
- "state": "A String", # The state that this value applies to. Allowed values are:
- # - DEFAULT - Default value shown when displayed in the menuItems list.
- # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled.
- # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled.
- "displayName": "A String", # The name to display for the menu item.
- },
- ],
- "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token.
- },
- ],
- "isBundleCover": True or False, # Whether this item is a bundle cover.
- #
- # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle.
- #
- # On the main timeline, items that are shown are:
- # - Items that have isBundleCover set to true
- # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are:
- # - Items that have the bundleId in question AND isBundleCover set to false
- "etag": "A String", # ETag for this item.
- "id": "A String", # The ID of the timeline item. This is unique within a user's timeline.
- "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set.
- "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device.
- "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item.
- "title": "A String", # The title of this item.
- "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated.
- "level": "A String", # Describes how important the notification is. Allowed values are:
- # - DEFAULT - Notifications of default importance. A chime will be played to alert users.
- "deliveryTime": "A String", # The time at which the notification should be delivered.
- },
- "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass.
- #
- # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline.
- # Allowed HTML elements - You can use these elements in your timeline cards.
- #
- # - Headers: h1, h2, h3, h4, h5, h6
- # - Images: img
- # - Lists: li, ol, ul
- # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time
- # - Structural: blockquote, br, div, hr, p, span
- # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup
- # - Tables: table, tbody, td, tfoot, th, thead, tr
- # Blocked HTML elements: These elements and their contents are removed from HTML payloads.
- #
- # - Document headers: head, title
- # - Embeds: audio, embed, object, source, video
- # - Frames: frame, frameset
- # - Scripting: applet, script
- # Other elements: Any elements that aren't listed are removed, but their contents are preserved.
- "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item.
- "kind": "mirror#location", # The type of resource. This is always mirror#location.
- "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home".
- "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339.
- "longitude": 3.14, # The longitude, in degrees.
- "address": "A String", # The full address of the location.
- "latitude": 3.14, # The latitude, in degrees.
- "id": "A String", # The ID of the location.
- "accuracy": 3.14, # The accuracy of the location fix in meters.
- },
- "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service.
- "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post.
- "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339.
- "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item.
- "recipients": [ # A list of users or groups that this item has been shared with.
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- ],
- "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem.
- "created": "A String", # The time at which this item was created, formatted according to RFC 3339.
- "htmlPages": [ # Additional pages of HTML content associated with this item. If this field is specified, the item will be displayed as a bundle, with the html field as the cover. It is an error to specify this field without specifying the html field.
- "A String",
- ],
- "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported.
- "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- #
- # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update".
- #
- # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen.
- "selfLink": "A String", # A URL that can be used to retrieve this item.
- }
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
-
-Returns:
- An object of the form:
-
- { # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below.
- "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example:
- # - attachment: where attachment_index is the 0-based index of this array.
- # - cid: where attachment_id is the ID of the attachment.
- { # Represents media content, such as a photo, that can be attached to a timeline item.
- "contentUrl": "A String", # The URL for the content.
- "contentType": "A String", # The MIME type of the attachment.
- "id": "A String", # The ID of the attachment.
- "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.
- },
- ],
- "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time.
- "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- "text": "A String", # Text content of this item.
- "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline.
- { # A custom menu item that can be presented to the user by a timeline item.
- "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are:
- # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value.
- # - Built-in actions:
- # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available.
- # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item.
- # - DELETE - Delete the timeline item.
- # - SHARE - Share the timeline item with the available contacts.
- # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored.
- # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phone_number attribute as recipient.
- # - NAVIGATE - Navigate to the timeline item's location.
- # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item.
- "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected.
- "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown.
- { # A single value that is part of a MenuItem.
- "iconUrl": "A String", # URL of an icon to display with the menu item.
- "state": "A String", # The state that this value applies to. Allowed values are:
- # - DEFAULT - Default value shown when displayed in the menuItems list.
- # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled.
- # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled.
- "displayName": "A String", # The name to display for the menu item.
- },
- ],
- "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token.
- },
- ],
- "isBundleCover": True or False, # Whether this item is a bundle cover.
- #
- # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle.
- #
- # On the main timeline, items that are shown are:
- # - Items that have isBundleCover set to true
- # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are:
- # - Items that have the bundleId in question AND isBundleCover set to false
- "etag": "A String", # ETag for this item.
- "id": "A String", # The ID of the timeline item. This is unique within a user's timeline.
- "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set.
- "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device.
- "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item.
- "title": "A String", # The title of this item.
- "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated.
- "level": "A String", # Describes how important the notification is. Allowed values are:
- # - DEFAULT - Notifications of default importance. A chime will be played to alert users.
- "deliveryTime": "A String", # The time at which the notification should be delivered.
- },
- "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass.
- #
- # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline.
- # Allowed HTML elements - You can use these elements in your timeline cards.
- #
- # - Headers: h1, h2, h3, h4, h5, h6
- # - Images: img
- # - Lists: li, ol, ul
- # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time
- # - Structural: blockquote, br, div, hr, p, span
- # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup
- # - Tables: table, tbody, td, tfoot, th, thead, tr
- # Blocked HTML elements: These elements and their contents are removed from HTML payloads.
- #
- # - Document headers: head, title
- # - Embeds: audio, embed, object, source, video
- # - Frames: frame, frameset
- # - Scripting: applet, script
- # Other elements: Any elements that aren't listed are removed, but their contents are preserved.
- "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item.
- "kind": "mirror#location", # The type of resource. This is always mirror#location.
- "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home".
- "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339.
- "longitude": 3.14, # The longitude, in degrees.
- "address": "A String", # The full address of the location.
- "latitude": 3.14, # The latitude, in degrees.
- "id": "A String", # The ID of the location.
- "accuracy": 3.14, # The accuracy of the location fix in meters.
- },
- "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service.
- "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post.
- "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339.
- "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item.
- "recipients": [ # A list of users or groups that this item has been shared with.
- { # A person or group that can be used as a creator or a contact.
- "kind": "mirror#contact", # The type of resource. This is always mirror#contact.
- "displayName": "A String", # The name to display for this contact.
- "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
- "A String",
- ],
- "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
- # - INDIVIDUAL - Represents a single person. This is the default.
- # - GROUP - Represents more than a single person.
- "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
- "source": "A String", # The ID of the application that created this contact. This is populated by the API
- "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
- "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
- "A String",
- ],
- "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
- },
- ],
- "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem.
- "created": "A String", # The time at which this item was created, formatted according to RFC 3339.
- "htmlPages": [ # Additional pages of HTML content associated with this item. If this field is specified, the item will be displayed as a bundle, with the html field as the cover. It is an error to specify this field without specifying the html field.
- "A String",
- ],
- "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported.
- "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
- #
- # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update".
- #
- # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen.
- "selfLink": "A String", # A URL that can be used to retrieve this item.
- }
-
Instance Methods
-
- series()
-
-Returns the series Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/moderator_v1.featured.series.html b/docs/dyn/moderator_v1.featured.series.html
deleted file mode 100644
index e97cdd1..0000000
--- a/docs/dyn/moderator_v1.featured.series.html
+++ /dev/null
@@ -1,129 +0,0 @@
-
-
-
-
-Instance Methods
-
- list()
-Lists the featured series.
-Method Details
-
-
list()
-
Lists the featured series.
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- },
- ],
- "kind": "moderator#seriesList",
- }
-
Instance Methods
-
- series()
-
-Returns the series Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/moderator_v1.global_.series.html b/docs/dyn/moderator_v1.global_.series.html
deleted file mode 100644
index d212e93..0000000
--- a/docs/dyn/moderator_v1.global_.series.html
+++ /dev/null
@@ -1,132 +0,0 @@
-
-
-
-
-Instance Methods
-
- list(q=None, max_results=None, start_index=None)
-Searches the public series and returns the search results.
-Method Details
-
-
list(q=None, max_results=None, start_index=None)
-
Searches the public series and returns the search results.
-
-Args:
- q: string, Search query.
- max_results: integer, Maximum number of results to return.
- start_index: integer, Index of the first result to be retrieved.
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- },
- ],
- "kind": "moderator#seriesList",
- }
-
Instance Methods
-
- featured()
-
-Returns the featured Resource.
-
-
- global_()
-
-Returns the global_ Resource.
-
-
- my()
-
-Returns the my Resource.
-
-
- myrecent()
-
-Returns the myrecent Resource.
-
-
- profiles()
-
-Returns the profiles Resource.
-
-
- responses()
-
-Returns the responses Resource.
-
-
- series()
-
-Returns the series Resource.
-
-
- submissions()
-
-Returns the submissions Resource.
-
-
- tags()
-
-Returns the tags Resource.
-
-
- topics()
-
-Returns the topics Resource.
-
-
- votes()
-
-Returns the votes Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/moderator_v1.my.html b/docs/dyn/moderator_v1.my.html
deleted file mode 100644
index bbe8412..0000000
--- a/docs/dyn/moderator_v1.my.html
+++ /dev/null
@@ -1,82 +0,0 @@
-
-
-
-
-Instance Methods
-
- series()
-
-Returns the series Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/moderator_v1.my.series.html b/docs/dyn/moderator_v1.my.series.html
deleted file mode 100644
index 6369258..0000000
--- a/docs/dyn/moderator_v1.my.series.html
+++ /dev/null
@@ -1,129 +0,0 @@
-
-
-
-
-Instance Methods
-
- list()
-Lists all series created by the authenticated user.
-Method Details
-
-
list()
-
Lists all series created by the authenticated user.
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- },
- ],
- "kind": "moderator#seriesList",
- }
-
Instance Methods
-
- series()
-
-Returns the series Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/moderator_v1.myrecent.series.html b/docs/dyn/moderator_v1.myrecent.series.html
deleted file mode 100644
index bdf2808..0000000
--- a/docs/dyn/moderator_v1.myrecent.series.html
+++ /dev/null
@@ -1,129 +0,0 @@
-
-
-
-
-Instance Methods
-
- list()
-Lists the series the authenticated user has visited.
-Method Details
-
-
list()
-
Lists the series the authenticated user has visited.
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- },
- ],
- "kind": "moderator#seriesList",
- }
-
Instance Methods
-
- get()
-Returns the profile information for the authenticated user.
-
- patch(body)
-Updates the profile information for the authenticated user. This method supports patch semantics.
-
- update(body)
-Updates the profile information for the authenticated user.
-Method Details
-
-
get()
-
Returns the profile information for the authenticated user.
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#profile",
- "attribution": {
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "id": {
- "user": "A String",
- },
- }
-
-
patch(body)
-
Updates the profile information for the authenticated user. This method supports patch semantics.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "moderator#profile",
- "attribution": {
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "id": {
- "user": "A String",
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#profile",
- "attribution": {
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "id": {
- "user": "A String",
- },
- }
-
-
update(body)
-
Updates the profile information for the authenticated user.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "moderator#profile",
- "attribution": {
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "id": {
- "user": "A String",
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#profile",
- "attribution": {
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "id": {
- "user": "A String",
- },
- }
-
Instance Methods
-
- insert(seriesId, topicId, parentSubmissionId, body, unauthToken=None, anonymous=None)
-Inserts a response for the specified submission in the specified topic within the specified series.
-
- list(seriesId, submissionId, sort=None, author=None, q=None, max_results=None, hasAttachedVideo=None, start_index=None)
-Lists or searches the responses for the specified submission within the specified series and returns the search results.
-Method Details
-
-
insert(seriesId, topicId, parentSubmissionId, body, unauthToken=None, anonymous=None)
-
Inserts a response for the specified submission in the specified topic within the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- topicId: integer, The decimal ID of the Topic within the Series. (required)
- parentSubmissionId: integer, The decimal ID of the parent Submission within the Series. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- }
-
- unauthToken: string, User identifier for unauthenticated usage mode
- anonymous: boolean, Set to true to mark the new submission as anonymous.
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- }
-
-
list(seriesId, submissionId, sort=None, author=None, q=None, max_results=None, hasAttachedVideo=None, start_index=None)
-
Lists or searches the responses for the specified submission within the specified series and returns the search results.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- submissionId: integer, The decimal ID of the Submission within the Series. (required)
- sort: string, Sort order.
- author: string, Restricts the results to submissions by a specific author.
- q: string, Search query.
- max_results: integer, Maximum number of results to return.
- hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
- start_index: integer, Index of the first result to be retrieved.
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- },
- ],
- "kind": "moderator#submissionList",
- }
-
Instance Methods
-
- responses()
-
-Returns the responses Resource.
-
-
- submissions()
-
-Returns the submissions Resource.
-
-
- get(seriesId)
-Returns the specified series.
-
- insert(body)
-Inserts a new series.
-
- list(q=None, max_results=None, start_index=None)
-Searches the series and returns the search results.
-
- patch(seriesId, body)
-Updates the specified series. This method supports patch semantics.
-
- update(seriesId, body)
-Updates the specified series.
-Method Details
-
-
get(seriesId)
-
Returns the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- }
-
-
insert(body)
-
Inserts a new series.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
-}
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- }
-
-
list(q=None, max_results=None, start_index=None)
-
Searches the series and returns the search results.
-
-Args:
- q: string, Search query.
- max_results: integer, Maximum number of results to return.
- start_index: integer, Index of the first result to be retrieved.
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- },
- ],
- "kind": "moderator#seriesList",
- }
-
-
patch(seriesId, body)
-
Updates the specified series. This method supports patch semantics.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
-}
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- }
-
-
update(seriesId, body)
-
Updates the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
-}
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- }
-
Instance Methods
-
- list(seriesId, sort=None, author=None, q=None, max_results=None, hasAttachedVideo=None, start_index=None)
-Searches the responses for the specified series and returns the search results.
-Method Details
-
-
list(seriesId, sort=None, author=None, q=None, max_results=None, hasAttachedVideo=None, start_index=None)
-
Searches the responses for the specified series and returns the search results.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- sort: string, Sort order.
- author: string, Restricts the results to submissions by a specific author.
- q: string, Search query.
- max_results: integer, Maximum number of results to return.
- hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
- start_index: integer, Index of the first result to be retrieved.
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "kind": "moderator#series",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "unauthVotingAllowed": True or False,
- "videoSubmissionAllowed": True or False,
- "name": "A String",
- "numTopics": 42,
- "anonymousSubmissionAllowed": True or False,
- "unauthSubmissionAllowed": True or False,
- "id": {
- "seriesId": "A String",
- },
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "anonymousSubmissions": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- },
- ],
- "kind": "moderator#seriesList",
- }
-
Instance Methods
-
- list(seriesId, lang=None, includeVotes=None, author=None, sort=None, max_results=None, q=None, start_index=None, hasAttachedVideo=None)
-Searches the submissions for the specified series and returns the search results.
-Method Details
-
-
list(seriesId, lang=None, includeVotes=None, author=None, sort=None, max_results=None, q=None, start_index=None, hasAttachedVideo=None)
-
Searches the submissions for the specified series and returns the search results.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- lang: string, The language code for the language the client prefers resuls in.
- 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.
- max_results: integer, Maximum number of results to return.
- q: string, Search query.
- start_index: integer, Index of the first result to be retrieved.
- hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- },
- ],
- "kind": "moderator#submissionList",
- }
-
Instance Methods
-
- get(seriesId, submissionId, lang=None, includeVotes=None)
-Returns the specified submission within the specified series.
-
- insert(seriesId, topicId, body, unauthToken=None, anonymous=None)
-Inserts a new submission in the specified topic within the specified series.
-Method Details
-
-
get(seriesId, submissionId, lang=None, includeVotes=None)
-
Returns the specified submission within the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- submissionId: integer, The decimal ID of the Submission within the Series. (required)
- lang: string, The language code for the language the client prefers resuls in.
- includeVotes: boolean, Specifies whether to include the current user's vote
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- }
-
-
insert(seriesId, topicId, body, unauthToken=None, anonymous=None)
-
Inserts a new submission in the specified topic within the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- topicId: integer, The decimal ID of the Topic within the Series. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- }
-
- unauthToken: string, User identifier for unauthenticated usage mode
- anonymous: boolean, Set to true to mark the new submission as anonymous.
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- }
-
Instance Methods
-
- delete(seriesId, submissionId, tagId)
-Deletes the specified tag from the specified submission within the specified series.
-
- insert(seriesId, submissionId, body)
-Inserts a new tag for the specified submission within the specified series.
-
- list(seriesId, submissionId)
-Lists all tags for the specified submission within the specified series.
-Method Details
-
-
delete(seriesId, submissionId, tagId)
-
Deletes the specified tag from the specified submission within the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- submissionId: integer, The decimal ID of the Submission within the Series. (required)
- tagId: string, A parameter (required)
-
-
-
insert(seriesId, submissionId, body)
-
Inserts a new tag for the specified submission within the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- submissionId: integer, The decimal ID of the Submission within the Series. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "text": "A String",
- "kind": "moderator#tag",
- "id": {
- "seriesId": "A String",
- "tagId": "A String",
- "submissionId": "A String",
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "text": "A String",
- "kind": "moderator#tag",
- "id": {
- "seriesId": "A String",
- "tagId": "A String",
- "submissionId": "A String",
- },
- }
-
-
list(seriesId, submissionId)
-
Lists all tags for the specified submission within the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- submissionId: integer, The decimal ID of the Submission within the Series. (required)
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "text": "A String",
- "kind": "moderator#tag",
- "id": {
- "seriesId": "A String",
- "tagId": "A String",
- "submissionId": "A String",
- },
- },
- ],
- "kind": "moderator#tagList",
- }
-
Instance Methods
-
- submissions()
-
-Returns the submissions Resource.
-
-
- get(seriesId, topicId)
-Returns the specified topic from the specified series.
-
- insert(seriesId, body)
-Inserts a new topic into the specified series.
-
- list(seriesId, q=None, max_results=None, mode=None, start_index=None)
-Searches the topics within the specified series and returns the search results.
-
- update(seriesId, topicId, body)
-Updates the specified topic within the specified series.
-Method Details
-
-
get(seriesId, topicId)
-
Returns the specified topic from the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- topicId: integer, The decimal ID of the Topic within the Series. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#topic",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "featuredSubmission": {
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- },
- "presenter": "A String",
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- "name": "A String",
- }
-
-
insert(seriesId, body)
-
Inserts a new topic into the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "moderator#topic",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "featuredSubmission": {
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- },
- "presenter": "A String",
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- "name": "A String",
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#topic",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "featuredSubmission": {
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- },
- "presenter": "A String",
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- "name": "A String",
- }
-
-
list(seriesId, q=None, max_results=None, mode=None, start_index=None)
-
Searches the topics within the specified series and returns the search results.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- q: string, Search query.
- max_results: integer, Maximum number of results to return.
- mode: string, A parameter
- start_index: integer, Index of the first result to be retrieved.
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "kind": "moderator#topic",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "featuredSubmission": {
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- },
- "presenter": "A String",
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- "name": "A String",
- },
- ],
- "kind": "moderator#topicList",
- }
-
-
update(seriesId, topicId, body)
-
Updates the specified topic within the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- topicId: integer, The decimal ID of the Topic within the Series. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "moderator#topic",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "featuredSubmission": {
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- },
- "presenter": "A String",
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- "name": "A String",
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "moderator#topic",
- "description": "A String",
- "rules": {
- "votes": {
- "close": "A String",
- "open": "A String",
- },
- "submissions": {
- "close": "A String",
- "open": "A String",
- },
- },
- "featuredSubmission": {
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- },
- "presenter": "A String",
- "counters": {
- "users": 42,
- "noneVotes": 42,
- "videoSubmissions": 42,
- "minusVotes": 42,
- "submissions": 42,
- "plusVotes": 42,
- },
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- "name": "A String",
- }
-
Instance Methods
-
- list(seriesId, topicId, includeVotes=None, author=None, sort=None, max_results=None, q=None, start_index=None, hasAttachedVideo=None)
-Searches the submissions for the specified topic within the specified series and returns the search results.
-Method Details
-
-
list(seriesId, topicId, includeVotes=None, author=None, sort=None, max_results=None, q=None, start_index=None, hasAttachedVideo=None)
-
Searches the submissions for the specified topic within the specified series and returns the search results.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- topicId: integer, The decimal ID of the Topic within the Series. (required)
- 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.
- max_results: integer, Maximum number of results to return.
- q: string, Search query.
- start_index: integer, Index of the first result to be retrieved.
- hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "kind": "moderator#submission",
- "attribution": {
- "displayName": "A String",
- "location": "A String",
- "avatarUrl": "A String",
- },
- "created": "A String",
- "text": "A String",
- "topics": [
- {
- "id": {
- "seriesId": "A String",
- "topicId": "A String",
- },
- },
- ],
- "author": "A String",
- "translations": [
- {
- "lang": "A String",
- "text": "A String",
- },
- ],
- "parentSubmissionId": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "vote": {
- "vote": "A String",
- "flag": "A String",
- },
- "attachmentUrl": "A String",
- "geo": {
- "latitude": 3.14,
- "location": "A String",
- "longitude": 3.14,
- },
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "counters": {
- "noneVotes": 42,
- "minusVotes": 42,
- "plusVotes": 42,
- },
- },
- ],
- "kind": "moderator#submissionList",
- }
-
Instance Methods
-
- get(seriesId, submissionId, unauthToken=None, userId=None)
-Returns the votes by the authenticated user for the specified submission within the specified series.
-
- insert(seriesId, submissionId, body, unauthToken=None)
-Inserts a new vote by the authenticated user for the specified submission within the specified series.
-
- list(seriesId, max_results=None, start_index=None)
-Lists the votes by the authenticated user for the given series.
-
- patch(seriesId, submissionId, body, unauthToken=None, userId=None)
-Updates the votes by the authenticated user for the specified submission within the specified series. This method supports patch semantics.
-
- update(seriesId, submissionId, body, unauthToken=None, userId=None)
-Updates the votes by the authenticated user for the specified submission within the specified series.
-Method Details
-
-
get(seriesId, submissionId, unauthToken=None, userId=None)
-
Returns the votes by the authenticated user for the specified submission within the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- submissionId: integer, The decimal ID of the Submission within the Series. (required)
- unauthToken: string, User identifier for unauthenticated usage mode
- userId: string, A parameter
-
-Returns:
- An object of the form:
-
- {
- "vote": "A String",
- "flag": "A String",
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "kind": "moderator#vote",
- }
-
-
insert(seriesId, submissionId, body, unauthToken=None)
-
Inserts a new vote by the authenticated user for the specified submission within the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- submissionId: integer, The decimal ID of the Submission within the Series. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "vote": "A String",
- "flag": "A String",
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "kind": "moderator#vote",
- }
-
- unauthToken: string, User identifier for unauthenticated usage mode
-
-Returns:
- An object of the form:
-
- {
- "vote": "A String",
- "flag": "A String",
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "kind": "moderator#vote",
- }
-
-
list(seriesId, max_results=None, start_index=None)
-
Lists the votes by the authenticated user for the given series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- max_results: integer, Maximum number of results to return.
- start_index: integer, Index of the first result to be retrieved.
-
-Returns:
- An object of the form:
-
- {
- "items": [
- {
- "vote": "A String",
- "flag": "A String",
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "kind": "moderator#vote",
- },
- ],
- "kind": "moderator#voteList",
- }
-
-
patch(seriesId, submissionId, body, unauthToken=None, userId=None)
-
Updates the votes by the authenticated user for the specified submission within the specified series. This method supports patch semantics.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- submissionId: integer, The decimal ID of the Submission within the Series. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "vote": "A String",
- "flag": "A String",
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "kind": "moderator#vote",
- }
-
- unauthToken: string, User identifier for unauthenticated usage mode
- userId: string, A parameter
-
-Returns:
- An object of the form:
-
- {
- "vote": "A String",
- "flag": "A String",
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "kind": "moderator#vote",
- }
-
-
update(seriesId, submissionId, body, unauthToken=None, userId=None)
-
Updates the votes by the authenticated user for the specified submission within the specified series.
-
-Args:
- seriesId: integer, The decimal ID of the Series. (required)
- submissionId: integer, The decimal ID of the Submission within the Series. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "vote": "A String",
- "flag": "A String",
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "kind": "moderator#vote",
- }
-
- unauthToken: string, User identifier for unauthenticated usage mode
- userId: string, A parameter
-
-Returns:
- An object of the form:
-
- {
- "vote": "A String",
- "flag": "A String",
- "id": {
- "seriesId": "A String",
- "submissionId": "A String",
- },
- "kind": "moderator#vote",
- }
-
Instance Methods
-
- userinfo()
-
-Returns the userinfo Resource.
-
-
- tokeninfo(access_token=None, id_token=None)
-A description of how to use this function
-Method Details
-
-
tokeninfo(access_token=None, id_token=None)
-
A description of how to use this function
-
-Args:
- access_token: string, A parameter
- id_token: string, A parameter
-
-Returns:
- An object of the form:
-
- {
- "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 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.
- "verified_email": True or False, # Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.
- }
-
Instance Methods
-
- v2()
-
-Returns the v2 Resource.
-
-
- get()
-A description of how to use this function
-Method Details
-
-
get()
-
A description of how to use this function
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "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.
- "id": "A String", # The focus obfuscated gaia id of the user.
- "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.
- "email": "A String", # The user's email address.
- "hd": "A String", # The hosted domain e.g. example.com if the user is Google apps user.
- "verified_email": True or False, # Boolean flag which is true if the email address is verified.
- }
-
Instance Methods
-
- me()
-
-Returns the me Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/oauth2_v2.userinfo.v2.me.html b/docs/dyn/oauth2_v2.userinfo.v2.me.html
deleted file mode 100644
index 0f796b1..0000000
--- a/docs/dyn/oauth2_v2.userinfo.v2.me.html
+++ /dev/null
@@ -1,107 +0,0 @@
-
-
-
-
-Instance Methods
-
- get()
-A description of how to use this function
-Method Details
-
-
get()
-
A description of how to use this function
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "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.
- "id": "A String", # The focus obfuscated gaia id of the user.
- "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.
- "email": "A String", # The user's email address.
- "hd": "A String", # The hosted domain e.g. example.com if the user is Google apps user.
- "verified_email": True or False, # Boolean flag which is true if the email address is verified.
- }
-
Instance Methods
-
- delete(activityId, userId)
-Excludes an element from the ACL of the activity.
-Method Details
-
-
delete(activityId, userId)
-
Excludes an element from the ACL of the activity.
-
-Args:
- activityId: string, ID of the activity. (required)
- userId: string, ID of the user to be removed from the activity. (required)
-
-
Instance Methods
-
- delete(activityId)
-Deletes an existing activity, if the access controls allow it.
-
- list(userId, collection, pageToken=None, hl=None, maxResults=None)
-Retrieves a list of activities.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(activityId)
-
Deletes an existing activity, if the access controls allow it.
-
-Args:
- activityId: string, ID of the activity to remove. (required)
-
-
-
list(userId, collection, pageToken=None, hl=None, maxResults=None)
-
Retrieves a list of activities.
-
-Args:
- 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)
- 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.
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of activities to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in activities.list request to get the next page, if there are more to retrieve.
- "items": [ # List of activities retrieved.
- {
- "kind": "orkut#activity", # The kind of activity. Always orkut#activity.
- "links": [ # Links to resources related to this activity.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "title": "A String", # Title of the activity.
- "object": { # The activity's object.
- "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
- "items": [ # The list of additional items.
- {
- "displayName": "A String", # The title of the object.
- "links": [ # Links to other resources related to this object.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "community": { # The community which is related with this activity, e.g. a joined community.
- "category": "A String", # The category of the community.
- "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
- "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.
- "description": "A String", # The description of the community.
- "language": "A String", # The official language of the community.
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "creation_date": "A String", # The time the community was created, in RFC 3339 format.
- "owner": { # The person who owns the community.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "moderators": [ # The list of moderators of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "location": "A String", # The location of the community.
- "co_owners": [ # The co-owners of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "photo_url": "A String", # The photo of the community.
- "id": 42, # The id of the community.
- "name": "A String", # The name of the community.
- },
- "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
- "person": { # The person who is related with this activity, e.g. an Added User.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "id": "A String", # The ID for the object.
- "objectType": "A String", # The object type.
- },
- ],
- "replies": { # Comments in reply to this activity.
- "totalItems": "A String", # Total number of comments.
- "items": [ # The list of comments.
- {
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
- },
- ],
- "url": "A String", # URL for the collection of comments in reply to this activity.
- },
- "objectType": "A String", # The type of the object affected by the activity. Clients can use this information to style the rendered activity object differently depending on the content.
- },
- "updated": "A String", # The time at which the activity was last updated.
- "actor": { # The person who performed the activity.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "access": { # Identifies who has access to see this activity.
- "items": [ # The list of ACL entries.
- {
- "type": "A String", # The type of entity to whom access is granted.
- "id": "A String", # The ID of the entity. For entities of type "person" or "circle", this is the ID of the resource. For other types, this will be unset.
- },
- ],
- "kind": "orkut#acl", # Identifies this resource as an access control list. Value: "orkut#acl"
- "description": "A String", # Human readable description of the access granted.
- "totalParticipants": 42, # The total count of participants of the parent resource.
- },
- "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
- # - add - User added new content to profile or album, e.g. video, photo.
- # - post - User publish content to the stream, e.g. status, scrap.
- # - update - User commented on an activity.
- # - make-friend - User added a new friend.
- # - birthday - User has a birthday.
- "published": "A String", # The time at which the activity was initially published.
- "id": "A String", # The ID for the activity.
- },
- ],
- "kind": "orkut#activityList", # Identifies this resource as a collection of activities. Value: "orkut#activityList"
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(activityId)
-Gets the visibility of an existing activity.
-
- patch(activityId, body)
-Updates the visibility of an existing activity. This method supports patch semantics.
-
- update(activityId, body)
-Updates the visibility of an existing activity.
-Method Details
-
-
get(activityId)
-
Gets the visibility of an existing activity.
-
-Args:
- activityId: string, ID of the activity to get the visibility. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
- "visibility": "A String", # The visibility of the resource. Possible values are:
- # - default: not hidden by the user
- # - hidden: hidden
- "links": [ # List of resources for the visibility item.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- }
-
-
patch(activityId, body)
-
Updates the visibility of an existing activity. This method supports patch semantics.
-
-Args:
- activityId: string, ID of the activity. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
- "visibility": "A String", # The visibility of the resource. Possible values are:
- # - default: not hidden by the user
- # - hidden: hidden
- "links": [ # List of resources for the visibility item.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
- "visibility": "A String", # The visibility of the resource. Possible values are:
- # - default: not hidden by the user
- # - hidden: hidden
- "links": [ # List of resources for the visibility item.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- }
-
-
update(activityId, body)
-
Updates the visibility of an existing activity.
-
-Args:
- activityId: string, ID of the activity. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
- "visibility": "A String", # The visibility of the resource. Possible values are:
- # - default: not hidden by the user
- # - hidden: hidden
- "links": [ # List of resources for the visibility item.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"
- "visibility": "A String", # The visibility of the resource. Possible values are:
- # - default: not hidden by the user
- # - hidden: hidden
- "links": [ # List of resources for the visibility item.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- }
-
Instance Methods
-
- get(userId, badgeId)
-Retrieves a badge from a user.
-
- list(userId)
-Retrieves the list of visible badges of a user.
-Method Details
-
-
get(userId, badgeId)
-
Retrieves a badge from a user.
-
-Args:
- userId: string, The ID of the user whose badges will be listed. Can be me to refer to caller. (required)
- badgeId: string, The ID of the badge that will be retrieved. (required)
-
-Returns:
- An object of the form:
-
- {
- "badgeSmallLogo": "A String", # The URL for the 24x24 badge logo.
- "kind": "orkut#badge", # Identifies this resource as a badge. Value: "orkut#badge"
- "description": "A String", # The description for the badge, suitable for display.
- "sponsorLogo": "A String", # The URL for the 32x32 badge sponsor logo.
- "sponsorName": "A String", # The name of the badge sponsor, suitable for display.
- "badgeLargeLogo": "A String", # The URL for the 64x64 badge logo.
- "caption": "A String", # The name of the badge, suitable for display.
- "sponsorUrl": "A String", # The URL for the badge sponsor.
- "id": "A String", # The unique ID for the badge.
- }
-
-
list(userId)
-
Retrieves the list of visible badges of a user.
-
-Args:
- userId: string, The id of the user whose badges will be listed. Can be me to refer to caller. (required)
-
-Returns:
- An object of the form:
-
- {
- "items": [ # List of badges retrieved.
- {
- "badgeSmallLogo": "A String", # The URL for the 24x24 badge logo.
- "kind": "orkut#badge", # Identifies this resource as a badge. Value: "orkut#badge"
- "description": "A String", # The description for the badge, suitable for display.
- "sponsorLogo": "A String", # The URL for the 32x32 badge sponsor logo.
- "sponsorName": "A String", # The name of the badge sponsor, suitable for display.
- "badgeLargeLogo": "A String", # The URL for the 64x64 badge logo.
- "caption": "A String", # The name of the badge, suitable for display.
- "sponsorUrl": "A String", # The URL for the badge sponsor.
- "id": "A String", # The unique ID for the badge.
- },
- ],
- "kind": "orkut#badgeList", # Identifies this resource as a collection of badges. Value: "orkut#badgeList"
- }
-
Instance Methods
-
- delete(commentId)
-Deletes an existing comment.
-
- get(commentId, hl=None)
-Retrieves an existing comment.
-
- insert(activityId, body)
-Inserts a new comment to an activity.
-
- list(activityId, orderBy=None, pageToken=None, hl=None, maxResults=None)
-Retrieves a list of comments, possibly filtered.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(commentId)
-
Deletes an existing comment.
-
-Args:
- commentId: string, ID of the comment to remove. (required)
-
-
-
get(commentId, hl=None)
-
Retrieves an existing comment.
-
-Args:
- commentId: string, ID of the comment to get. (required)
- hl: string, Specifies the interface language (host language) of your user interface.
-
-Returns:
- An object of the form:
-
- {
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
- }
-
-
insert(activityId, body)
-
Inserts a new comment to an activity.
-
-Args:
- activityId: string, The ID of the activity to contain the new comment. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
-}
-
-
-Returns:
- An object of the form:
-
- {
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
- }
-
-
list(activityId, orderBy=None, pageToken=None, hl=None, maxResults=None)
-
Retrieves a list of comments, possibly filtered.
-
-Args:
- activityId: string, The ID of the activity containing the comments. (required)
- orderBy: string, Sort search results.
- Allowed values
- ascending - Use ascending sort order.
- descending - Use descending sort order.
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of activities to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in comments.list request to get the next page, if there are more to retrieve.
- "items": [ # List of comments retrieved.
- {
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
- },
- ],
- "kind": "orkut#commentList", # Identifies this resource as a collection of comments. Value: "orkut#commentList"
- "previousPageToken": "A String", # The value of pageToken query parameter in comments.list request to get the previous page, if there are more to retrieve.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(communityId, hl=None)
-Retrieves the basic information (aka. profile) of a community.
-
- list(userId, orderBy=None, hl=None, maxResults=None)
-Retrieves the list of communities the current user is a member of.
-Method Details
-
-
get(communityId, hl=None)
-
Retrieves the basic information (aka. profile) of a community.
-
-Args:
- communityId: integer, The ID of the community to get. (required)
- hl: string, Specifies the interface language (host language) of your user interface.
-
-Returns:
- An object of the form:
-
- {
- "category": "A String", # The category of the community.
- "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
- "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.
- "description": "A String", # The description of the community.
- "language": "A String", # The official language of the community.
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "creation_date": "A String", # The time the community was created, in RFC 3339 format.
- "owner": { # The person who owns the community.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "moderators": [ # The list of moderators of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "location": "A String", # The location of the community.
- "co_owners": [ # The co-owners of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "photo_url": "A String", # The photo of the community.
- "id": 42, # The id of the community.
- "name": "A String", # The name of the community.
- }
-
-
list(userId, orderBy=None, hl=None, maxResults=None)
-
Retrieves the list of communities the current user is a member of.
-
-Args:
- userId: string, The ID of the user whose communities will be listed. Can be me to refer to caller. (required)
- orderBy: string, How to order the communities by.
- 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.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of communities to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # List of communities retrieved.
- {
- "category": "A String", # The category of the community.
- "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
- "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.
- "description": "A String", # The description of the community.
- "language": "A String", # The official language of the community.
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "creation_date": "A String", # The time the community was created, in RFC 3339 format.
- "owner": { # The person who owns the community.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "moderators": [ # The list of moderators of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "location": "A String", # The location of the community.
- "co_owners": [ # The co-owners of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "photo_url": "A String", # The photo of the community.
- "id": 42, # The id of the community.
- "name": "A String", # The name of the community.
- },
- ],
- "kind": "orkut#communityList", # Identifies this resource as a collection of communities. Value: "orkut#communityList"
- }
-
Instance Methods
-
- delete(communityId, userId)
-Removes a user from the followers of a community.
-
- insert(communityId, userId)
-Adds a user as a follower of a community.
-Method Details
-
-
delete(communityId, userId)
-
Removes a user from the followers of a community.
-
-Args:
- communityId: integer, ID of the community. (required)
- userId: string, ID of the user. (required)
-
-
-
insert(communityId, userId)
-
Adds a user as a follower of a community.
-
-Args:
- communityId: integer, ID of the community. (required)
- userId: string, ID of the user. (required)
-
-Returns:
- An object of the form:
-
- {
- "communityMembershipStatus": { # Status and permissions of the user related to the community.
- "status": "A String", # The status of the current link between the community and the user.
- "isFollowing": True or False, # Whether the user is following this community.
- "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
- "isModerator": True or False, # Whether the session user is a community moderator.
- "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
- "isCoOwner": True or False, # Whether the session user is a community co-owner.
- "canCreatePoll": True or False, # Whether the user can create a poll in this community.
- "canShout": True or False, # Whether the user can perform a shout operation in this community.
- "isOwner": True or False, # Whether the session user is the community owner.
- "canCreateTopic": True or False, # Whether the user can create a topic in this community.
- "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
- },
- "person": { # Description of the community member.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
- }
-
Instance Methods
-
- delete(communityId, userId)
-Makes the user leave a community.
-
- get(communityId, userId, hl=None)
-Retrieves the relationship between a user and a community.
-
- insert(communityId, userId)
-Makes the user join a community.
-
- list(communityId, friendsOnly=None, pageToken=None, hl=None, maxResults=None)
-Lists members of a community. Use the pagination tokens to retrieve the full list; do not rely on the member count available in the community profile information to know when to stop iterating, as that count may be approximate.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(communityId, userId)
-
Makes the user leave a community.
-
-Args:
- communityId: integer, ID of the community. (required)
- userId: string, ID of the user. (required)
-
-
-
get(communityId, userId, hl=None)
-
Retrieves the relationship between a user and a community.
-
-Args:
- communityId: integer, ID of the community. (required)
- userId: string, ID of the user. (required)
- hl: string, Specifies the interface language (host language) of your user interface.
-
-Returns:
- An object of the form:
-
- {
- "communityMembershipStatus": { # Status and permissions of the user related to the community.
- "status": "A String", # The status of the current link between the community and the user.
- "isFollowing": True or False, # Whether the user is following this community.
- "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
- "isModerator": True or False, # Whether the session user is a community moderator.
- "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
- "isCoOwner": True or False, # Whether the session user is a community co-owner.
- "canCreatePoll": True or False, # Whether the user can create a poll in this community.
- "canShout": True or False, # Whether the user can perform a shout operation in this community.
- "isOwner": True or False, # Whether the session user is the community owner.
- "canCreateTopic": True or False, # Whether the user can create a topic in this community.
- "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
- },
- "person": { # Description of the community member.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
- }
-
-
insert(communityId, userId)
-
Makes the user join a community.
-
-Args:
- communityId: integer, ID of the community. (required)
- userId: string, ID of the user. (required)
-
-Returns:
- An object of the form:
-
- {
- "communityMembershipStatus": { # Status and permissions of the user related to the community.
- "status": "A String", # The status of the current link between the community and the user.
- "isFollowing": True or False, # Whether the user is following this community.
- "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
- "isModerator": True or False, # Whether the session user is a community moderator.
- "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
- "isCoOwner": True or False, # Whether the session user is a community co-owner.
- "canCreatePoll": True or False, # Whether the user can create a poll in this community.
- "canShout": True or False, # Whether the user can perform a shout operation in this community.
- "isOwner": True or False, # Whether the session user is the community owner.
- "canCreateTopic": True or False, # Whether the user can create a topic in this community.
- "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
- },
- "person": { # Description of the community member.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
- }
-
-
list(communityId, friendsOnly=None, pageToken=None, hl=None, maxResults=None)
-
Lists members of a community. Use the pagination tokens to retrieve the full list; do not rely on the member count available in the community profile information to know when to stop iterating, as that count may be approximate.
-
-Args:
- communityId: integer, The ID of the community whose members will be listed. (required)
- friendsOnly: boolean, Whether to list only community members who are friends of the user.
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of members to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the next page, if there are more to retrieve.
- "kind": "orkut#communityMembersList", # Kind of this item. Always orkut#communityMembersList.
- "items": [ # List of community members retrieved.
- {
- "communityMembershipStatus": { # Status and permissions of the user related to the community.
- "status": "A String", # The status of the current link between the community and the user.
- "isFollowing": True or False, # Whether the user is following this community.
- "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
- "isModerator": True or False, # Whether the session user is a community moderator.
- "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
- "isCoOwner": True or False, # Whether the session user is a community co-owner.
- "canCreatePoll": True or False, # Whether the user can create a poll in this community.
- "canShout": True or False, # Whether the user can perform a shout operation in this community.
- "isOwner": True or False, # Whether the session user is the community owner.
- "canCreateTopic": True or False, # Whether the user can create a topic in this community.
- "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
- },
- "person": { # Description of the community member.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
- },
- ],
- "prevPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the previous page, if there are more to retrieve.
- "lastPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the last page.
- "firstPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the first page.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- delete(communityId, topicId, messageId)
-Moves a message of the community to the trash folder.
-
- insert(communityId, topicId, body)
-Adds a message to a given community topic.
-
- list(communityId, topicId, pageToken=None, hl=None, maxResults=None)
-Retrieves the messages of a topic of a community.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(communityId, topicId, messageId)
-
Moves a message of the community to the trash folder.
-
-Args:
- communityId: integer, The ID of the community whose message will be moved to the trash folder. (required)
- topicId: string, The ID of the topic whose message will be moved to the trash folder. (required)
- messageId: string, The ID of the message to be moved to the trash folder. (required)
-
-
-
insert(communityId, topicId, body)
-
Adds a message to a given community topic.
-
-Args:
- communityId: integer, The ID of the community the message should be added to. (required)
- topicId: string, The ID of the topic the message should be added to. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- }
-
-
list(communityId, topicId, pageToken=None, hl=None, maxResults=None)
-
Retrieves the messages of a topic of a community.
-
-Args:
- communityId: integer, The ID of the community which messages will be listed. (required)
- topicId: string, The ID of the topic which messages will be listed. (required)
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of messages to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in community_messages.list request to get the next page, if there are more to retrieve.
- "kind": "orkut#communityMessageList", # Identifies this resource as a collection of community messages. Value: "orkut#communityMessageList"
- "items": [ # List of messages retrieved.
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- },
- ],
- "prevPageToken": "A String", # The value of pageToken query parameter in community_messages.list request to get the previous page, if there are more to retrieve.
- "lastPageToken": "A String", # The value of pageToken query parameter in community_messages.list request to get the last page.
- "firstPageToken": "A String", # The value of pageToken query parameter in community_messages.list request to get the first page.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- insert(communityId, pollId, body)
-Adds a comment on a community poll.
-
- list(communityId, pollId, pageToken=None, hl=None, maxResults=None)
-Retrieves the comments of a community poll.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
insert(communityId, pollId, body)
-
Adds a comment on a community poll.
-
-Args:
- communityId: integer, The ID of the community whose poll is being commented. (required)
- pollId: string, The ID of the poll being commented. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "body": "A String", # The body of the message.
- "kind": "orkut#communityPollComment", # Identifies this resource as a community poll comment. Value: "orkut#communityPollComment"
- "addedDate": "A String", # The date when the message was added, in RFC 3339 format.
- "id": 42, # The ID of the comment.
- "author": { # The creator of the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityPollComment", # Identifies this resource as a community poll comment. Value: "orkut#communityPollComment"
- "addedDate": "A String", # The date when the message was added, in RFC 3339 format.
- "id": 42, # The ID of the comment.
- "author": { # The creator of the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- }
-
-
list(communityId, pollId, pageToken=None, hl=None, maxResults=None)
-
Retrieves the comments of a community poll.
-
-Args:
- 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)
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of comments to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in community_poll_comments.list request to get the next page, if there are more to retrieve.
- "kind": "orkut#CommunityPollCommentList", # Identifies this resource as a collection of community poll comments. Value: "orkut#CommunityPollCommentList"
- "items": [ # List of community poll comments retrieved.
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityPollComment", # Identifies this resource as a community poll comment. Value: "orkut#communityPollComment"
- "addedDate": "A String", # The date when the message was added, in RFC 3339 format.
- "id": 42, # The ID of the comment.
- "author": { # The creator of the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- },
- ],
- "prevPageToken": "A String", # The value of pageToken query parameter in community_poll_comments.list request to get the previous page, if there are more to retrieve.
- "lastPageToken": "A String", # The value of pageToken query parameter in community_poll_comments.list request to get the last page.
- "firstPageToken": "A String", # The value of pageToken query parameter in community_poll_comments.list request to get the first page.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- insert(communityId, pollId, body)
-Votes on a community poll.
-Method Details
-
-
insert(communityId, pollId, body)
-
Votes on a community poll.
-
-Args:
- communityId: integer, The ID of the community whose poll is being voted. (required)
- pollId: string, The ID of the poll being voted. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "orkut#communityPollVote", # Identifies this resource as a community poll vote. Value: "orkut#communityPollVote"
- "optionIds": [ # The ids of the voted options.
- 42,
- ],
- "isVotevisible": True or False, # Whether this vote is visible to other users or not.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "orkut#communityPollVote", # Identifies this resource as a community poll vote. Value: "orkut#communityPollVote"
- "optionIds": [ # The ids of the voted options.
- 42,
- ],
- "isVotevisible": True or False, # Whether this vote is visible to other users or not.
- }
-
Instance Methods
-
- get(communityId, pollId, hl=None)
-Retrieves one specific poll of a community.
-
- list(communityId, pageToken=None, hl=None, maxResults=None)
-Retrieves the polls of a community.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(communityId, pollId, hl=None)
-
Retrieves one specific poll of a community.
-
-Args:
- communityId: integer, The ID of the community for whose poll will be retrieved. (required)
- pollId: string, The ID of the poll to get. (required)
- hl: string, Specifies the interface language (host language) of your user interface.
-
-Returns:
- An object of the form:
-
- {
- "links": [ # List of resources for the community poll.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "isMultipleAnswers": True or False, # Whether this poll allows voting for more than one option.
- "image": { # The image representing the poll. Field is omitted if no image exists.
- "url": "A String", # A URL that points to an image of the poll.
- },
- "endingTime": "A String", # The ending date of this poll or empty if the poll doesn't have one.
- "isVotingAllowedForNonMembers": True or False, # Whether non-members of the community can vote on the poll.
- "isSpam": True or False, # Whether the user has marked this poll as spam. This only affects the poll for this user, not globally.
- "totalNumberOfVotes": 42, # The total number of votes this poll has received.
- "author": { # The person who created the poll.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "question": "A String", # The poll question.
- "id": "A String", # The poll ID.
- "isRestricted": True or False, # Whether this poll is restricted for members only. If a poll is open but the user can't vote on it, it's been restricted to members only. This information is important to tell this case apart from the one where the user can't vote simply because the poll is already closed.
- "communityId": 42, # The ID of the community.
- "isUsersVotePublic": True or False, # If user has already voted, whether his vote is publicly visible.
- "lastUpdate": "A String", # The date of the last update of this poll.
- "description": "A String", # The poll description.
- "votedOptions": [ # List of options the user has voted on, if there are any.
- 42,
- ],
- "isOpenForVoting": True or False, # Whether this poll is still opened for voting. A poll is open for voting if it is not closed, the user has not yet voted on it and the user has the permission to do so, which happens if he/she is either a community member or the poll is open for everybody.
- "isClosed": True or False, # Whether the poll is not expired if there is an expiration date. A poll is open (that is, not closed for voting) if it either is not expired or doesn't have an expiration date at all. Note that just because a poll is open, it doesn't mean that the requester can vote on it.
- "hasVoted": True or False, # Whether the user has voted on this poll.
- "kind": "orkut#communityPoll", # Identifies this resource as a community poll. Value: "orkut#communityPoll"
- "creationTime": "A String", # The date of creation of this poll
- "options": [ # List of options of this poll.
- {
- "image": { # Image data about the poll option. Field is omitted if no image exists.
- "url": "A String", # A URL that points to an image of the poll question.
- },
- "optionId": 42, # The poll option ID
- "description": "A String", # The option description.
- "numberOfVotes": 42, # The total number of votes that this option received.
- },
- ],
- }
-
-
list(communityId, pageToken=None, hl=None, maxResults=None)
-
Retrieves the polls of a community.
-
-Args:
- communityId: integer, The ID of the community which polls will be listed. (required)
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of polls to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in community_polls.list request to get the next page, if there are more to retrieve.
- "kind": "orkut#communityPollList", # Identifies this resource as a collection of community polls. Value: "orkut#communityPollList"
- "items": [ # List of community polls retrieved.
- {
- "links": [ # List of resources for the community poll.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "isMultipleAnswers": True or False, # Whether this poll allows voting for more than one option.
- "image": { # The image representing the poll. Field is omitted if no image exists.
- "url": "A String", # A URL that points to an image of the poll.
- },
- "endingTime": "A String", # The ending date of this poll or empty if the poll doesn't have one.
- "isVotingAllowedForNonMembers": True or False, # Whether non-members of the community can vote on the poll.
- "isSpam": True or False, # Whether the user has marked this poll as spam. This only affects the poll for this user, not globally.
- "totalNumberOfVotes": 42, # The total number of votes this poll has received.
- "author": { # The person who created the poll.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "question": "A String", # The poll question.
- "id": "A String", # The poll ID.
- "isRestricted": True or False, # Whether this poll is restricted for members only. If a poll is open but the user can't vote on it, it's been restricted to members only. This information is important to tell this case apart from the one where the user can't vote simply because the poll is already closed.
- "communityId": 42, # The ID of the community.
- "isUsersVotePublic": True or False, # If user has already voted, whether his vote is publicly visible.
- "lastUpdate": "A String", # The date of the last update of this poll.
- "description": "A String", # The poll description.
- "votedOptions": [ # List of options the user has voted on, if there are any.
- 42,
- ],
- "isOpenForVoting": True or False, # Whether this poll is still opened for voting. A poll is open for voting if it is not closed, the user has not yet voted on it and the user has the permission to do so, which happens if he/she is either a community member or the poll is open for everybody.
- "isClosed": True or False, # Whether the poll is not expired if there is an expiration date. A poll is open (that is, not closed for voting) if it either is not expired or doesn't have an expiration date at all. Note that just because a poll is open, it doesn't mean that the requester can vote on it.
- "hasVoted": True or False, # Whether the user has voted on this poll.
- "kind": "orkut#communityPoll", # Identifies this resource as a community poll. Value: "orkut#communityPoll"
- "creationTime": "A String", # The date of creation of this poll
- "options": [ # List of options of this poll.
- {
- "image": { # Image data about the poll option. Field is omitted if no image exists.
- "url": "A String", # A URL that points to an image of the poll question.
- },
- "optionId": 42, # The poll option ID
- "description": "A String", # The option description.
- "numberOfVotes": 42, # The total number of votes that this option received.
- },
- ],
- },
- ],
- "prevPageToken": "A String", # The value of pageToken query parameter in community_polls.list request to get the previous page, if there are more to retrieve.
- "lastPageToken": "A String", # The value of pageToken query parameter in community_polls.list request to get the last page.
- "firstPageToken": "A String", # The value of pageToken query parameter in community_polls.list request to get the first page.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(communityId, hl=None)
-Retrieves the communities related to another one.
-Method Details
-
-
list(communityId, hl=None)
-
Retrieves the communities related to another one.
-
-Args:
- communityId: integer, The ID of the community whose related communities will be listed. (required)
- hl: string, Specifies the interface language (host language) of your user interface.
-
-Returns:
- An object of the form:
-
- {
- "items": [ # List of communities retrieved.
- {
- "category": "A String", # The category of the community.
- "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
- "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.
- "description": "A String", # The description of the community.
- "language": "A String", # The official language of the community.
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "creation_date": "A String", # The time the community was created, in RFC 3339 format.
- "owner": { # The person who owns the community.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "moderators": [ # The list of moderators of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "location": "A String", # The location of the community.
- "co_owners": [ # The co-owners of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "photo_url": "A String", # The photo of the community.
- "id": 42, # The id of the community.
- "name": "A String", # The name of the community.
- },
- ],
- "kind": "orkut#communityList", # Identifies this resource as a collection of communities. Value: "orkut#communityList"
- }
-
Instance Methods
-
- delete(communityId, topicId)
-Moves a topic of the community to the trash folder.
-
- get(communityId, topicId, hl=None)
-Retrieves a topic of a community.
-
- insert(communityId, body, isShout=None)
-Adds a topic to a given community.
-
- list(communityId, pageToken=None, hl=None, maxResults=None)
-Retrieves the topics of a community.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
delete(communityId, topicId)
-
Moves a topic of the community to the trash folder.
-
-Args:
- communityId: integer, The ID of the community whose topic will be moved to the trash folder. (required)
- topicId: string, The ID of the topic to be moved to the trash folder. (required)
-
-
-
get(communityId, topicId, hl=None)
-
Retrieves a topic of a community.
-
-Args:
- communityId: integer, The ID of the community whose topic will be retrieved. (required)
- topicId: string, The ID of the topic to get. (required)
- hl: string, Specifies the interface language (host language) of your user interface.
-
-Returns:
- An object of the form:
-
- {
- "body": "A String", # The body of the topic.
- "lastUpdate": "A String", # The timestamp of the last update, in RFC 3339 format.
- "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the topic.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "title": "A String", # The title of the topic.
- "messages": [ # Most recent messages.
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- },
- ],
- "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.
- "isClosed": True or False, # Whether the topic is closed for new messages.
- "numberOfReplies": 42, # The total number of replies this topic has received.
- "id": "A String", # The ID of the topic.
- }
-
-
insert(communityId, body, isShout=None)
-
Adds a topic to a given community.
-
-Args:
- communityId: integer, The ID of the community the topic should be added to. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "body": "A String", # The body of the topic.
- "lastUpdate": "A String", # The timestamp of the last update, in RFC 3339 format.
- "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the topic.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "title": "A String", # The title of the topic.
- "messages": [ # Most recent messages.
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- },
- ],
- "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.
- "isClosed": True or False, # Whether the topic is closed for new messages.
- "numberOfReplies": 42, # The total number of replies this topic has received.
- "id": "A String", # The ID of the topic.
- }
-
- isShout: boolean, Whether this topic is a shout.
-
-Returns:
- An object of the form:
-
- {
- "body": "A String", # The body of the topic.
- "lastUpdate": "A String", # The timestamp of the last update, in RFC 3339 format.
- "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the topic.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "title": "A String", # The title of the topic.
- "messages": [ # Most recent messages.
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- },
- ],
- "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.
- "isClosed": True or False, # Whether the topic is closed for new messages.
- "numberOfReplies": 42, # The total number of replies this topic has received.
- "id": "A String", # The ID of the topic.
- }
-
-
list(communityId, pageToken=None, hl=None, maxResults=None)
-
Retrieves the topics of a community.
-
-Args:
- communityId: integer, The ID of the community which topics will be listed. (required)
- pageToken: string, A continuation token that allows pagination.
- hl: string, Specifies the interface language (host language) of your user interface.
- maxResults: integer, The maximum number of topics to include in the response.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the next page, if there are more to retrieve.
- "kind": "orkut#communityTopicList", # Identifies this resource as a collection of community topics. Value: "orkut#communityTopicList"
- "items": [ # List of topics retrieved.
- {
- "body": "A String", # The body of the topic.
- "lastUpdate": "A String", # The timestamp of the last update, in RFC 3339 format.
- "kind": "orkut#communityTopic", # Identifies this resource as a community topic. Value: "orkut#communityTopic"
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the topic.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "title": "A String", # The title of the topic.
- "messages": [ # Most recent messages.
- {
- "body": "A String", # The body of the message.
- "kind": "orkut#communityMessage", # Identifies this resource as a community message. Value: "orkut#communityMessage"
- "links": [ # List of resources for the community message.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "author": { # The creator of the message. If ommited, the message is annonimous.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "id": "A String", # The ID of the message.
- "addedDate": "A String", # The timestamp of the date when the message was added, in RFC 3339 format.
- "isSpam": True or False, # Whether this post was marked as spam by the viewer, when he/she is not the community owner or one of its moderators.
- "subject": "A String", # The subject of the message.
- },
- ],
- "latestMessageSnippet": "A String", # Snippet of the last message posted on this topic.
- "isClosed": True or False, # Whether the topic is closed for new messages.
- "numberOfReplies": 42, # The total number of replies this topic has received.
- "id": "A String", # The ID of the topic.
- },
- ],
- "prevPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the previous page, if there are more to retrieve.
- "lastPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the last page.
- "firstPageToken": "A String", # The value of pageToken query parameter in community_topic.list request to get the first page.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list(userId)
-Retrieves the counters of a user.
-Method Details
-
-
list(userId)
-
Retrieves the counters of a user.
-
-Args:
- userId: string, The ID of the user whose counters will be listed. Can be me to refer to caller. (required)
-
-Returns:
- An object of the form:
-
- {
- "items": [ # List of counters retrieved.
- {
- "total": 42, # The number of resources on the counted collection.
- "link": { # Links to resources related to the parent object. # Link to the collection being counted.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- "name": "A String", # The name of the counted collection. Currently supported collections are:
- # - scraps - The scraps of the user.
- # - photos - The photos of the user.
- # - videos - The videos of the user.
- # - pendingTestimonials - The pending testimonials of the user.
- },
- ],
- "kind": "orkut#counters", # Identifies this resource as a collection of counters. Value: "orkut#counters"
- }
-
Instance Methods
-
- acl()
-
-Returns the acl Resource.
-
-
- activities()
-
-Returns the activities Resource.
-
-
- activityVisibility()
-
-Returns the activityVisibility Resource.
-
-
- badges()
-
-Returns the badges Resource.
-
-
- comments()
-
-Returns the comments Resource.
-
-
- communities()
-
-Returns the communities Resource.
-
-
- communityFollow()
-
-Returns the communityFollow Resource.
-
-
- communityMembers()
-
-Returns the communityMembers Resource.
-
-
- communityMessages()
-
-Returns the communityMessages Resource.
-
-
- communityPollComments()
-
-Returns the communityPollComments Resource.
-
-
- communityPollVotes()
-
-Returns the communityPollVotes Resource.
-
-
- communityPolls()
-
-Returns the communityPolls Resource.
-
-
- communityRelated()
-
-Returns the communityRelated Resource.
-
-
- communityTopics()
-
-Returns the communityTopics Resource.
-
-
- counters()
-
-Returns the counters Resource.
-
-
- scraps()
-
-Returns the scraps Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/orkut_v2.scraps.html b/docs/dyn/orkut_v2.scraps.html
deleted file mode 100644
index 3aff5dc..0000000
--- a/docs/dyn/orkut_v2.scraps.html
+++ /dev/null
@@ -1,406 +0,0 @@
-
-
-
-
-Instance Methods
-
- insert(body)
-Creates a new scrap.
-Method Details
-
-
insert(body)
-
Creates a new scrap.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "orkut#activity", # The kind of activity. Always orkut#activity.
- "links": [ # Links to resources related to this activity.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "title": "A String", # Title of the activity.
- "object": { # The activity's object.
- "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
- "items": [ # The list of additional items.
- {
- "displayName": "A String", # The title of the object.
- "links": [ # Links to other resources related to this object.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "community": { # The community which is related with this activity, e.g. a joined community.
- "category": "A String", # The category of the community.
- "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
- "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.
- "description": "A String", # The description of the community.
- "language": "A String", # The official language of the community.
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "creation_date": "A String", # The time the community was created, in RFC 3339 format.
- "owner": { # The person who owns the community.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "moderators": [ # The list of moderators of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "location": "A String", # The location of the community.
- "co_owners": [ # The co-owners of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "photo_url": "A String", # The photo of the community.
- "id": 42, # The id of the community.
- "name": "A String", # The name of the community.
- },
- "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
- "person": { # The person who is related with this activity, e.g. an Added User.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "id": "A String", # The ID for the object.
- "objectType": "A String", # The object type.
- },
- ],
- "replies": { # Comments in reply to this activity.
- "totalItems": "A String", # Total number of comments.
- "items": [ # The list of comments.
- {
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
- },
- ],
- "url": "A String", # URL for the collection of comments in reply to this activity.
- },
- "objectType": "A String", # The type of the object affected by the activity. Clients can use this information to style the rendered activity object differently depending on the content.
- },
- "updated": "A String", # The time at which the activity was last updated.
- "actor": { # The person who performed the activity.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "access": { # Identifies who has access to see this activity.
- "items": [ # The list of ACL entries.
- {
- "type": "A String", # The type of entity to whom access is granted.
- "id": "A String", # The ID of the entity. For entities of type "person" or "circle", this is the ID of the resource. For other types, this will be unset.
- },
- ],
- "kind": "orkut#acl", # Identifies this resource as an access control list. Value: "orkut#acl"
- "description": "A String", # Human readable description of the access granted.
- "totalParticipants": 42, # The total count of participants of the parent resource.
- },
- "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
- # - add - User added new content to profile or album, e.g. video, photo.
- # - post - User publish content to the stream, e.g. status, scrap.
- # - update - User commented on an activity.
- # - make-friend - User added a new friend.
- # - birthday - User has a birthday.
- "published": "A String", # The time at which the activity was initially published.
- "id": "A String", # The ID for the activity.
-}
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "orkut#activity", # The kind of activity. Always orkut#activity.
- "links": [ # Links to resources related to this activity.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "title": "A String", # Title of the activity.
- "object": { # The activity's object.
- "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
- "items": [ # The list of additional items.
- {
- "displayName": "A String", # The title of the object.
- "links": [ # Links to other resources related to this object.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "community": { # The community which is related with this activity, e.g. a joined community.
- "category": "A String", # The category of the community.
- "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"
- "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.
- "description": "A String", # The description of the community.
- "language": "A String", # The official language of the community.
- "links": [ # List of resources for the community.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "creation_date": "A String", # The time the community was created, in RFC 3339 format.
- "owner": { # The person who owns the community.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "moderators": [ # The list of moderators of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "location": "A String", # The location of the community.
- "co_owners": [ # The co-owners of the community.
- {
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- ],
- "photo_url": "A String", # The photo of the community.
- "id": 42, # The id of the community.
- "name": "A String", # The name of the community.
- },
- "content": "A String", # The HTML-formatted content, suitable for display. When updating an activity's content, post the changes to this property, using the value of originalContent as a starting point. If the update is successful, the server adds HTML formatting and responds with this formatted content.
- "person": { # The person who is related with this activity, e.g. an Added User.
- "name": { # An object that encapsulates the individual components of a person's name.
- "givenName": "A String", # The given name (first name) of this person.
- "familyName": "A String", # The family name (last name) of this person.
- },
- "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "gender": "A String", # The person's gender. Values include "male", "female", and "other".
- "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
- "url": "A String", # The URL of the person's profile photo.
- },
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "id": "A String", # The person's opensocial ID.
- },
- "id": "A String", # The ID for the object.
- "objectType": "A String", # The object type.
- },
- ],
- "replies": { # Comments in reply to this activity.
- "totalItems": "A String", # Total number of comments.
- "items": [ # The list of comments.
- {
- "inReplyTo": { # Link to the original activity where this comment was posted.
- "type": "A String", # Type of the post on activity stream being commented. Always text/html.
- "href": "A String", # Link to the post on activity stream being commented.
- "ref": "A String", # Unique identifier of the post on activity stream being commented.
- "rel": "inReplyTo", # Relationship between the comment and the post on activity stream being commented. Always inReplyTo.
- },
- "kind": "orkut#comment", # Identifies this resource as a comment. Value: "orkut#comment"
- "links": [ # List of resources for the comment.
- { # Links to resources related to the parent object.
- "href": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- "rel": "A String", # Relation between the resource and the parent object.
- "title": "A String", # Title of the link.
- },
- ],
- "actor": { # The person who posted the comment.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "content": "A String", # The content of the comment in text/html
- "published": "A String", # The time the comment was initially published, in RFC 3339 format.
- "id": "A String", # The unique ID for the comment.
- },
- ],
- "url": "A String", # URL for the collection of comments in reply to this activity.
- },
- "objectType": "A String", # The type of the object affected by the activity. Clients can use this information to style the rendered activity object differently depending on the content.
- },
- "updated": "A String", # The time at which the activity was last updated.
- "actor": { # The person who performed the activity.
- "url": "A String", # The URL of the author who posted the comment [not yet implemented]
- "image": { # Image data about the author.
- "url": "A String", # A URL that points to a thumbnail photo of the author.
- },
- "displayName": "A String", # The name of the author, suitable for display.
- "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.
- },
- "access": { # Identifies who has access to see this activity.
- "items": [ # The list of ACL entries.
- {
- "type": "A String", # The type of entity to whom access is granted.
- "id": "A String", # The ID of the entity. For entities of type "person" or "circle", this is the ID of the resource. For other types, this will be unset.
- },
- ],
- "kind": "orkut#acl", # Identifies this resource as an access control list. Value: "orkut#acl"
- "description": "A String", # Human readable description of the access granted.
- "totalParticipants": 42, # The total count of participants of the parent resource.
- },
- "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
- # - add - User added new content to profile or album, e.g. video, photo.
- # - post - User publish content to the stream, e.g. status, scrap.
- # - update - User commented on an activity.
- # - make-friend - User added a new friend.
- # - birthday - User has a birthday.
- "published": "A String", # The time at which the activity was initially published.
- "id": "A String", # The ID for the activity.
- }
-
Instance Methods
-
- pagespeedapi()
-
-Returns the pagespeedapi Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/pagespeedonline_v1.pagespeedapi.html b/docs/dyn/pagespeedonline_v1.pagespeedapi.html
deleted file mode 100644
index aa269a2..0000000
--- a/docs/dyn/pagespeedonline_v1.pagespeedapi.html
+++ /dev/null
@@ -1,189 +0,0 @@
-
-
-
-
-Instance Methods
-
- runpagespeed(url, screenshot=None, locale=None, rule=None, strategy=None, filter_third_party_resources=None)
-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.
-Method Details
-
-
runpagespeed(url, screenshot=None, locale=None, rule=None, strategy=None, filter_third_party_resources=None)
-
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:
- url: string, The URL to fetch and analyze (required)
- screenshot: boolean, Indicates if binary data containing a screenshot should be included
- 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
- filter_third_party_resources: boolean, Indicates if third party resources should be filtered out before PageSpeed analysis.
-
-Returns:
- An object of the form:
-
- {
- "notice": "If you would like to use this API to perform programmatic PageSpeed analysis, please use your own PageSpeed Insights API key. See https://developers.google.com/speed/docs/insights/v1/getting_started for additional details.", # Notice to discourage users from reusing API keys.
- "responseCode": 42, # Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error.
- "screenshot": { # Base64 encoded screenshot of the page that was analyzed.
- "width": 42, # Width of screenshot in pixels.
- "data": "A String", # Image data base64 encoded.
- "mime_type": "A String", # Mime type of image data. E.g. "image/jpeg".
- "height": 42, # Height of screenshot in pixels.
- },
- "title": "A String", # Title of the page, as displayed in the browser's title bar.
- "version": { # The version of the Page Speed SDK used to generate these results.
- "major": 42, # The major version number of the Page Speed SDK used to generate these results.
- "minor": 42, # The minor version number of the Page Speed SDK used to generate these results.
- },
- "request": { # Echo of certain request parameters.
- "url": "A String",
- "filter_third_party_resources": "A String",
- "strategy": "A String",
- },
- "kind": "pagespeedonline#result", # Kind of result.
- "score": 42, # The Page Speed Score (0-100), which indicates how much faster a page could be. A high score indicates little room for improvement, while a lower score indicates more room for improvement.
- "formattedResults": { # Localized Page Speed results. Contains a ruleResults entry for each Page Speed rule instantiated and run by the server.
- "locale": "A String", # The locale of the formattedResults, e.g. "en_US".
- "ruleResults": { # Dictionary of formatted rule results, with one entry for each Page Speed rule instantiated and run by the server.
- "a_key": { # The enum-like identifier for this rule. For instance "EnableKeepAlive" or "AvoidCssImport". Not localized.
- "localizedRuleName": "A String", # Localized name of the rule, intended for presentation to a user.
- "urlBlocks": [ # List of blocks of URLs. Each block may contain a heading and a list of URLs. Each URL may optionally include additional details.
- {
- "header": { # Heading to be displayed with the list of URLs.
- "args": [ # List of arguments for the format string.
- {
- "type": "A String", # Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or DURATION.
- "value": "A String", # Argument value, as a localized string.
- },
- ],
- "format": "A String", # A localized format string with $N placeholders, where N is the 1-indexed argument number, e.g. 'Minifying the following $1 resources would save a total of $2 bytes'.
- },
- "urls": [ # List of entries that provide information about URLs in the url block. Optional.
- {
- "details": [ # List of entries that provide additional details about a single URL. Optional.
- {
- "args": [ # List of arguments for the format string.
- {
- "type": "A String", # Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or DURATION.
- "value": "A String", # Argument value, as a localized string.
- },
- ],
- "format": "A String", # A localized format string with $N placeholders, where N is the 1-indexed argument number, e.g. 'Unnecessary metadata for this resource adds an additional $1 bytes to its download size'.
- },
- ],
- "result": { # A format string that gives information about the URL, and a list of arguments for that format string.
- "args": [ # List of arguments for the format string.
- {
- "type": "A String", # Type of argument. One of URL, STRING_LITERAL, INT_LITERAL, BYTES, or DURATION.
- "value": "A String", # Argument value, as a localized string.
- },
- ],
- "format": "A String", # A localized format string with $N placeholders, where N is the 1-indexed argument number, e.g. 'Minifying the resource at URL $1 can save $2 bytes'.
- },
- },
- ],
- },
- ],
- "ruleScore": 42, # The score (0-100) for this rule. The rule score indicates how well a page implements the recommendations for the given rule. For instance, if none of the compressible resources on a page are compressed, the rule score would be 0, while if all of the compressible resources on a page are compressed, the rule score would be 100.
- "ruleImpact": 3.14, # The impact (unbounded floating point value) that implementing the suggestions for this rule would have on making the page faster. Impact is comparable between rules to determine which rule's suggestions would have a higher or lower impact on making a page faster. For instance, if enabling compression would save 1MB, while optimizing images would save 500kB, the enable compression rule would have 2x the impact of the image optimization rule, all other things being equal.
- },
- },
- },
- "invalidRules": [ # List of rules that were specified in the request, but which the server did not know how to instantiate.
- "A String",
- ],
- "pageStats": { # Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc.
- "otherResponseBytes": "A String", # Number of response bytes for other resources on the page.
- "flashResponseBytes": "A String", # Number of response bytes for flash resources on the page.
- "totalRequestBytes": "A String", # Total size of all request bytes sent by the page.
- "numberCssResources": 42, # Number of CSS resources referenced by the page.
- "numberResources": 42, # Number of HTTP resources loaded by the page.
- "cssResponseBytes": "A String", # Number of uncompressed response bytes for CSS resources on the page.
- "javascriptResponseBytes": "A String", # Number of uncompressed response bytes for JS resources on the page.
- "imageResponseBytes": "A String", # Number of response bytes for image resources on the page.
- "numberHosts": 42, # Number of unique hosts referenced by the page.
- "numberStaticResources": 42, # Number of static (i.e. cacheable) resources on the page.
- "htmlResponseBytes": "A String", # Number of uncompressed response bytes for the main HTML document and all iframes on the page.
- "numberJsResources": 42, # Number of JavaScript resources referenced by the page.
- "textResponseBytes": "A String", # Number of uncompressed response bytes for text resources not covered by other statistics (i.e non-HTML, non-script, non-CSS resources) on the page.
- },
- "id": "A String", # Canonicalized and final URL for the document, after following page redirects (if any).
- }
-
Instance Methods
-
- get(activityId)
-Get an activity.
-
- list(userId, collection, pageToken=None, maxResults=None)
-List all of the activities in the specified collection for a particular user.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- search(query, orderBy=None, language=None, pageToken=None, maxResults=None)
-Search public activities.
-
- search_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(activityId)
-
Get an activity.
-
-Args:
- activityId: string, The ID of the activity to get. (required)
-
-Returns:
- An object of the form:
-
- {
- "placeName": "A String", # Name of the place where this activity occurred.
- "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
- "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
- "provider": { # The service provider that initially published this activity.
- "title": "A String", # Name of the service provider.
- },
- "title": "A String", # Title of this activity.
- "url": "A String", # The link to this activity.
- "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
- "object": { # The object of this activity.
- "resharers": { # People who reshared this activity.
- "totalItems": 42, # Total number of people who reshared this activity.
- "selfLink": "A String", # The URL for the collection of resharers.
- },
- "attachments": [ # The media objects attached to this activity.
- {
- "displayName": "A String", # The title of the attachment, such as a photo caption or an article title.
- "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album.
- {
- "url": "A String", # URL to the webpage containing the image.
- "image": { # Image resource.
- "url": "A String", # Image url.
- "width": 42, # The width, in pixels, of the linked resource.
- "type": "A String", # Media type of the link.
- "height": 42, # The height, in pixels, of the linked resource.
- },
- "description": "A String", # Potential name of the thumbnail.
- },
- ],
- "fullImage": { # The full image URL for photo attachments.
- "url": "A String", # URL to the image.
- "width": 42, # The width, in pixels, of the linked resource.
- "type": "A String", # Media type of the link.
- "height": 42, # The height, in pixels, of the linked resource.
- },
- "url": "A String", # The link to the attachment, should be of type text/html.
- "image": { # The preview image for photos or videos.
- "url": "A String", # Image url.
- "width": 42, # The width, in pixels, of the linked resource.
- "type": "A String", # Media type of the link.
- "height": 42, # The height, in pixels, of the linked resource.
- },
- "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types.
- "embed": { # If the attachment is a video, the embeddable link.
- "url": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- },
- "id": "A String", # The ID of the attachment.
- "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values:
- # - "photo" - A photo.
- # - "album" - A photo album.
- # - "video" - A video.
- # - "article" - An article, specified by a link.
- },
- ],
- "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request.
- "plusoners": { # People who +1'd this activity.
- "totalItems": 42, # Total number of people who +1'd this activity.
- "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
- },
- "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor.
- "url": "A String", # A link to the original actor's Google profile.
- "image": { # The image representation of the original actor.
- "url": "A String", # A URL that points to a thumbnail photo of the original actor.
- },
- "displayName": "A String", # The original actor's name, which is suitable for display.
- "id": "A String", # ID of the original actor.
- },
- "content": "A String", # The HTML-formatted content, which is suitable for display.
- "url": "A String", # The URL that points to the linked resource.
- "replies": { # Comments in reply to this activity.
- "totalItems": 42, # Total number of comments on this activity.
- "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
- },
- "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared.
- "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values:
- # - "note" - Textual content.
- # - "activity" - A Google+ activity.
- },
- "placeId": "A String", # ID of the place where this activity occurred.
- "actor": { # The person who performed this activity.
- "url": "A String", # The link to the actor's Google profile.
- "image": { # The image representation of the actor.
- "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- },
- "displayName": "A String", # The name of the actor, suitable for display.
- "id": "A String", # The ID of the actor's person resource.
- "name": { # An object representation of the individual components of name.
- "givenName": "A String", # The given name (first name) of the actor.
- "familyName": "A String", # The family name (last name) of the actor.
- },
- },
- "id": "A String", # The ID of this activity.
- "access": { # Identifies who has access to see this activity.
- "items": [ # The list of access entries.
- {
- "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
- # - "person" - Access to an individual.
- # - "circle" - Access to members of a circle.
- # - "myCircles" - Access to members of all the person's circles.
- # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
- # - "domain" - Access to members of the person's Google Apps domain.
- # - "public" - Access to anyone on the web.
- "displayName": "A String", # A descriptive name for this entry. Suitable for display.
- "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
- },
- ],
- "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
- "description": "A String", # Description of the access granted, suitable for display.
- },
- "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values:
- # - "post" - Publish content to the stream.
- # - "share" - Reshare an activity.
- "etag": "A String", # ETag of this response for caching purposes.
- "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
- "location": { # The location where this activity occurred.
- "position": { # The position of the place.
- "latitude": 3.14, # The latitude of this position.
- "longitude": 3.14, # The longitude of this position.
- },
- "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place".
- "displayName": "A String", # The display name of the place.
- "address": { # The physical address of the place.
- "formatted": "A String", # The formatted address for display.
- },
- },
- "address": "A String", # Street address where this activity occurred.
- "crosspostSource": "A String", # If this activity is a cross post from another system, this property specifies the ID of the original activity.
- "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
- "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
- }
-
-
list(userId, collection, pageToken=None, maxResults=None)
-
List all of the activities in the specified collection for a particular user.
-
-Args:
- userId: string, The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. (required)
- collection: string, The collection of activities to list. (required)
- Allowed values
- public - All public activities created by the specified user.
- pageToken: string, The continuation token, which is 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 activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
- "title": "A String", # The title of this collection of activities.
- "items": [ # The activities in this page of results.
- {
- "placeName": "A String", # Name of the place where this activity occurred.
- "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
- "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
- "provider": { # The service provider that initially published this activity.
- "title": "A String", # Name of the service provider.
- },
- "title": "A String", # Title of this activity.
- "url": "A String", # The link to this activity.
- "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
- "object": { # The object of this activity.
- "resharers": { # People who reshared this activity.
- "totalItems": 42, # Total number of people who reshared this activity.
- "selfLink": "A String", # The URL for the collection of resharers.
- },
- "attachments": [ # The media objects attached to this activity.
- {
- "displayName": "A String", # The title of the attachment, such as a photo caption or an article title.
- "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album.
- {
- "url": "A String", # URL to the webpage containing the image.
- "image": { # Image resource.
- "url": "A String", # Image url.
- "width": 42, # The width, in pixels, of the linked resource.
- "type": "A String", # Media type of the link.
- "height": 42, # The height, in pixels, of the linked resource.
- },
- "description": "A String", # Potential name of the thumbnail.
- },
- ],
- "fullImage": { # The full image URL for photo attachments.
- "url": "A String", # URL to the image.
- "width": 42, # The width, in pixels, of the linked resource.
- "type": "A String", # Media type of the link.
- "height": 42, # The height, in pixels, of the linked resource.
- },
- "url": "A String", # The link to the attachment, should be of type text/html.
- "image": { # The preview image for photos or videos.
- "url": "A String", # Image url.
- "width": 42, # The width, in pixels, of the linked resource.
- "type": "A String", # Media type of the link.
- "height": 42, # The height, in pixels, of the linked resource.
- },
- "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types.
- "embed": { # If the attachment is a video, the embeddable link.
- "url": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- },
- "id": "A String", # The ID of the attachment.
- "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values:
- # - "photo" - A photo.
- # - "album" - A photo album.
- # - "video" - A video.
- # - "article" - An article, specified by a link.
- },
- ],
- "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request.
- "plusoners": { # People who +1'd this activity.
- "totalItems": 42, # Total number of people who +1'd this activity.
- "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
- },
- "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor.
- "url": "A String", # A link to the original actor's Google profile.
- "image": { # The image representation of the original actor.
- "url": "A String", # A URL that points to a thumbnail photo of the original actor.
- },
- "displayName": "A String", # The original actor's name, which is suitable for display.
- "id": "A String", # ID of the original actor.
- },
- "content": "A String", # The HTML-formatted content, which is suitable for display.
- "url": "A String", # The URL that points to the linked resource.
- "replies": { # Comments in reply to this activity.
- "totalItems": 42, # Total number of comments on this activity.
- "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
- },
- "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared.
- "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values:
- # - "note" - Textual content.
- # - "activity" - A Google+ activity.
- },
- "placeId": "A String", # ID of the place where this activity occurred.
- "actor": { # The person who performed this activity.
- "url": "A String", # The link to the actor's Google profile.
- "image": { # The image representation of the actor.
- "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- },
- "displayName": "A String", # The name of the actor, suitable for display.
- "id": "A String", # The ID of the actor's person resource.
- "name": { # An object representation of the individual components of name.
- "givenName": "A String", # The given name (first name) of the actor.
- "familyName": "A String", # The family name (last name) of the actor.
- },
- },
- "id": "A String", # The ID of this activity.
- "access": { # Identifies who has access to see this activity.
- "items": [ # The list of access entries.
- {
- "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
- # - "person" - Access to an individual.
- # - "circle" - Access to members of a circle.
- # - "myCircles" - Access to members of all the person's circles.
- # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
- # - "domain" - Access to members of the person's Google Apps domain.
- # - "public" - Access to anyone on the web.
- "displayName": "A String", # A descriptive name for this entry. Suitable for display.
- "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
- },
- ],
- "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
- "description": "A String", # Description of the access granted, suitable for display.
- },
- "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values:
- # - "post" - Publish content to the stream.
- # - "share" - Reshare an activity.
- "etag": "A String", # ETag of this response for caching purposes.
- "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
- "location": { # The location where this activity occurred.
- "position": { # The position of the place.
- "latitude": 3.14, # The latitude of this position.
- "longitude": 3.14, # The longitude of this position.
- },
- "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place".
- "displayName": "A String", # The display name of the place.
- "address": { # The physical address of the place.
- "formatted": "A String", # The formatted address for display.
- },
- },
- "address": "A String", # Street address where this activity occurred.
- "crosspostSource": "A String", # If this activity is a cross post from another system, this property specifies the ID of the original activity.
- "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
- "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
- },
- ],
- "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
- "nextLink": "A String", # Link to the next page of activities.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID of this collection of activities. Deprecated.
- "selfLink": "A String", # Link to this activity resource.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
search(query, orderBy=None, language=None, pageToken=None, maxResults=None)
-
Search public activities.
-
-Args:
- query: string, Full-text search query string. (required)
- orderBy: string, Specifies how to order search results.
- Allowed values
- best - Sort activities by relevance to the user, most relevant first.
- recent - Sort activities by published date, most recent first.
- language: string, Specify the preferred language to search with. See search language codes for available values.
- pageToken: string, The continuation token, which is 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 can be of any length.
- maxResults: integer, The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
- "title": "A String", # The title of this collection of activities.
- "items": [ # The activities in this page of results.
- {
- "placeName": "A String", # Name of the place where this activity occurred.
- "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
- "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
- "provider": { # The service provider that initially published this activity.
- "title": "A String", # Name of the service provider.
- },
- "title": "A String", # Title of this activity.
- "url": "A String", # The link to this activity.
- "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
- "object": { # The object of this activity.
- "resharers": { # People who reshared this activity.
- "totalItems": 42, # Total number of people who reshared this activity.
- "selfLink": "A String", # The URL for the collection of resharers.
- },
- "attachments": [ # The media objects attached to this activity.
- {
- "displayName": "A String", # The title of the attachment, such as a photo caption or an article title.
- "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album.
- {
- "url": "A String", # URL to the webpage containing the image.
- "image": { # Image resource.
- "url": "A String", # Image url.
- "width": 42, # The width, in pixels, of the linked resource.
- "type": "A String", # Media type of the link.
- "height": 42, # The height, in pixels, of the linked resource.
- },
- "description": "A String", # Potential name of the thumbnail.
- },
- ],
- "fullImage": { # The full image URL for photo attachments.
- "url": "A String", # URL to the image.
- "width": 42, # The width, in pixels, of the linked resource.
- "type": "A String", # Media type of the link.
- "height": 42, # The height, in pixels, of the linked resource.
- },
- "url": "A String", # The link to the attachment, should be of type text/html.
- "image": { # The preview image for photos or videos.
- "url": "A String", # Image url.
- "width": 42, # The width, in pixels, of the linked resource.
- "type": "A String", # Media type of the link.
- "height": 42, # The height, in pixels, of the linked resource.
- },
- "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types.
- "embed": { # If the attachment is a video, the embeddable link.
- "url": "A String", # URL of the link.
- "type": "A String", # Media type of the link.
- },
- "id": "A String", # The ID of the attachment.
- "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values:
- # - "photo" - A photo.
- # - "album" - A photo album.
- # - "video" - A video.
- # - "article" - An article, specified by a link.
- },
- ],
- "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request.
- "plusoners": { # People who +1'd this activity.
- "totalItems": 42, # Total number of people who +1'd this activity.
- "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
- },
- "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor.
- "url": "A String", # A link to the original actor's Google profile.
- "image": { # The image representation of the original actor.
- "url": "A String", # A URL that points to a thumbnail photo of the original actor.
- },
- "displayName": "A String", # The original actor's name, which is suitable for display.
- "id": "A String", # ID of the original actor.
- },
- "content": "A String", # The HTML-formatted content, which is suitable for display.
- "url": "A String", # The URL that points to the linked resource.
- "replies": { # Comments in reply to this activity.
- "totalItems": 42, # Total number of comments on this activity.
- "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
- },
- "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared.
- "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values:
- # - "note" - Textual content.
- # - "activity" - A Google+ activity.
- },
- "placeId": "A String", # ID of the place where this activity occurred.
- "actor": { # The person who performed this activity.
- "url": "A String", # The link to the actor's Google profile.
- "image": { # The image representation of the actor.
- "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- },
- "displayName": "A String", # The name of the actor, suitable for display.
- "id": "A String", # The ID of the actor's person resource.
- "name": { # An object representation of the individual components of name.
- "givenName": "A String", # The given name (first name) of the actor.
- "familyName": "A String", # The family name (last name) of the actor.
- },
- },
- "id": "A String", # The ID of this activity.
- "access": { # Identifies who has access to see this activity.
- "items": [ # The list of access entries.
- {
- "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
- # - "person" - Access to an individual.
- # - "circle" - Access to members of a circle.
- # - "myCircles" - Access to members of all the person's circles.
- # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
- # - "domain" - Access to members of the person's Google Apps domain.
- # - "public" - Access to anyone on the web.
- "displayName": "A String", # A descriptive name for this entry. Suitable for display.
- "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
- },
- ],
- "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
- "description": "A String", # Description of the access granted, suitable for display.
- },
- "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values:
- # - "post" - Publish content to the stream.
- # - "share" - Reshare an activity.
- "etag": "A String", # ETag of this response for caching purposes.
- "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
- "location": { # The location where this activity occurred.
- "position": { # The position of the place.
- "latitude": 3.14, # The latitude of this position.
- "longitude": 3.14, # The longitude of this position.
- },
- "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place".
- "displayName": "A String", # The display name of the place.
- "address": { # The physical address of the place.
- "formatted": "A String", # The formatted address for display.
- },
- },
- "address": "A String", # Street address where this activity occurred.
- "crosspostSource": "A String", # If this activity is a cross post from another system, this property specifies the ID of the original activity.
- "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
- "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
- },
- ],
- "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
- "nextLink": "A String", # Link to the next page of activities.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID of this collection of activities. Deprecated.
- "selfLink": "A String", # Link to this activity resource.
- }
-
-
search_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- get(commentId)
-Get a comment.
-
- list(activityId, pageToken=None, maxResults=None, sortOrder=None)
-List all of the comments for an activity.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(commentId)
-
Get a comment.
-
-Args:
- commentId: string, The ID of the comment to get. (required)
-
-Returns:
- An object of the form:
-
- {
- "inReplyTo": [ # The activity this comment replied to.
- {
- "url": "A String", # The URL of the activity.
- "id": "A String", # The ID of the activity.
- },
- ],
- "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
- "plusoners": { # People who +1'd this comment.
- "totalItems": 42, # Total number of people who +1'd this comment.
- },
- "object": { # The object of this comment.
- "content": "A String", # The HTML-formatted content, suitable for display.
- "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
- "objectType": "comment", # The object type of this comment. Possible values are:
- # - "comment" - A comment in reply to an activity.
- },
- "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
- "actor": { # The person who posted this comment.
- "url": "A String", # A link to the person resource for this actor.
- "image": { # The image representation of this actor.
- "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- },
- "displayName": "A String", # The name of this actor, suitable for display.
- "id": "A String", # The ID of the actor.
- },
- "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
- # - "post" - Publish content to the stream.
- "etag": "A String", # ETag of this response for caching purposes.
- "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
- "id": "A String", # The ID of this comment.
- "selfLink": "A String", # Link to this comment resource.
- }
-
-
list(activityId, pageToken=None, maxResults=None, sortOrder=None)
-
List all of the comments for an activity.
-
-Args:
- activityId: string, The ID of the activity to get comments for. (required)
- pageToken: string, The continuation token, which is 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, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
- sortOrder: string, The order in which to sort the list of comments.
- Allowed values
- ascending - Sort oldest comments first.
- descending - Sort newest comments first.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "kind": "plus#commentFeed", # Identifies this resource as a collection of comments. Value: "plus#commentFeed".
- "title": "A String", # The title of this collection of comments.
- "items": [ # The comments in this page of results.
- {
- "inReplyTo": [ # The activity this comment replied to.
- {
- "url": "A String", # The URL of the activity.
- "id": "A String", # The ID of the activity.
- },
- ],
- "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
- "plusoners": { # People who +1'd this comment.
- "totalItems": 42, # Total number of people who +1'd this comment.
- },
- "object": { # The object of this comment.
- "content": "A String", # The HTML-formatted content, suitable for display.
- "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
- "objectType": "comment", # The object type of this comment. Possible values are:
- # - "comment" - A comment in reply to an activity.
- },
- "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
- "actor": { # The person who posted this comment.
- "url": "A String", # A link to the person resource for this actor.
- "image": { # The image representation of this actor.
- "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- },
- "displayName": "A String", # The name of this actor, suitable for display.
- "id": "A String", # The ID of the actor.
- },
- "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
- # - "post" - Publish content to the stream.
- "etag": "A String", # ETag of this response for caching purposes.
- "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
- "id": "A String", # The ID of this comment.
- "selfLink": "A String", # Link to this comment resource.
- },
- ],
- "updated": "A String", # The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp.
- "nextLink": "A String", # Link to the next page of activities.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID of this collection of comments.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- activities()
-
-Returns the activities Resource.
-
-
- comments()
-
-Returns the comments Resource.
-
-
- moments()
-
-Returns the moments Resource.
-
-
- people()
-
-Returns the people Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/plus_v1.moments.html b/docs/dyn/plus_v1.moments.html
deleted file mode 100644
index 671fc4a..0000000
--- a/docs/dyn/plus_v1.moments.html
+++ /dev/null
@@ -1,595 +0,0 @@
-
-
-
-
-Instance Methods
-
- insert(userId, collection, body, debug=None)
-Record a moment representing a user's activity such as making a purchase or commenting on a blog.
-
- list(userId, collection, pageToken=None, maxResults=None, targetUrl=None, type=None)
-List all of the moments for a particular user.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- remove(id)
-Delete a moment.
-Method Details
-
-
insert(userId, collection, body, debug=None)
-
Record a moment representing a user's activity such as making a purchase or commenting on a blog.
-
-Args:
- userId: string, The ID of the user to record activities for. The only valid values are "me" and the ID of the authenticated user. (required)
- collection: string, The collection to which to write moments. (required)
- Allowed values
- vault - The default collection for writing new moments.
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "startDate": "A String", # Time stamp of when the action occurred in RFC3339 format.
- "kind": "plus#moment", # Identifies this resource as a moment.
- "target": { # The object on which the action was performed.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the target. Your app can choose how to identify targets. The target.id is required if you are writing an activity that does not have a corresponding web page or target.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced target and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we reccommend using the controlled vocaulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "result": { # The object generated by performing the action on the target. For example, a user writes a review of a restaurant, the target is the restaurant and the result is the review.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the target. Your app can choose how to identify targets. The target.id is required if you are writing an activity that does not have a corresponding web page or target.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced target and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we reccommend using the controlled vocaulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "type": "A String", # The Google schema for the type of moment to write. For example, http://schemas.google.com/AddActivity.
- "id": "A String", # The moment ID.
- }
-
- debug: boolean, Return the moment as written. Should be used only for debugging.
-
-Returns:
- An object of the form:
-
- {
- "startDate": "A String", # Time stamp of when the action occurred in RFC3339 format.
- "kind": "plus#moment", # Identifies this resource as a moment.
- "target": { # The object on which the action was performed.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the target. Your app can choose how to identify targets. The target.id is required if you are writing an activity that does not have a corresponding web page or target.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced target and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we reccommend using the controlled vocaulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "result": { # The object generated by performing the action on the target. For example, a user writes a review of a restaurant, the target is the restaurant and the result is the review.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the target. Your app can choose how to identify targets. The target.id is required if you are writing an activity that does not have a corresponding web page or target.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced target and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we reccommend using the controlled vocaulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "type": "A String", # The Google schema for the type of moment to write. For example, http://schemas.google.com/AddActivity.
- "id": "A String", # The moment ID.
- }
-
-
list(userId, collection, pageToken=None, maxResults=None, targetUrl=None, type=None)
-
List all of the moments for a particular user.
-
-Args:
- userId: string, The ID of the user to get moments for. The special value "me" can be used to indicate the authenticated user. (required)
- collection: string, The collection of moments to list. (required)
- Allowed values
- vault - All moments created by the requesting application for the authenticated user.
- pageToken: string, The continuation token, which is 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 moments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
- targetUrl: string, Only moments containing this targetUrl will be returned.
- type: string, Only moments of this type will be returned.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "kind": "plus#momentsFeed", # Identifies this resource as a collection of moments. Value: "plus#momentsFeed".
- "title": "A String", # The title of this collection of moments.
- "items": [ # The moments in this page of results.
- {
- "startDate": "A String", # Time stamp of when the action occurred in RFC3339 format.
- "kind": "plus#moment", # Identifies this resource as a moment.
- "target": { # The object on which the action was performed.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the target. Your app can choose how to identify targets. The target.id is required if you are writing an activity that does not have a corresponding web page or target.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced target and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we reccommend using the controlled vocaulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "result": { # The object generated by performing the action on the target. For example, a user writes a review of a restaurant, the target is the restaurant and the result is the review.
- "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
- "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
- "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
- "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
- "address": # Object with schema name: ItemScope # Postal address.
- "birthDate": "A String", # Date of birth.
- "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
- "addressLocality": "A String", # Address locality.
- "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
- "additionalName": [ # An additional name for a Person, can be used for a middle name.
- "A String",
- ],
- "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
- "contributor": [ # A list of contributors to this result.
- # Object with schema name: ItemScope
- ],
- "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
- "id": "A String", # An identifier for the target. Your app can choose how to identify targets. The target.id is required if you are writing an activity that does not have a corresponding web page or target.url property.
- "postOfficeBoxNumber": "A String", # Post office box number.
- "attendees": [ # A person attending the event.
- # Object with schema name: ItemScope
- ],
- "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
- # Object with schema name: ItemScope
- ],
- "associated_media": [ # The encoding.
- # Object with schema name: ItemScope
- ],
- "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
- "addressCountry": "A String", # Address country.
- "width": "A String", # The width of the media object.
- "streetAddress": "A String", # Street address.
- "location": # Object with schema name: ItemScope # The location of the event or organization.
- "latitude": 3.14, # Latitude.
- "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
- "type": "A String", # The schema.org URL that best describes the referenced target and matches the type of moment.
- "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
- "contentSize": "A String", # File size in (mega/kilo) bytes.
- "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
- "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
- "description": "A String", # The string that describes the content of the result.
- "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
- "kind": "plus#itemScope", # Identifies this resource as an itemScope.
- "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
- "postalCode": "A String", # Postal code.
- "attendeeCount": 42, # Number of attendees.
- "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
- "addressRegion": "A String", # Address region.
- "height": "A String", # The height of the media object.
- "geo": # Object with schema name: ItemScope # Geo coordinates.
- "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
- "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we reccommend using the controlled vocaulary of Market Identifier Codes (MIC) specified in ISO15022.
- "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
- "about": # Object with schema name: ItemScope # The subject matter of the content.
- "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
- "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
- "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
- # Object with schema name: ItemScope
- ],
- "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
- "gender": "A String", # Gender of the person.
- "longitude": 3.14, # Longitude.
- "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
- "caption": "A String", # The caption for this object.
- "ratingValue": "A String", # Rating value.
- "reviewRating": # Object with schema name: ItemScope # Review rating.
- "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
- },
- "type": "A String", # The Google schema for the type of moment to write. For example, http://schemas.google.com/AddActivity.
- "id": "A String", # The moment ID.
- },
- ],
- "updated": "A String", # The RFC 339 timestamp for when this collection of moments was last updated.
- "nextLink": "A String", # Link to the next page of moments.
- "etag": "A String", # ETag of this response for caching purposes.
- "selfLink": "A String", # Link to this page of moments.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
remove(id)
-
Delete a moment.
-
-Args:
- id: string, The ID of the moment to delete. (required)
-
-
Instance Methods
-
- get(userId)
-Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.
-
- list(userId, collection, orderBy=None, pageToken=None, maxResults=None)
-List all of the people in the specified collection.
-
- listByActivity(activityId, collection, pageToken=None, maxResults=None)
-List all of the people in the specified collection for a particular activity.
-
- listByActivity_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- search(query, pageToken=None, language=None, maxResults=None)
-Search all public profiles.
-
- search_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(userId)
-
Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.
-
-Args:
- userId: string, The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. (required)
-
-Returns:
- An object of the form:
-
- {
- "braggingRights": "A String", # The "bragging rights" line of this person.
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- },
- "id": "A String", # The ID of this person.
- "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
- # - "person" - represents an actual person.
- # - "page" - represents a page.
- "verified": True or False, # Whether the person or Google+ Page has been verified.
- "tagline": "A String", # The brief description (tagline) of this person.
- "etag": "A String", # ETag of this response for caching purposes.
- "circledByCount": 42, # If a Google+ Page and for followers who are visible, the number of people who have added this page to a circle.
- "aboutMe": "A String", # A short biography for this person.
- "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
- "placesLived": [ # A list of places where this person has lived.
- {
- "primary": True or False, # If "true", this place of residence is this person's primary residence.
- "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
- },
- ],
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "nickname": "A String", # The nickname of this person.
- "currentLocation": "A String", # The current location for this person.
- "organizations": [ # A list of current or past organizations with which this person is associated.
- {
- "startDate": "A String", # The date that the person joined this organization.
- "endDate": "A String", # The date that the person left this organization.
- "description": "A String", # A short description of the person's role in this organization. Deprecated.
- "title": "A String", # The person's job title or role within the organization.
- "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
- "location": "A String", # The location of this organization. Deprecated.
- "department": "A String", # The department within the organization. Deprecated.
- "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
- # - "work" - Work.
- # - "school" - School.
- "name": "A String", # The name of the organization.
- },
- ],
- "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
- # - "single" - Person is single.
- # - "in_a_relationship" - Person is in a relationship.
- # - "engaged" - Person is engaged.
- # - "married" - Person is married.
- # - "its_complicated" - The relationship is complicated.
- # - "open_relationship" - Person is in an open relationship.
- # - "widowed" - Person is widowed.
- # - "in_domestic_partnership" - Person is in a domestic partnership.
- # - "in_civil_union" - Person is in a civil union.
- "displayName": "A String", # The name of this person, which is suitable for display.
- "name": { # An object representation of the individual components of a person's name.
- "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
- "middleName": "A String", # The middle name of this person.
- "familyName": "A String", # The family name (last name) of this person.
- "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
- "givenName": "A String", # The given name (first name) of this person.
- "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
- },
- "language": "A String", # The user's preferred language for rendering.
- "url": "A String", # The URL of this person's profile.
- "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
- # - "male" - Male gender.
- # - "female" - Female gender.
- # - "other" - Other.
- "cover": { # The cover photo content.
- "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
- # - "banner" - One large image banner.
- "coverInfo": { # Extra information about the cover photo.
- "leftImageOffset": 42, # The difference between the left position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
- "topImageOffset": 42, # The difference between the top position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
- },
- "coverPhoto": { # The person's primary cover image.
- "url": "A String", # The url to the image.
- "width": 42, # The width to the image.
- "height": 42, # The height to the image.
- },
- },
- "isPlusUser": True or False, # Whether this user has signed up for Google+.
- "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'ed this page.
- "urls": [ # A list of URLs for this person.
- {
- "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
- # - "otherProfile" - URL for another profile.
- # - "contributor" - URL to a site for which this person is a contributor.
- # - "website" - URL for this Google+ Page's primary website.
- # - "other" - Other URL.
- "value": "A String", # The URL value.
- "label": "A String", # The label of the URL.
- },
- ],
- "ageRange": { # The age range of the person.
- "max": 42, # The age range's upper bound, if any.
- "min": 42, # The age range's lower bound, if any.
- },
- }
-
-
list(userId, collection, orderBy=None, pageToken=None, maxResults=None)
-
List all of the people in the specified collection.
-
-Args:
- userId: string, Get the collection of people for the person identified. Use "me" to indicate the authenticated user. (required)
- collection: string, The collection of people to list. (required)
- Allowed values
- visible - The list of people who this user has added to one or more circles, limited to the circles visible to the requesting application.
- orderBy: string, The order to return people in.
- Allowed values
- alphabetical - Order the people by their display name.
- best - Order people based on the relevence to the viewer.
- pageToken: string, The continuation token, which is 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, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
- "title": "A String", # The title of this collection of people.
- "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
- {
- "braggingRights": "A String", # The "bragging rights" line of this person.
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- },
- "id": "A String", # The ID of this person.
- "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
- # - "person" - represents an actual person.
- # - "page" - represents a page.
- "verified": True or False, # Whether the person or Google+ Page has been verified.
- "tagline": "A String", # The brief description (tagline) of this person.
- "etag": "A String", # ETag of this response for caching purposes.
- "circledByCount": 42, # If a Google+ Page and for followers who are visible, the number of people who have added this page to a circle.
- "aboutMe": "A String", # A short biography for this person.
- "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
- "placesLived": [ # A list of places where this person has lived.
- {
- "primary": True or False, # If "true", this place of residence is this person's primary residence.
- "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
- },
- ],
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "nickname": "A String", # The nickname of this person.
- "currentLocation": "A String", # The current location for this person.
- "organizations": [ # A list of current or past organizations with which this person is associated.
- {
- "startDate": "A String", # The date that the person joined this organization.
- "endDate": "A String", # The date that the person left this organization.
- "description": "A String", # A short description of the person's role in this organization. Deprecated.
- "title": "A String", # The person's job title or role within the organization.
- "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
- "location": "A String", # The location of this organization. Deprecated.
- "department": "A String", # The department within the organization. Deprecated.
- "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
- # - "work" - Work.
- # - "school" - School.
- "name": "A String", # The name of the organization.
- },
- ],
- "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
- # - "single" - Person is single.
- # - "in_a_relationship" - Person is in a relationship.
- # - "engaged" - Person is engaged.
- # - "married" - Person is married.
- # - "its_complicated" - The relationship is complicated.
- # - "open_relationship" - Person is in an open relationship.
- # - "widowed" - Person is widowed.
- # - "in_domestic_partnership" - Person is in a domestic partnership.
- # - "in_civil_union" - Person is in a civil union.
- "displayName": "A String", # The name of this person, which is suitable for display.
- "name": { # An object representation of the individual components of a person's name.
- "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
- "middleName": "A String", # The middle name of this person.
- "familyName": "A String", # The family name (last name) of this person.
- "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
- "givenName": "A String", # The given name (first name) of this person.
- "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
- },
- "language": "A String", # The user's preferred language for rendering.
- "url": "A String", # The URL of this person's profile.
- "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
- # - "male" - Male gender.
- # - "female" - Female gender.
- # - "other" - Other.
- "cover": { # The cover photo content.
- "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
- # - "banner" - One large image banner.
- "coverInfo": { # Extra information about the cover photo.
- "leftImageOffset": 42, # The difference between the left position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
- "topImageOffset": 42, # The difference between the top position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
- },
- "coverPhoto": { # The person's primary cover image.
- "url": "A String", # The url to the image.
- "width": 42, # The width to the image.
- "height": 42, # The height to the image.
- },
- },
- "isPlusUser": True or False, # Whether this user has signed up for Google+.
- "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'ed this page.
- "urls": [ # A list of URLs for this person.
- {
- "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
- # - "otherProfile" - URL for another profile.
- # - "contributor" - URL to a site for which this person is a contributor.
- # - "website" - URL for this Google+ Page's primary website.
- # - "other" - Other URL.
- "value": "A String", # The URL value.
- "label": "A String", # The label of the URL.
- },
- ],
- "ageRange": { # The age range of the person.
- "max": 42, # The age range's upper bound, if any.
- "min": 42, # The age range's lower bound, if any.
- },
- },
- ],
- "etag": "A String", # ETag of this response for caching purposes.
- "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
- "selfLink": "A String", # Link to this resource.
- }
-
-
listByActivity(activityId, collection, pageToken=None, maxResults=None)
-
List all of the people in the specified collection for a particular activity.
-
-Args:
- 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.
- pageToken: string, The continuation token, which is 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, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
- "title": "A String", # The title of this collection of people.
- "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
- {
- "braggingRights": "A String", # The "bragging rights" line of this person.
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- },
- "id": "A String", # The ID of this person.
- "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
- # - "person" - represents an actual person.
- # - "page" - represents a page.
- "verified": True or False, # Whether the person or Google+ Page has been verified.
- "tagline": "A String", # The brief description (tagline) of this person.
- "etag": "A String", # ETag of this response for caching purposes.
- "circledByCount": 42, # If a Google+ Page and for followers who are visible, the number of people who have added this page to a circle.
- "aboutMe": "A String", # A short biography for this person.
- "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
- "placesLived": [ # A list of places where this person has lived.
- {
- "primary": True or False, # If "true", this place of residence is this person's primary residence.
- "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
- },
- ],
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "nickname": "A String", # The nickname of this person.
- "currentLocation": "A String", # The current location for this person.
- "organizations": [ # A list of current or past organizations with which this person is associated.
- {
- "startDate": "A String", # The date that the person joined this organization.
- "endDate": "A String", # The date that the person left this organization.
- "description": "A String", # A short description of the person's role in this organization. Deprecated.
- "title": "A String", # The person's job title or role within the organization.
- "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
- "location": "A String", # The location of this organization. Deprecated.
- "department": "A String", # The department within the organization. Deprecated.
- "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
- # - "work" - Work.
- # - "school" - School.
- "name": "A String", # The name of the organization.
- },
- ],
- "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
- # - "single" - Person is single.
- # - "in_a_relationship" - Person is in a relationship.
- # - "engaged" - Person is engaged.
- # - "married" - Person is married.
- # - "its_complicated" - The relationship is complicated.
- # - "open_relationship" - Person is in an open relationship.
- # - "widowed" - Person is widowed.
- # - "in_domestic_partnership" - Person is in a domestic partnership.
- # - "in_civil_union" - Person is in a civil union.
- "displayName": "A String", # The name of this person, which is suitable for display.
- "name": { # An object representation of the individual components of a person's name.
- "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
- "middleName": "A String", # The middle name of this person.
- "familyName": "A String", # The family name (last name) of this person.
- "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
- "givenName": "A String", # The given name (first name) of this person.
- "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
- },
- "language": "A String", # The user's preferred language for rendering.
- "url": "A String", # The URL of this person's profile.
- "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
- # - "male" - Male gender.
- # - "female" - Female gender.
- # - "other" - Other.
- "cover": { # The cover photo content.
- "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
- # - "banner" - One large image banner.
- "coverInfo": { # Extra information about the cover photo.
- "leftImageOffset": 42, # The difference between the left position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
- "topImageOffset": 42, # The difference between the top position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
- },
- "coverPhoto": { # The person's primary cover image.
- "url": "A String", # The url to the image.
- "width": 42, # The width to the image.
- "height": 42, # The height to the image.
- },
- },
- "isPlusUser": True or False, # Whether this user has signed up for Google+.
- "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'ed this page.
- "urls": [ # A list of URLs for this person.
- {
- "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
- # - "otherProfile" - URL for another profile.
- # - "contributor" - URL to a site for which this person is a contributor.
- # - "website" - URL for this Google+ Page's primary website.
- # - "other" - Other URL.
- "value": "A String", # The URL value.
- "label": "A String", # The label of the URL.
- },
- ],
- "ageRange": { # The age range of the person.
- "max": 42, # The age range's upper bound, if any.
- "min": 42, # The age range's lower bound, if any.
- },
- },
- ],
- "etag": "A String", # ETag of this response for caching purposes.
- "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
- "selfLink": "A String", # Link to this resource.
- }
-
-
listByActivity_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
search(query, pageToken=None, language=None, maxResults=None)
-
Search all public profiles.
-
-Args:
- query: string, Specify a query string for full text search of public text in all profiles. (required)
- pageToken: string, The continuation token, which is 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 can 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, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
- "title": "A String", # The title of this collection of people.
- "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
- {
- "braggingRights": "A String", # The "bragging rights" line of this person.
- "image": { # The representation of the person's profile photo.
- "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
- },
- "id": "A String", # The ID of this person.
- "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
- # - "person" - represents an actual person.
- # - "page" - represents a page.
- "verified": True or False, # Whether the person or Google+ Page has been verified.
- "tagline": "A String", # The brief description (tagline) of this person.
- "etag": "A String", # ETag of this response for caching purposes.
- "circledByCount": 42, # If a Google+ Page and for followers who are visible, the number of people who have added this page to a circle.
- "aboutMe": "A String", # A short biography for this person.
- "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
- "placesLived": [ # A list of places where this person has lived.
- {
- "primary": True or False, # If "true", this place of residence is this person's primary residence.
- "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
- },
- ],
- "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
- "nickname": "A String", # The nickname of this person.
- "currentLocation": "A String", # The current location for this person.
- "organizations": [ # A list of current or past organizations with which this person is associated.
- {
- "startDate": "A String", # The date that the person joined this organization.
- "endDate": "A String", # The date that the person left this organization.
- "description": "A String", # A short description of the person's role in this organization. Deprecated.
- "title": "A String", # The person's job title or role within the organization.
- "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
- "location": "A String", # The location of this organization. Deprecated.
- "department": "A String", # The department within the organization. Deprecated.
- "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
- # - "work" - Work.
- # - "school" - School.
- "name": "A String", # The name of the organization.
- },
- ],
- "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
- # - "single" - Person is single.
- # - "in_a_relationship" - Person is in a relationship.
- # - "engaged" - Person is engaged.
- # - "married" - Person is married.
- # - "its_complicated" - The relationship is complicated.
- # - "open_relationship" - Person is in an open relationship.
- # - "widowed" - Person is widowed.
- # - "in_domestic_partnership" - Person is in a domestic partnership.
- # - "in_civil_union" - Person is in a civil union.
- "displayName": "A String", # The name of this person, which is suitable for display.
- "name": { # An object representation of the individual components of a person's name.
- "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
- "middleName": "A String", # The middle name of this person.
- "familyName": "A String", # The family name (last name) of this person.
- "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
- "givenName": "A String", # The given name (first name) of this person.
- "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
- },
- "language": "A String", # The user's preferred language for rendering.
- "url": "A String", # The URL of this person's profile.
- "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
- # - "male" - Male gender.
- # - "female" - Female gender.
- # - "other" - Other.
- "cover": { # The cover photo content.
- "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
- # - "banner" - One large image banner.
- "coverInfo": { # Extra information about the cover photo.
- "leftImageOffset": 42, # The difference between the left position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
- "topImageOffset": 42, # The difference between the top position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
- },
- "coverPhoto": { # The person's primary cover image.
- "url": "A String", # The url to the image.
- "width": 42, # The width to the image.
- "height": 42, # The height to the image.
- },
- },
- "isPlusUser": True or False, # Whether this user has signed up for Google+.
- "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'ed this page.
- "urls": [ # A list of URLs for this person.
- {
- "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
- # - "otherProfile" - URL for another profile.
- # - "contributor" - URL to a site for which this person is a contributor.
- # - "website" - URL for this Google+ Page's primary website.
- # - "other" - Other URL.
- "value": "A String", # The URL value.
- "label": "A String", # The label of the URL.
- },
- ],
- "ageRange": { # The age range of the person.
- "max": 42, # The age range's upper bound, if any.
- "min": 42, # The age range's lower bound, if any.
- },
- },
- ],
- "etag": "A String", # ETag of this response for caching purposes.
- "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
- "selfLink": "A String", # Link to this resource.
- }
-
-
search_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- predict(hostedModelName, body)
-Submit input and request an output against a hosted model.
-Method Details
-
-
predict(hostedModelName, body)
-
Submit input and request an output against a hosted model.
-
-Args:
- hostedModelName: string, The name of a hosted model. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "input": { # Input to the model for a prediction
- "csvInstance": [ # A list of input features, these can be strings or doubles.
- "",
- ],
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "prediction#output", # What kind of resource this is.
- "outputLabel": "A String", # The most likely class label [Categorical models only].
- "id": "A String", # The unique name for the predictive model.
- "outputMulti": [ # A list of class labels with their estimated probabilities [Categorical models only].
- {
- "score": 3.14, # The probability of the class label.
- "label": "A String", # The class label.
- },
- ],
- "outputValue": 3.14, # The estimated regression value [Regression models only].
- "selfLink": "A String", # A URL to re-request this resource.
- }
-
Instance Methods
-
- hostedmodels()
-
-Returns the hostedmodels Resource.
-
-
- trainedmodels()
-
-Returns the trainedmodels Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/prediction_v1_5.trainedmodels.html b/docs/dyn/prediction_v1_5.trainedmodels.html
deleted file mode 100644
index 1d4c096..0000000
--- a/docs/dyn/prediction_v1_5.trainedmodels.html
+++ /dev/null
@@ -1,498 +0,0 @@
-
-
-
-
-Instance Methods
-
- analyze(id)
-Get analysis of the model and the data the model was trained on.
-
- delete(id)
-Delete a trained model.
-
- get(id)
-Check training status of your model.
-
- insert(body)
-Begin training your model.
-
- list(pageToken=None, maxResults=None)
-List available models.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- predict(id, body)
-Submit model id and request a prediction.
-
- update(id, body)
-Add new data to a trained model.
-Method Details
-
-
analyze(id)
-
Get analysis of the model and the data the model was trained on.
-
-Args:
- id: string, The unique name for the predictive model. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "prediction#analyze", # What kind of resource this is.
- "errors": [ # List of errors with the data.
- {
- "a_key": "A String", # Error level followed by a detailed error message.
- },
- ],
- "dataDescription": { # Description of the data the model was trained on.
- "outputFeature": { # Description of the output value or label.
- "text": [ # Description of the output labels in the data set.
- {
- "count": "A String", # Number of times the output label occurred in the data set.
- "value": "A String", # The output label.
- },
- ],
- "numeric": { # Description of the output values in the data set.
- "count": "A String", # Number of numeric output values in the data set.
- "variance": 3.14, # Variance of the output values in the data set.
- "mean": 3.14, # Mean of the output values in the data set.
- },
- },
- "features": [ # Description of the input features in the data set.
- {
- "index": "A String", # The feature index.
- "text": { # Description of multiple-word text values of this feature.
- "count": "A String", # Number of multiple-word text values for this feature.
- },
- "numeric": { # Description of the numeric values of this feature.
- "count": "A String", # Number of numeric values for this feature in the data set.
- "variance": 3.14, # Variance of the numeric values of this feature in the data set.
- "mean": 3.14, # Mean of the numeric values of this feature in the data set.
- },
- "categorical": { # Description of the categorical values of this feature.
- "count": "A String", # Number of categorical values for this feature in the data.
- "values": [ # List of all the categories for this feature in the data set.
- {
- "count": "A String", # Number of times this feature had this value.
- "value": "A String", # The category name.
- },
- ],
- },
- },
- ],
- },
- "modelDescription": { # Description of the model.
- "confusionMatrixRowTotals": { # A list of the confusion matrix row totals
- "a_key": 3.14,
- },
- "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes [Categorical models only].
- "a_key": {
- "a_key": 3.14,
- },
- },
- "modelinfo": { # Basic information about the model.
- "kind": "prediction#training", # What kind of resource this is.
- "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
- "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
- "storageDataLocation": "A String", # Google storage location of the training data file.
- "modelType": "A String", # Type of predictive model (classification or regression)
- "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
- "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
- "modelInfo": { # Model metadata.
- "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
- "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
- "numberInstances": "A String", # Number of valid data instances used in the trained model.
- "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
- "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
- },
- "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
- "trainingInstances": [ # Instances to train model on.
- {
- "output": "A String", # The generic output value - could be regression or class label
- "csvInstance": [ # The input features for this instance
- "",
- ],
- },
- ],
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
- { # Class label (string).
- "a_key": 3.14,
- },
- ],
- },
- },
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- }
-
-
delete(id)
-
Delete a trained model.
-
-Args:
- id: string, The unique name for the predictive model. (required)
-
-
-
get(id)
-
Check training status of your model.
-
-Args:
- id: string, The unique name for the predictive model. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "prediction#training", # What kind of resource this is.
- "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
- "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
- "storageDataLocation": "A String", # Google storage location of the training data file.
- "modelType": "A String", # Type of predictive model (classification or regression)
- "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
- "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
- "modelInfo": { # Model metadata.
- "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
- "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
- "numberInstances": "A String", # Number of valid data instances used in the trained model.
- "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
- "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
- },
- "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
- "trainingInstances": [ # Instances to train model on.
- {
- "output": "A String", # The generic output value - could be regression or class label
- "csvInstance": [ # The input features for this instance
- "",
- ],
- },
- ],
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
- { # Class label (string).
- "a_key": 3.14,
- },
- ],
- }
-
-
insert(body)
-
Begin training your model.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "prediction#training", # What kind of resource this is.
- "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
- "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
- "storageDataLocation": "A String", # Google storage location of the training data file.
- "modelType": "A String", # Type of predictive model (classification or regression)
- "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
- "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
- "modelInfo": { # Model metadata.
- "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
- "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
- "numberInstances": "A String", # Number of valid data instances used in the trained model.
- "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
- "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
- },
- "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
- "trainingInstances": [ # Instances to train model on.
- {
- "output": "A String", # The generic output value - could be regression or class label
- "csvInstance": [ # The input features for this instance
- "",
- ],
- },
- ],
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
- { # Class label (string).
- "a_key": 3.14,
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "prediction#training", # What kind of resource this is.
- "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
- "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
- "storageDataLocation": "A String", # Google storage location of the training data file.
- "modelType": "A String", # Type of predictive model (classification or regression)
- "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
- "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
- "modelInfo": { # Model metadata.
- "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
- "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
- "numberInstances": "A String", # Number of valid data instances used in the trained model.
- "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
- "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
- },
- "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
- "trainingInstances": [ # Instances to train model on.
- {
- "output": "A String", # The generic output value - could be regression or class label
- "csvInstance": [ # The input features for this instance
- "",
- ],
- },
- ],
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
- { # Class label (string).
- "a_key": 3.14,
- },
- ],
- }
-
-
list(pageToken=None, maxResults=None)
-
List available models.
-
-Args:
- pageToken: string, Pagination token
- maxResults: integer, Maximum number of results to return
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
- "items": [ # List of models.
- {
- "kind": "prediction#training", # What kind of resource this is.
- "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
- "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
- "storageDataLocation": "A String", # Google storage location of the training data file.
- "modelType": "A String", # Type of predictive model (classification or regression)
- "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
- "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
- "modelInfo": { # Model metadata.
- "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
- "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
- "numberInstances": "A String", # Number of valid data instances used in the trained model.
- "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
- "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
- },
- "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
- "trainingInstances": [ # Instances to train model on.
- {
- "output": "A String", # The generic output value - could be regression or class label
- "csvInstance": [ # The input features for this instance
- "",
- ],
- },
- ],
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
- { # Class label (string).
- "a_key": 3.14,
- },
- ],
- },
- ],
- "kind": "prediction#list", # What kind of resource this is.
- "selfLink": "A String", # A URL to re-request this resource.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
predict(id, body)
-
Submit model id and request a prediction.
-
-Args:
- id: string, The unique name for the predictive model. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "input": { # Input to the model for a prediction
- "csvInstance": [ # A list of input features, these can be strings or doubles.
- "",
- ],
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "prediction#output", # What kind of resource this is.
- "outputLabel": "A String", # The most likely class label [Categorical models only].
- "id": "A String", # The unique name for the predictive model.
- "outputMulti": [ # A list of class labels with their estimated probabilities [Categorical models only].
- {
- "score": 3.14, # The probability of the class label.
- "label": "A String", # The class label.
- },
- ],
- "outputValue": 3.14, # The estimated regression value [Regression models only].
- "selfLink": "A String", # A URL to re-request this resource.
- }
-
-
update(id, body)
-
Add new data to a trained model.
-
-Args:
- id: string, The unique name for the predictive model. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "output": "A String", # The generic output value - could be regression value or class label
- "csvInstance": [ # The input features for this instance
- "",
- ],
- "label": "A String", # The class label of this instance
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "prediction#training", # What kind of resource this is.
- "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
- "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
- "storageDataLocation": "A String", # Google storage location of the training data file.
- "modelType": "A String", # Type of predictive model (classification or regression)
- "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
- "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
- "modelInfo": { # Model metadata.
- "numberLabels": "A String", # Number of class labels in the trained model [Categorical models only].
- "meanSquaredError": 3.14, # An estimated mean squared error. The can be used to measure the quality of the predicted model [Regression models only].
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION)
- "numberInstances": "A String", # Number of valid data instances used in the trained model.
- "classWeightedAccuracy": 3.14, # Estimated accuracy of model taking utility weights into account [Categorical models only].
- "classificationAccuracy": 3.14, # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data [Categorical models only].
- },
- "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
- "trainingInstances": [ # Instances to train model on.
- {
- "output": "A String", # The generic output value - could be regression or class label
- "csvInstance": [ # The input features for this instance
- "",
- ],
- },
- ],
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified [Categorical models only].
- { # Class label (string).
- "a_key": 3.14,
- },
- ],
- }
-
Instance Methods
-
- predict(project, hostedModelName, body)
-Submit input and request an output against a hosted model.
-Method Details
-
-
predict(project, hostedModelName, body)
-
Submit input and request an output against a hosted model.
-
-Args:
- project: string, The project associated with the model. (required)
- hostedModelName: string, The name of a hosted model. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "input": { # Input to the model for a prediction.
- "csvInstance": [ # A list of input features, these can be strings or doubles.
- "",
- ],
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "prediction#output", # What kind of resource this is.
- "outputLabel": "A String", # The most likely class label (Categorical models only).
- "id": "A String", # The unique name for the predictive model.
- "outputMulti": [ # A list of class labels with their estimated probabilities (Categorical models only).
- {
- "score": "A String", # The probability of the class label.
- "label": "A String", # The class label.
- },
- ],
- "outputValue": 3.14, # The estimated regression value (Regression models only).
- "selfLink": "A String", # A URL to re-request this resource.
- }
-
Instance Methods
-
- hostedmodels()
-
-Returns the hostedmodels Resource.
-
-
- trainedmodels()
-
-Returns the trainedmodels Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/prediction_v1_6.trainedmodels.html b/docs/dyn/prediction_v1_6.trainedmodels.html
deleted file mode 100644
index c591ff3..0000000
--- a/docs/dyn/prediction_v1_6.trainedmodels.html
+++ /dev/null
@@ -1,427 +0,0 @@
-
-
-
-
-Instance Methods
-
- analyze(project, id)
-Get analysis of the model and the data the model was trained on.
-
- delete(project, id)
-Delete a trained model.
-
- get(project, id)
-Check training status of your model.
-
- insert(project, body)
-Train a Prediction API model.
-
- list(project, pageToken=None, maxResults=None)
-List available models.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- predict(project, id, body)
-Submit model id and request a prediction.
-
- update(project, id, body)
-Add new data to a trained model.
-Method Details
-
-
analyze(project, id)
-
Get analysis of the model and the data the model was trained on.
-
-Args:
- project: string, The project associated with the model. (required)
- id: string, The unique name for the predictive model. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "prediction#analyze", # What kind of resource this is.
- "errors": [ # List of errors with the data.
- {
- "a_key": "A String", # Error level followed by a detailed error message.
- },
- ],
- "dataDescription": { # Description of the data the model was trained on.
- "outputFeature": { # Description of the output value or label.
- "text": [ # Description of the output labels in the data set.
- {
- "count": "A String", # Number of times the output label occurred in the data set.
- "value": "A String", # The output label.
- },
- ],
- "numeric": { # Description of the output values in the data set.
- "count": "A String", # Number of numeric output values in the data set.
- "variance": "A String", # Variance of the output values in the data set.
- "mean": "A String", # Mean of the output values in the data set.
- },
- },
- "features": [ # Description of the input features in the data set.
- {
- "index": "A String", # The feature index.
- "text": { # Description of multiple-word text values of this feature.
- "count": "A String", # Number of multiple-word text values for this feature.
- },
- "numeric": { # Description of the numeric values of this feature.
- "count": "A String", # Number of numeric values for this feature in the data set.
- "variance": "A String", # Variance of the numeric values of this feature in the data set.
- "mean": "A String", # Mean of the numeric values of this feature in the data set.
- },
- "categorical": { # Description of the categorical values of this feature.
- "count": "A String", # Number of categorical values for this feature in the data.
- "values": [ # List of all the categories for this feature in the data set.
- {
- "count": "A String", # Number of times this feature had this value.
- "value": "A String", # The category name.
- },
- ],
- },
- },
- ],
- },
- "modelDescription": { # Description of the model.
- "confusionMatrixRowTotals": { # A list of the confusion matrix row totals.
- "a_key": "A String",
- },
- "confusionMatrix": { # An output confusion matrix. This shows an estimate for how this model will do in predictions. This is first indexed by the true class label. For each true class label, this provides a pair {predicted_label, count}, where count is the estimated number of times the model will predict the predicted label given the true label. Will not output if more then 100 classes (Categorical models only).
- "a_key": { # Confusion matrix information for the true class label.
- "a_key": "A String", # Average number of times an instance with correct class label modelDescription.confusionMatrix.(key) was wrongfully classified as this label.
- },
- },
- "modelinfo": { # Basic information about the model.
- "kind": "prediction#training", # What kind of resource this is.
- "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
- "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
- "storageDataLocation": "A String", # Google storage location of the training data file.
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION).
- "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
- "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
- "modelInfo": { # Model metadata.
- "numberLabels": "A String", # Number of class labels in the trained model (Categorical models only).
- "meanSquaredError": "A String", # An estimated mean squared error. The can be used to measure the quality of the predicted model (Regression models only).
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION).
- "numberInstances": "A String", # Number of valid data instances used in the trained model.
- "classWeightedAccuracy": "A String", # Estimated accuracy of model taking utility weights into account (Categorical models only).
- "classificationAccuracy": "A String", # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data (Categorical models only).
- },
- "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- },
- },
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- }
-
-
delete(project, id)
-
Delete a trained model.
-
-Args:
- project: string, The project associated with the model. (required)
- id: string, The unique name for the predictive model. (required)
-
-
-
get(project, id)
-
Check training status of your model.
-
-Args:
- project: string, The project associated with the model. (required)
- id: string, The unique name for the predictive model. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "prediction#training", # What kind of resource this is.
- "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
- "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
- "storageDataLocation": "A String", # Google storage location of the training data file.
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION).
- "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
- "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
- "modelInfo": { # Model metadata.
- "numberLabels": "A String", # Number of class labels in the trained model (Categorical models only).
- "meanSquaredError": "A String", # An estimated mean squared error. The can be used to measure the quality of the predicted model (Regression models only).
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION).
- "numberInstances": "A String", # Number of valid data instances used in the trained model.
- "classWeightedAccuracy": "A String", # Estimated accuracy of model taking utility weights into account (Categorical models only).
- "classificationAccuracy": "A String", # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data (Categorical models only).
- },
- "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- }
-
-
insert(project, body)
-
Train a Prediction API model.
-
-Args:
- project: string, The project associated with the model. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "storageDataLocation": "A String", # Google storage location of the training data file.
- "modelType": "A String", # Type of predictive model (classification or regression).
- "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
- "sourceModel": "A String", # The Id of the model to be copied over.
- "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
- "trainingInstances": [ # Instances to train model on.
- {
- "output": "A String", # The generic output value - could be regression or class label.
- "csvInstance": [ # The input features for this instance.
- "",
- ],
- },
- ],
- "id": "A String", # The unique name for the predictive model.
- "utility": [ # A class weighting function, which allows the importance weights for class labels to be specified (Categorical models only).
- { # Class label (string).
- "a_key": 3.14,
- },
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "prediction#training", # What kind of resource this is.
- "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
- "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
- "storageDataLocation": "A String", # Google storage location of the training data file.
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION).
- "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
- "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
- "modelInfo": { # Model metadata.
- "numberLabels": "A String", # Number of class labels in the trained model (Categorical models only).
- "meanSquaredError": "A String", # An estimated mean squared error. The can be used to measure the quality of the predicted model (Regression models only).
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION).
- "numberInstances": "A String", # Number of valid data instances used in the trained model.
- "classWeightedAccuracy": "A String", # Estimated accuracy of model taking utility weights into account (Categorical models only).
- "classificationAccuracy": "A String", # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data (Categorical models only).
- },
- "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- }
-
-
list(project, pageToken=None, maxResults=None)
-
List available models.
-
-Args:
- project: string, The project associated with the model. (required)
- pageToken: string, Pagination token.
- maxResults: integer, Maximum number of results to return.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
- "items": [ # List of models.
- {
- "kind": "prediction#training", # What kind of resource this is.
- "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
- "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
- "storageDataLocation": "A String", # Google storage location of the training data file.
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION).
- "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
- "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
- "modelInfo": { # Model metadata.
- "numberLabels": "A String", # Number of class labels in the trained model (Categorical models only).
- "meanSquaredError": "A String", # An estimated mean squared error. The can be used to measure the quality of the predicted model (Regression models only).
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION).
- "numberInstances": "A String", # Number of valid data instances used in the trained model.
- "classWeightedAccuracy": "A String", # Estimated accuracy of model taking utility weights into account (Categorical models only).
- "classificationAccuracy": "A String", # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data (Categorical models only).
- },
- "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- },
- ],
- "kind": "prediction#list", # What kind of resource this is.
- "selfLink": "A String", # A URL to re-request this resource.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
predict(project, id, body)
-
Submit model id and request a prediction.
-
-Args:
- project: string, The project associated with the model. (required)
- id: string, The unique name for the predictive model. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "input": { # Input to the model for a prediction.
- "csvInstance": [ # A list of input features, these can be strings or doubles.
- "",
- ],
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "prediction#output", # What kind of resource this is.
- "outputLabel": "A String", # The most likely class label (Categorical models only).
- "id": "A String", # The unique name for the predictive model.
- "outputMulti": [ # A list of class labels with their estimated probabilities (Categorical models only).
- {
- "score": "A String", # The probability of the class label.
- "label": "A String", # The class label.
- },
- ],
- "outputValue": 3.14, # The estimated regression value (Regression models only).
- "selfLink": "A String", # A URL to re-request this resource.
- }
-
-
update(project, id, body)
-
Add new data to a trained model.
-
-Args:
- project: string, The project associated with the model. (required)
- id: string, The unique name for the predictive model. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "output": "A String", # The generic output value - could be regression or class label.
- "csvInstance": [ # The input features for this instance.
- "",
- ],
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "prediction#training", # What kind of resource this is.
- "created": "A String", # Insert time of the model (as a RFC 3339 timestamp).
- "trainingComplete": "A String", # Training completion time (as a RFC 3339 timestamp).
- "storageDataLocation": "A String", # Google storage location of the training data file.
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION).
- "storagePMMLModelLocation": "A String", # Google storage location of the pmml model file.
- "trainingStatus": "A String", # The current status of the training job. This can be one of following: RUNNING; DONE; ERROR; ERROR: TRAINING JOB NOT FOUND
- "modelInfo": { # Model metadata.
- "numberLabels": "A String", # Number of class labels in the trained model (Categorical models only).
- "meanSquaredError": "A String", # An estimated mean squared error. The can be used to measure the quality of the predicted model (Regression models only).
- "modelType": "A String", # Type of predictive model (CLASSIFICATION or REGRESSION).
- "numberInstances": "A String", # Number of valid data instances used in the trained model.
- "classWeightedAccuracy": "A String", # Estimated accuracy of model taking utility weights into account (Categorical models only).
- "classificationAccuracy": "A String", # A number between 0.0 and 1.0, where 1.0 is 100% accurate. This is an estimate, based on the amount and quality of the training data, of the estimated prediction accuracy. You can use this is a guide to decide whether the results are accurate enough for your needs. This estimate will be more reliable if your real input data is similar to your training data (Categorical models only).
- },
- "storagePMMLLocation": "A String", # Google storage location of the preprocessing pmml file.
- "id": "A String", # The unique name for the predictive model.
- "selfLink": "A String", # A URL to re-request this resource.
- }
-
Instance Methods
-
- get(customerId)
-Gets a customer resource if one exists and is owned by the reseller.
-
- insert(body, customerAuthToken=None)
-Creates a customer resource if one does not already exist.
-
- patch(customerId, body)
-Update a customer resource if one it exists and is owned by the reseller. This method supports patch semantics.
-
- update(customerId, body)
-Update a customer resource if one it exists and is owned by the reseller.
-Method Details
-
-
get(customerId)
-
Gets a customer resource if one exists and is owned by the reseller.
-
-Args:
- customerId: string, Id of the Customer (required)
-
-Returns:
- An object of the form:
-
- { # JSON template for a customer.
- "customerDomain": "A String", # The domain name of the customer.
- "alternateEmail": "A String", # The alternate email of the customer.
- "kind": "reseller#customer", # Identifies the resource as a customer.
- "resourceUiUrl": "A String", # Ui url for customer resource.
- "phoneNumber": "A String", # The phone number of the customer.
- "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
- "kind": "customers#address", # Identifies the resource as a customer address.
- "organizationName": "A String", # Name of the organization.
- "countryCode": "A String", # ISO 3166 country code.
- "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "addressLine2": "A String", # Address line 2 of the address.
- "addressLine3": "A String", # Address line 3 of the address.
- "contactName": "A String", # Name of the contact person.
- "addressLine1": "A String", # Address line 1 of the address.
- "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- },
- "customerId": "A String", # The id of the customer.
- }
-
-
insert(body, customerAuthToken=None)
-
Creates a customer resource if one does not already exist.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # JSON template for a customer.
- "customerDomain": "A String", # The domain name of the customer.
- "alternateEmail": "A String", # The alternate email of the customer.
- "kind": "reseller#customer", # Identifies the resource as a customer.
- "resourceUiUrl": "A String", # Ui url for customer resource.
- "phoneNumber": "A String", # The phone number of the customer.
- "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
- "kind": "customers#address", # Identifies the resource as a customer address.
- "organizationName": "A String", # Name of the organization.
- "countryCode": "A String", # ISO 3166 country code.
- "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "addressLine2": "A String", # Address line 2 of the address.
- "addressLine3": "A String", # Address line 3 of the address.
- "contactName": "A String", # Name of the contact person.
- "addressLine1": "A String", # Address line 1 of the address.
- "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- },
- "customerId": "A String", # The id of the customer.
- }
-
- customerAuthToken: string, An auth token needed for inserting a customer for which domain already exists. Can be generated at https://www.google.com/a/cpanel//TransferToken. Optional.
-
-Returns:
- An object of the form:
-
- { # JSON template for a customer.
- "customerDomain": "A String", # The domain name of the customer.
- "alternateEmail": "A String", # The alternate email of the customer.
- "kind": "reseller#customer", # Identifies the resource as a customer.
- "resourceUiUrl": "A String", # Ui url for customer resource.
- "phoneNumber": "A String", # The phone number of the customer.
- "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
- "kind": "customers#address", # Identifies the resource as a customer address.
- "organizationName": "A String", # Name of the organization.
- "countryCode": "A String", # ISO 3166 country code.
- "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "addressLine2": "A String", # Address line 2 of the address.
- "addressLine3": "A String", # Address line 3 of the address.
- "contactName": "A String", # Name of the contact person.
- "addressLine1": "A String", # Address line 1 of the address.
- "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- },
- "customerId": "A String", # The id of the customer.
- }
-
-
patch(customerId, body)
-
Update a customer resource if one it exists and is owned by the reseller. This method supports patch semantics.
-
-Args:
- customerId: string, Id of the Customer (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # JSON template for a customer.
- "customerDomain": "A String", # The domain name of the customer.
- "alternateEmail": "A String", # The alternate email of the customer.
- "kind": "reseller#customer", # Identifies the resource as a customer.
- "resourceUiUrl": "A String", # Ui url for customer resource.
- "phoneNumber": "A String", # The phone number of the customer.
- "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
- "kind": "customers#address", # Identifies the resource as a customer address.
- "organizationName": "A String", # Name of the organization.
- "countryCode": "A String", # ISO 3166 country code.
- "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "addressLine2": "A String", # Address line 2 of the address.
- "addressLine3": "A String", # Address line 3 of the address.
- "contactName": "A String", # Name of the contact person.
- "addressLine1": "A String", # Address line 1 of the address.
- "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- },
- "customerId": "A String", # The id of the customer.
- }
-
-
-Returns:
- An object of the form:
-
- { # JSON template for a customer.
- "customerDomain": "A String", # The domain name of the customer.
- "alternateEmail": "A String", # The alternate email of the customer.
- "kind": "reseller#customer", # Identifies the resource as a customer.
- "resourceUiUrl": "A String", # Ui url for customer resource.
- "phoneNumber": "A String", # The phone number of the customer.
- "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
- "kind": "customers#address", # Identifies the resource as a customer address.
- "organizationName": "A String", # Name of the organization.
- "countryCode": "A String", # ISO 3166 country code.
- "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "addressLine2": "A String", # Address line 2 of the address.
- "addressLine3": "A String", # Address line 3 of the address.
- "contactName": "A String", # Name of the contact person.
- "addressLine1": "A String", # Address line 1 of the address.
- "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- },
- "customerId": "A String", # The id of the customer.
- }
-
-
update(customerId, body)
-
Update a customer resource if one it exists and is owned by the reseller.
-
-Args:
- customerId: string, Id of the Customer (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # JSON template for a customer.
- "customerDomain": "A String", # The domain name of the customer.
- "alternateEmail": "A String", # The alternate email of the customer.
- "kind": "reseller#customer", # Identifies the resource as a customer.
- "resourceUiUrl": "A String", # Ui url for customer resource.
- "phoneNumber": "A String", # The phone number of the customer.
- "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
- "kind": "customers#address", # Identifies the resource as a customer address.
- "organizationName": "A String", # Name of the organization.
- "countryCode": "A String", # ISO 3166 country code.
- "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "addressLine2": "A String", # Address line 2 of the address.
- "addressLine3": "A String", # Address line 3 of the address.
- "contactName": "A String", # Name of the contact person.
- "addressLine1": "A String", # Address line 1 of the address.
- "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- },
- "customerId": "A String", # The id of the customer.
- }
-
-
-Returns:
- An object of the form:
-
- { # JSON template for a customer.
- "customerDomain": "A String", # The domain name of the customer.
- "alternateEmail": "A String", # The alternate email of the customer.
- "kind": "reseller#customer", # Identifies the resource as a customer.
- "resourceUiUrl": "A String", # Ui url for customer resource.
- "phoneNumber": "A String", # The phone number of the customer.
- "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
- "kind": "customers#address", # Identifies the resource as a customer address.
- "organizationName": "A String", # Name of the organization.
- "countryCode": "A String", # ISO 3166 country code.
- "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- "addressLine2": "A String", # Address line 2 of the address.
- "addressLine3": "A String", # Address line 3 of the address.
- "contactName": "A String", # Name of the contact person.
- "addressLine1": "A String", # Address line 1 of the address.
- "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
- },
- "customerId": "A String", # The id of the customer.
- }
-
Instance Methods
-
- customers()
-
-Returns the customers Resource.
-
-
- subscriptions()
-
-Returns the subscriptions Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/reseller_v1.subscriptions.html b/docs/dyn/reseller_v1.subscriptions.html
deleted file mode 100644
index d9b420d..0000000
--- a/docs/dyn/reseller_v1.subscriptions.html
+++ /dev/null
@@ -1,549 +0,0 @@
-
-
-
-
-Instance Methods
-
- changePlan(customerId, subscriptionId, body)
-Changes the plan of a subscription
-
- changeRenewalSettings(customerId, subscriptionId, body)
-Changes the renewal settings of a subscription
-
- changeSeats(customerId, subscriptionId, body)
-Changes the seats configuration of a subscription
-
- delete(customerId, subscriptionId, deletionType)
-Cancels/Downgrades a subscription.
-
- get(customerId, subscriptionId)
-Gets a subscription of the customer.
-
- insert(customerId, body, customerAuthToken=None)
-Creates/Transfers a subscription for the customer.
-
- list(customerAuthToken=None, pageToken=None, maxResults=None, customerNamePrefix=None, customerId=None)
-Lists subscriptions of a reseller, optionally filtered by a customer name prefix.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- startPaidService(customerId, subscriptionId)
-Starts paid service of a trial subscription
-Method Details
-
-
changePlan(customerId, subscriptionId, body)
-
Changes the plan of a subscription
-
-Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # JSON template for the ChangePlan rpc request.
- "planName": "A String", # Name of the plan to change to.
- "kind": "subscriptions#changePlanRequest", # Identifies the resource as a subscription change plan request.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
- },
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- }
-
-
-Returns:
- An object of the form:
-
- { # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
- },
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
- },
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
- },
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
- },
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
- },
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "subscriptionId": "A String", # The id of the subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
- }
-
-
changeRenewalSettings(customerId, subscriptionId, body)
-
Changes the renewal settings of a subscription
-
-Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # JSON template for a subscription renewal settings.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
-}
-
-
-Returns:
- An object of the form:
-
- { # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
- },
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
- },
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
- },
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
- },
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
- },
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "subscriptionId": "A String", # The id of the subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
- }
-
-
changeSeats(customerId, subscriptionId, body)
-
Changes the seats configuration of a subscription
-
-Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # JSON template for subscription seats.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
-}
-
-
-Returns:
- An object of the form:
-
- { # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
- },
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
- },
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
- },
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
- },
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
- },
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "subscriptionId": "A String", # The id of the subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
- }
-
-
delete(customerId, subscriptionId, deletionType)
-
Cancels/Downgrades a subscription.
-
-Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
- deletionType: string, Whether the subscription is to be fully cancelled or downgraded (required)
- Allowed values
- cancel - Cancels the subscription immediately
- downgrade - Downgrades a Google Apps for Business subscription to Google Apps
- suspend - Suspends the subscriptions for 4 days before cancelling it
-
-
-
get(customerId, subscriptionId)
-
Gets a subscription of the customer.
-
-Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
-
-Returns:
- An object of the form:
-
- { # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
- },
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
- },
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
- },
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
- },
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
- },
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "subscriptionId": "A String", # The id of the subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
- }
-
-
insert(customerId, body, customerAuthToken=None)
-
Creates/Transfers a subscription for the customer.
-
-Args:
- customerId: string, Id of the Customer (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
- },
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
- },
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
- },
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
- },
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
- },
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "subscriptionId": "A String", # The id of the subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
- }
-
- customerAuthToken: string, An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken. Optional.
-
-Returns:
- An object of the form:
-
- { # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
- },
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
- },
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
- },
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
- },
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
- },
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "subscriptionId": "A String", # The id of the subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
- }
-
-
list(customerAuthToken=None, pageToken=None, maxResults=None, customerNamePrefix=None, customerId=None)
-
Lists subscriptions of a reseller, optionally filtered by a customer name prefix.
-
-Args:
- customerAuthToken: string, An auth token needed if the customer is not a resold customer of this reseller. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken.Optional.
- pageToken: string, Token to specify next page in the list
- maxResults: integer, Maximum number of results to return
- customerNamePrefix: string, Prefix of the customer's domain name by which the subscriptions should be filtered. Optional
- customerId: string, Id of the Customer
-
-Returns:
- An object of the form:
-
- { # JSON template for a subscription list.
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "kind": "reseller#subscriptions", # Identifies the resource as a collection of subscriptions.
- "subscriptions": [ # The subscriptions in this page of results.
- { # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
- },
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
- },
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
- },
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
- },
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
- },
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "subscriptionId": "A String", # The id of the subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
- },
- ],
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
startPaidService(customerId, subscriptionId)
-
Starts paid service of a trial subscription
-
-Args:
- customerId: string, Id of the Customer (required)
- subscriptionId: string, Id of the subscription, which is unique for a customer (required)
-
-Returns:
- An object of the form:
-
- { # JSON template for a subscription.
- "renewalSettings": { # JSON template for a subscription renewal settings. # Renewal settings of the subscription.
- "kind": "subscriptions#renewalSettings", # Identifies the resource as a subscription renewal setting.
- "renewalType": "A String", # Subscription renewal type.
- },
- "skuId": "A String", # Name of the sku for which this subscription is purchased.
- "kind": "reseller#subscription", # Identifies the resource as a Subscription.
- "trialSettings": { # Trial Settings of the subscription.
- "trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch.
- "isInTrial": True or False, # Whether the subscription is in trial.
- },
- "transferInfo": { # Transfer related information for the subscription.
- "transferabilityExpirationTime": "A String", # Time when transfer token or intent to transfer will expire.
- "minimumTransferableSeats": 42,
- },
- "resourceUiUrl": "A String", # Ui url for subscription resource.
- "seats": { # JSON template for subscription seats. # Number/Limit of seats in the new plan.
- "kind": "subscriptions#seats", # Identifies the resource as a subscription change plan request.
- "numberOfSeats": 42, # Number of seats to purchase. This is applicable only for a commitment plan.
- "maximumNumberOfSeats": 42, # Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
- },
- "creationTime": "A String", # Creation time of this subscription in milliseconds since Unix epoch.
- "status": "A String", # Status of the subscription.
- "plan": { # Plan details of the subscription
- "planName": "A String", # The plan name of this subscription's plan.
- "commitmentInterval": { # Interval of the commitment if it is a commitment plan.
- "endTime": "A String", # End time of the commitment interval in milliseconds since Unix epoch.
- "startTime": "A String", # Start time of the commitment interval in milliseconds since Unix epoch.
- },
- "isCommitmentPlan": True or False, # Whether the plan is a commitment plan or not.
- },
- "purchaseOrderId": "A String", # Purchase order id for your order tracking purposes.
- "subscriptionId": "A String", # The id of the subscription.
- "customerId": "A String", # The id of the customer to whom the subscription belongs.
- }
-
Instance Methods
-
- products()
-
-Returns the products Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/shopping_v1.products.html b/docs/dyn/shopping_v1.products.html
deleted file mode 100644
index 3749199..0000000
--- a/docs/dyn/shopping_v1.products.html
+++ /dev/null
@@ -1,999 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(source, accountId, productIdType, productId, taxonomy=None, recommendations_useGcsConfig=None, recommendations_include=None, location=None, recommendations_enabled=None, categories_enabled=None, attributeFilter=None, categories_useGcsConfig=None, thumbnails=None, categories_include=None)
-Returns a single product
-
- list(source, facets_enabled=None, rankBy=None, taxonomy=None, promotions_enabled=None, channels=None, facets_discover=None, startIndex=None, availability=None, crowdBy=None, spelling_enabled=None, categoryRecommendations_category=None, extras_enabled=None, facets_includeEmptyBuckets=None, categoryRecommendations_enabled=None, extras_info=None, spelling_useGcsConfig=None, useCase=None, location=None, maxVariants=None, relatedQueries_enabled=None, facets_useGcsConfig=None, categoryRecommendations_useGcsConfig=None, boostBy=None, safe=None, maxResults=None, categories_enabled=None, attributeFilter=None, categoryRecommendations_include=None, categories_useGcsConfig=None, clickTracking=None, facets_include=None, thumbnails=None, language=None, currency=None, categories_include=None, redirects_enabled=None, restrictBy=None, q=None, redirects_useGcsConfig=None, country=None, relatedQueries_useGcsConfig=None, promotions_useGcsConfig=None)
-Returns a list of products and content modules
-Method Details
-
-
get(source, accountId, productIdType, productId, taxonomy=None, recommendations_useGcsConfig=None, recommendations_include=None, location=None, recommendations_enabled=None, categories_enabled=None, attributeFilter=None, categories_useGcsConfig=None, thumbnails=None, categories_include=None)
-
Returns a single product
-
-Args:
- source: string, Query source (required)
- accountId: integer, Merchant center account id (required)
- productIdType: string, Type of productId (required)
- productId: string, Id of product (required)
- taxonomy: string, Merchant taxonomy
- recommendations_useGcsConfig: boolean, This parameter is currently ignored
- recommendations_include: string, Recommendation specification
- location: string, Location used to determine tax and shipping
- 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
- thumbnails: string, Thumbnail specification
- categories_include: string, Category specification
-
-Returns:
- An object of the form:
-
- {
- "selfLink": "A String", # Self link of product when generated for a lookup request. Self link of product when generated for a search request.
- "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.
- {
- "content": "A String", # Content of thumbnail (only available for the first thumbnail of the top results if SAYT is enabled).
- "width": 42, # Width of thumbnail (omitted if not specified in the request).
- "link": "A String", # Link to thumbnail.
- "height": 42, # Height of thumbnail (omitted if not specified in the request).
- },
- ],
- },
- ],
- "inventories": [ # Inventories of product.
- {
- "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.
- "name": "A String", # Name of product author.
- "accountId": "A String", # Account id of product author.
- },
- "score": 3.14, # Google Internal
- "condition": "A String", # Condition of product (one of: new, refurbished, used).
- "providedId": "A String", # Merchant-provided id of product (available only with a cx source).
- "internal8": [ # Google Internal.
- "A String",
- ],
- "description": "A String", # Description of product.
- "gtins": [ # List of all the product's GTINs (in GTIN-14 format).
- "A String",
- ],
- "internal1": [ # Google Internal.
- "A String",
- ],
- "brand": "A String", # Brand of product.
- "internal3": "A String", # Google Internal.
- "internal4": [ # Google Internal.
- {
- "node": 42, # Google Internal.
- "confidence": 3.14, # Google Internal.
- },
- ],
- "internal6": "A String", # Google Internal.
- "internal7": True or False, # Google Internal.
- "link": "A String", # Link to product.
- "mpns": [ # List of all the product's MPNs.
- "A String",
- ],
- "attributes": [ # Attributes of product (available only with a cx source).
- {
- "type": "A String", # Type of product attribute (one of: text, bool, int, float, dateRange, url).
- "value": "", # Value of product attribute.
- "displayName": "A String", # Display Name of prodct attribute.
- "name": "A String", # Name of product attribute.
- "unit": "A String", # Unit of product attribute.
- },
- ],
- "totalMatchingVariants": 42, # The number of variant offers returned that matched the query.
- "variants": [ # A list of variant offers associated with this product.
- {
- "variant": # Object with schema name: ShoppingModelProductJsonV1 # The detailed offer data for a particular variant offer.
- },
- ],
- "modificationTime": "A String", # RFC 3339 formatted modification time and date of product.
- "categories": [ # Categories of product according to the selected taxonomy, omitted if no taxonomy is selected.
- "A String",
- ],
- "language": "A String", # BCP 47 language tag of language of product.
- "country": "A String", # ISO 3166 code of target country of product.
- "title": "A String", # Title of product.
- "creationTime": "A String", # RFC 3339 formatted creation time and date of product.
- "internal14": 3.14, # Google Internal.
- "internal12": "A String", # Google Internal.
- "internal13": 3.14, # Google Internal.
- "internal10": [ # Google Internal.
- "A String",
- ],
- "plusOne": "A String", # Code to add to the page to render the +1 content.
- "internal16": { # Google Internal. Attribute names are deliberately vague.
- "length": 42,
- "number": 42,
- "size": "A String",
- },
- "googleId": "A String", # Google id of product.
- "internal15": 3.14, # Google Internal.
- },
- "requestId": "A String", # Unique identifier for this request.
- "recommendations": [ # Recommendations for product.
- {
- "recommendationList": [ # List of recommendations.
- {
- "product": { # Recommended product.
- "queryMatched": True or False, # Whether this product matched the user query. Only set for the variant offers (if any) attached to a product offer.
- "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
- "images": [ # Images of product.
- {
- "status": "A String",
- "link": "A String", # Link to product image.
- "thumbnails": [ # Thumbnails of product image.
- {
- "content": "A String", # Content of thumbnail (only available for the first thumbnail of the top results if SAYT is enabled).
- "width": 42, # Width of thumbnail (omitted if not specified in the request).
- "link": "A String", # Link to thumbnail.
- "height": 42, # Height of thumbnail (omitted if not specified in the request).
- },
- ],
- },
- ],
- "inventories": [ # Inventories of product.
- {
- "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.
- "name": "A String", # Name of product author.
- "accountId": "A String", # Account id of product author.
- },
- "score": 3.14, # Google Internal
- "condition": "A String", # Condition of product (one of: new, refurbished, used).
- "providedId": "A String", # Merchant-provided id of product (available only with a cx source).
- "internal8": [ # Google Internal.
- "A String",
- ],
- "description": "A String", # Description of product.
- "gtins": [ # List of all the product's GTINs (in GTIN-14 format).
- "A String",
- ],
- "internal1": [ # Google Internal.
- "A String",
- ],
- "brand": "A String", # Brand of product.
- "internal3": "A String", # Google Internal.
- "internal4": [ # Google Internal.
- {
- "node": 42, # Google Internal.
- "confidence": 3.14, # Google Internal.
- },
- ],
- "internal6": "A String", # Google Internal.
- "internal7": True or False, # Google Internal.
- "link": "A String", # Link to product.
- "mpns": [ # List of all the product's MPNs.
- "A String",
- ],
- "attributes": [ # Attributes of product (available only with a cx source).
- {
- "type": "A String", # Type of product attribute (one of: text, bool, int, float, dateRange, url).
- "value": "", # Value of product attribute.
- "displayName": "A String", # Display Name of prodct attribute.
- "name": "A String", # Name of product attribute.
- "unit": "A String", # Unit of product attribute.
- },
- ],
- "totalMatchingVariants": 42, # The number of variant offers returned that matched the query.
- "variants": [ # A list of variant offers associated with this product.
- {
- "variant": # Object with schema name: ShoppingModelProductJsonV1 # The detailed offer data for a particular variant offer.
- },
- ],
- "modificationTime": "A String", # RFC 3339 formatted modification time and date of product.
- "categories": [ # Categories of product according to the selected taxonomy, omitted if no taxonomy is selected.
- "A String",
- ],
- "language": "A String", # BCP 47 language tag of language of product.
- "country": "A String", # ISO 3166 code of target country of product.
- "title": "A String", # Title of product.
- "creationTime": "A String", # RFC 3339 formatted creation time and date of product.
- "internal14": 3.14, # Google Internal.
- "internal12": "A String", # Google Internal.
- "internal13": 3.14, # Google Internal.
- "internal10": [ # Google Internal.
- "A String",
- ],
- "plusOne": "A String", # Code to add to the page to render the +1 content.
- "internal16": { # Google Internal. Attribute names are deliberately vague.
- "length": 42,
- "number": 42,
- "size": "A String",
- },
- "googleId": "A String", # Google id of product.
- "internal15": 3.14, # Google Internal.
- },
- },
- ],
- "type": "A String", # Type of recommendation list (for offer-based recommendations, one of: all, purchaseToPurchase, visitToVisit, visitToPurchase, relatedItems; for category-based recommendations, one of: all, categoryMostVisited, categoryBestSeller).
- },
- ],
- "debug": { # Google internal.
- "recommendedItemsRequest": "A String", # Google internal.
- "searchRequest": "A String", # Google internal.
- "rdcResponse": "A String", # Google internal.
- "facetsRequest": "A String", # Google internal.
- "searchResponse": "A String", # Google internal.
- "elapsedMillis": "A String", # Google internal.
- "recommendedItemsResponse": "A String", # Google internal.
- "facetsResponse": "A String", # Google internal.
- "backendTimes": [ # Google internal
- {
- "serverMillis": "A String", # Google internal
- "hostName": "A String", # Google internal
- "name": "A String", # Google internal
- "elapsedMillis": "A String", # Google internal
- },
- ],
- },
- "id": "A String", # Id of product.
- "categories": [ # List of categories for product.
- {
- "url": "A String", # URL of category.
- "shortName": "A String", # Short name of category.
- "parents": [ # Ids of the parents of the category.
- "A String",
- ],
- "id": "A String", # Id of category.
- },
- ],
- }
-
-
list(source, facets_enabled=None, rankBy=None, taxonomy=None, promotions_enabled=None, channels=None, facets_discover=None, startIndex=None, availability=None, crowdBy=None, spelling_enabled=None, categoryRecommendations_category=None, extras_enabled=None, facets_includeEmptyBuckets=None, categoryRecommendations_enabled=None, extras_info=None, spelling_useGcsConfig=None, useCase=None, location=None, maxVariants=None, relatedQueries_enabled=None, facets_useGcsConfig=None, categoryRecommendations_useGcsConfig=None, boostBy=None, safe=None, maxResults=None, categories_enabled=None, attributeFilter=None, categoryRecommendations_include=None, categories_useGcsConfig=None, clickTracking=None, facets_include=None, thumbnails=None, language=None, currency=None, categories_include=None, redirects_enabled=None, restrictBy=None, q=None, redirects_useGcsConfig=None, country=None, relatedQueries_useGcsConfig=None, promotions_useGcsConfig=None)
-
Returns a list of products and content modules
-
-Args:
- source: string, Query source (required)
- facets_enabled: boolean, Whether to return facet information
- rankBy: string, Ranking specification
- taxonomy: string, Taxonomy name
- promotions_enabled: boolean, Whether to return promotion information
- channels: string, Channels specification
- facets_discover: string, Facets to discover
- startIndex: integer, Index (1-based) of first product to return
- 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
- categoryRecommendations_category: string, Category for which to retrieve recommendations
- extras_enabled: boolean, Whether to return extra information.
- facets_includeEmptyBuckets: boolean, Return empty facet buckets.
- categoryRecommendations_enabled: boolean, Whether to return category recommendation information
- extras_info: string, What extra information to return.
- spelling_useGcsConfig: boolean, This parameter is currently ignored
- 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
- 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
- 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
- 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)
- currency: string, Currency restriction (ISO 4217)
- categories_include: string, Category specification
- redirects_enabled: boolean, Whether to return redirect information
- restrictBy: string, Restriction specification
- q: string, Search query
- redirects_useGcsConfig: boolean, Whether to return redirect information as configured in the GCS account
- country: string, Country restriction (ISO 3166)
- relatedQueries_useGcsConfig: boolean, This parameter is currently ignored
- promotions_useGcsConfig: boolean, Whether to return promotion information as configured in the GCS account
-
-Returns:
- An object of the form:
-
- {
- "redirects": [ # Redirects.
- "A String",
- ],
- "stores": [ # List of returned stores.
- {
- "storeCode": "A String", # Merchant-supplied store code.
- "name": "A String", # Name of merchant.
- "storeName": "A String", # Name of store.
- "storeId": "A String", # Id of store.
- "telephone": "A String", # Telephone number of store.
- "location": "A String", # Location of store.
- "address": "A String", # Address of store.
- },
- ],
- "relatedQueries": [ # Related queries.
- "A String",
- ],
- "startIndex": 42, # 1-based index of the first item in the search results.
- "categoryRecommendations": [ # Recommendations for category.
- {
- "recommendationList": [ # List of recommendations.
- {
- "product": { # Recommended product.
- "queryMatched": True or False, # Whether this product matched the user query. Only set for the variant offers (if any) attached to a product offer.
- "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
- "images": [ # Images of product.
- {
- "status": "A String",
- "link": "A String", # Link to product image.
- "thumbnails": [ # Thumbnails of product image.
- {
- "content": "A String", # Content of thumbnail (only available for the first thumbnail of the top results if SAYT is enabled).
- "width": 42, # Width of thumbnail (omitted if not specified in the request).
- "link": "A String", # Link to thumbnail.
- "height": 42, # Height of thumbnail (omitted if not specified in the request).
- },
- ],
- },
- ],
- "inventories": [ # Inventories of product.
- {
- "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.
- "name": "A String", # Name of product author.
- "accountId": "A String", # Account id of product author.
- },
- "score": 3.14, # Google Internal
- "condition": "A String", # Condition of product (one of: new, refurbished, used).
- "providedId": "A String", # Merchant-provided id of product (available only with a cx source).
- "internal8": [ # Google Internal.
- "A String",
- ],
- "description": "A String", # Description of product.
- "gtins": [ # List of all the product's GTINs (in GTIN-14 format).
- "A String",
- ],
- "internal1": [ # Google Internal.
- "A String",
- ],
- "brand": "A String", # Brand of product.
- "internal3": "A String", # Google Internal.
- "internal4": [ # Google Internal.
- {
- "node": 42, # Google Internal.
- "confidence": 3.14, # Google Internal.
- },
- ],
- "internal6": "A String", # Google Internal.
- "internal7": True or False, # Google Internal.
- "link": "A String", # Link to product.
- "mpns": [ # List of all the product's MPNs.
- "A String",
- ],
- "attributes": [ # Attributes of product (available only with a cx source).
- {
- "type": "A String", # Type of product attribute (one of: text, bool, int, float, dateRange, url).
- "value": "", # Value of product attribute.
- "displayName": "A String", # Display Name of prodct attribute.
- "name": "A String", # Name of product attribute.
- "unit": "A String", # Unit of product attribute.
- },
- ],
- "totalMatchingVariants": 42, # The number of variant offers returned that matched the query.
- "variants": [ # A list of variant offers associated with this product.
- {
- "variant": # Object with schema name: ShoppingModelProductJsonV1 # The detailed offer data for a particular variant offer.
- },
- ],
- "modificationTime": "A String", # RFC 3339 formatted modification time and date of product.
- "categories": [ # Categories of product according to the selected taxonomy, omitted if no taxonomy is selected.
- "A String",
- ],
- "language": "A String", # BCP 47 language tag of language of product.
- "country": "A String", # ISO 3166 code of target country of product.
- "title": "A String", # Title of product.
- "creationTime": "A String", # RFC 3339 formatted creation time and date of product.
- "internal14": 3.14, # Google Internal.
- "internal12": "A String", # Google Internal.
- "internal13": 3.14, # Google Internal.
- "internal10": [ # Google Internal.
- "A String",
- ],
- "plusOne": "A String", # Code to add to the page to render the +1 content.
- "internal16": { # Google Internal. Attribute names are deliberately vague.
- "length": 42,
- "number": 42,
- "size": "A String",
- },
- "googleId": "A String", # Google id of product.
- "internal15": 3.14, # Google Internal.
- },
- },
- ],
- "type": "A String", # Type of recommendation list (for offer-based recommendations, one of: all, purchaseToPurchase, visitToVisit, visitToPurchase, relatedItems; for category-based recommendations, one of: all, categoryMostVisited, categoryBestSeller).
- },
- ],
- "id": "tag:google.com,2010:shopping/products", # Id of feed.
- "itemsPerPage": 42, # Number of items per page of results.
- "nextLink": "A String", # Next link of feed.
- "etag": "A String", # Etag of feed.
- "requestId": "A String", # Unique identifier for this request.
- "currentItemCount": 42, # Current item count.
- "previousLink": "A String", # Previous link of feed.
- "debug": { # Google internal.
- "recommendedItemsRequest": "A String", # Google internal.
- "searchRequest": "A String", # Google internal.
- "rdcResponse": "A String", # Google internal.
- "facetsRequest": "A String", # Google internal.
- "searchResponse": "A String", # Google internal.
- "elapsedMillis": "A String", # Google internal.
- "recommendedItemsResponse": "A String", # Google internal.
- "facetsResponse": "A String", # Google internal.
- "backendTimes": [ # Google internal
- {
- "serverMillis": "A String", # Google internal
- "hostName": "A String", # Google internal
- "name": "A String", # Google internal
- "elapsedMillis": "A String", # Google internal
- },
- ],
- },
- "spelling": { # Spelling.
- "suggestion": "A String", # Suggestion for spelling.
- },
- "categories": [ # List of categories.
- {
- "url": "A String", # URL of category.
- "shortName": "A String", # Short name of category.
- "parents": [ # Ids of the parents of the category.
- "A String",
- ],
- "id": "A String", # Id of category.
- },
- ],
- "promotions": [ # List of promotions.
- {
- "product": { # Product of promotion (omitted if type is not product).
- "queryMatched": True or False, # Whether this product matched the user query. Only set for the variant offers (if any) attached to a product offer.
- "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
- "images": [ # Images of product.
- {
- "status": "A String",
- "link": "A String", # Link to product image.
- "thumbnails": [ # Thumbnails of product image.
- {
- "content": "A String", # Content of thumbnail (only available for the first thumbnail of the top results if SAYT is enabled).
- "width": 42, # Width of thumbnail (omitted if not specified in the request).
- "link": "A String", # Link to thumbnail.
- "height": 42, # Height of thumbnail (omitted if not specified in the request).
- },
- ],
- },
- ],
- "inventories": [ # Inventories of product.
- {
- "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.
- "name": "A String", # Name of product author.
- "accountId": "A String", # Account id of product author.
- },
- "score": 3.14, # Google Internal
- "condition": "A String", # Condition of product (one of: new, refurbished, used).
- "providedId": "A String", # Merchant-provided id of product (available only with a cx source).
- "internal8": [ # Google Internal.
- "A String",
- ],
- "description": "A String", # Description of product.
- "gtins": [ # List of all the product's GTINs (in GTIN-14 format).
- "A String",
- ],
- "internal1": [ # Google Internal.
- "A String",
- ],
- "brand": "A String", # Brand of product.
- "internal3": "A String", # Google Internal.
- "internal4": [ # Google Internal.
- {
- "node": 42, # Google Internal.
- "confidence": 3.14, # Google Internal.
- },
- ],
- "internal6": "A String", # Google Internal.
- "internal7": True or False, # Google Internal.
- "link": "A String", # Link to product.
- "mpns": [ # List of all the product's MPNs.
- "A String",
- ],
- "attributes": [ # Attributes of product (available only with a cx source).
- {
- "type": "A String", # Type of product attribute (one of: text, bool, int, float, dateRange, url).
- "value": "", # Value of product attribute.
- "displayName": "A String", # Display Name of prodct attribute.
- "name": "A String", # Name of product attribute.
- "unit": "A String", # Unit of product attribute.
- },
- ],
- "totalMatchingVariants": 42, # The number of variant offers returned that matched the query.
- "variants": [ # A list of variant offers associated with this product.
- {
- "variant": # Object with schema name: ShoppingModelProductJsonV1 # The detailed offer data for a particular variant offer.
- },
- ],
- "modificationTime": "A String", # RFC 3339 formatted modification time and date of product.
- "categories": [ # Categories of product according to the selected taxonomy, omitted if no taxonomy is selected.
- "A String",
- ],
- "language": "A String", # BCP 47 language tag of language of product.
- "country": "A String", # ISO 3166 code of target country of product.
- "title": "A String", # Title of product.
- "creationTime": "A String", # RFC 3339 formatted creation time and date of product.
- "internal14": 3.14, # Google Internal.
- "internal12": "A String", # Google Internal.
- "internal13": 3.14, # Google Internal.
- "internal10": [ # Google Internal.
- "A String",
- ],
- "plusOne": "A String", # Code to add to the page to render the +1 content.
- "internal16": { # Google Internal. Attribute names are deliberately vague.
- "length": 42,
- "number": 42,
- "size": "A String",
- },
- "googleId": "A String", # Google id of product.
- "internal15": 3.14, # Google Internal.
- },
- "description": "A String", # Description of promotion (omitted if type is not standard).
- "imageLink": "A String", # Link to promotion image (omitted if type is not standard).
- "destLink": "A String", # Link to promotion (omitted if type is not standard).
- "customHtml": "A String", # Custom HTML of promotion (omitted if type is not custom).
- "customFields": [ # List of custom fields of promotion.
- {
- "name": "A String", # Name of field.
- "value": "A String", # Value of field.
- },
- ],
- "type": "A String", # Type of promotion (one of: standard, product, custom).
- "name": "A String", # Name of promotion (omitted if type is not standard).
- },
- ],
- "kind": "shopping#products", # The fixed string "shopping#products". The kind of feed returned.
- "items": [ # List of returned products.
- {
- "selfLink": "A String", # Self link of product when generated for a lookup request. Self link of product when generated for a search request.
- "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.
- {
- "content": "A String", # Content of thumbnail (only available for the first thumbnail of the top results if SAYT is enabled).
- "width": 42, # Width of thumbnail (omitted if not specified in the request).
- "link": "A String", # Link to thumbnail.
- "height": 42, # Height of thumbnail (omitted if not specified in the request).
- },
- ],
- },
- ],
- "inventories": [ # Inventories of product.
- {
- "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.
- "name": "A String", # Name of product author.
- "accountId": "A String", # Account id of product author.
- },
- "score": 3.14, # Google Internal
- "condition": "A String", # Condition of product (one of: new, refurbished, used).
- "providedId": "A String", # Merchant-provided id of product (available only with a cx source).
- "internal8": [ # Google Internal.
- "A String",
- ],
- "description": "A String", # Description of product.
- "gtins": [ # List of all the product's GTINs (in GTIN-14 format).
- "A String",
- ],
- "internal1": [ # Google Internal.
- "A String",
- ],
- "brand": "A String", # Brand of product.
- "internal3": "A String", # Google Internal.
- "internal4": [ # Google Internal.
- {
- "node": 42, # Google Internal.
- "confidence": 3.14, # Google Internal.
- },
- ],
- "internal6": "A String", # Google Internal.
- "internal7": True or False, # Google Internal.
- "link": "A String", # Link to product.
- "mpns": [ # List of all the product's MPNs.
- "A String",
- ],
- "attributes": [ # Attributes of product (available only with a cx source).
- {
- "type": "A String", # Type of product attribute (one of: text, bool, int, float, dateRange, url).
- "value": "", # Value of product attribute.
- "displayName": "A String", # Display Name of prodct attribute.
- "name": "A String", # Name of product attribute.
- "unit": "A String", # Unit of product attribute.
- },
- ],
- "totalMatchingVariants": 42, # The number of variant offers returned that matched the query.
- "variants": [ # A list of variant offers associated with this product.
- {
- "variant": # Object with schema name: ShoppingModelProductJsonV1 # The detailed offer data for a particular variant offer.
- },
- ],
- "modificationTime": "A String", # RFC 3339 formatted modification time and date of product.
- "categories": [ # Categories of product according to the selected taxonomy, omitted if no taxonomy is selected.
- "A String",
- ],
- "language": "A String", # BCP 47 language tag of language of product.
- "country": "A String", # ISO 3166 code of target country of product.
- "title": "A String", # Title of product.
- "creationTime": "A String", # RFC 3339 formatted creation time and date of product.
- "internal14": 3.14, # Google Internal.
- "internal12": "A String", # Google Internal.
- "internal13": 3.14, # Google Internal.
- "internal10": [ # Google Internal.
- "A String",
- ],
- "plusOne": "A String", # Code to add to the page to render the +1 content.
- "internal16": { # Google Internal. Attribute names are deliberately vague.
- "length": 42,
- "number": 42,
- "size": "A String",
- },
- "googleId": "A String", # Google id of product.
- "internal15": 3.14, # Google Internal.
- },
- "requestId": "A String", # Unique identifier for this request.
- "recommendations": [ # Recommendations for product.
- {
- "recommendationList": [ # List of recommendations.
- {
- "product": { # Recommended product.
- "queryMatched": True or False, # Whether this product matched the user query. Only set for the variant offers (if any) attached to a product offer.
- "gtin": "A String", # The first GTIN of the product. Deprecated in favor of "gtins".
- "images": [ # Images of product.
- {
- "status": "A String",
- "link": "A String", # Link to product image.
- "thumbnails": [ # Thumbnails of product image.
- {
- "content": "A String", # Content of thumbnail (only available for the first thumbnail of the top results if SAYT is enabled).
- "width": 42, # Width of thumbnail (omitted if not specified in the request).
- "link": "A String", # Link to thumbnail.
- "height": 42, # Height of thumbnail (omitted if not specified in the request).
- },
- ],
- },
- ],
- "inventories": [ # Inventories of product.
- {
- "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.
- "name": "A String", # Name of product author.
- "accountId": "A String", # Account id of product author.
- },
- "score": 3.14, # Google Internal
- "condition": "A String", # Condition of product (one of: new, refurbished, used).
- "providedId": "A String", # Merchant-provided id of product (available only with a cx source).
- "internal8": [ # Google Internal.
- "A String",
- ],
- "description": "A String", # Description of product.
- "gtins": [ # List of all the product's GTINs (in GTIN-14 format).
- "A String",
- ],
- "internal1": [ # Google Internal.
- "A String",
- ],
- "brand": "A String", # Brand of product.
- "internal3": "A String", # Google Internal.
- "internal4": [ # Google Internal.
- {
- "node": 42, # Google Internal.
- "confidence": 3.14, # Google Internal.
- },
- ],
- "internal6": "A String", # Google Internal.
- "internal7": True or False, # Google Internal.
- "link": "A String", # Link to product.
- "mpns": [ # List of all the product's MPNs.
- "A String",
- ],
- "attributes": [ # Attributes of product (available only with a cx source).
- {
- "type": "A String", # Type of product attribute (one of: text, bool, int, float, dateRange, url).
- "value": "", # Value of product attribute.
- "displayName": "A String", # Display Name of prodct attribute.
- "name": "A String", # Name of product attribute.
- "unit": "A String", # Unit of product attribute.
- },
- ],
- "totalMatchingVariants": 42, # The number of variant offers returned that matched the query.
- "variants": [ # A list of variant offers associated with this product.
- {
- "variant": # Object with schema name: ShoppingModelProductJsonV1 # The detailed offer data for a particular variant offer.
- },
- ],
- "modificationTime": "A String", # RFC 3339 formatted modification time and date of product.
- "categories": [ # Categories of product according to the selected taxonomy, omitted if no taxonomy is selected.
- "A String",
- ],
- "language": "A String", # BCP 47 language tag of language of product.
- "country": "A String", # ISO 3166 code of target country of product.
- "title": "A String", # Title of product.
- "creationTime": "A String", # RFC 3339 formatted creation time and date of product.
- "internal14": 3.14, # Google Internal.
- "internal12": "A String", # Google Internal.
- "internal13": 3.14, # Google Internal.
- "internal10": [ # Google Internal.
- "A String",
- ],
- "plusOne": "A String", # Code to add to the page to render the +1 content.
- "internal16": { # Google Internal. Attribute names are deliberately vague.
- "length": 42,
- "number": 42,
- "size": "A String",
- },
- "googleId": "A String", # Google id of product.
- "internal15": 3.14, # Google Internal.
- },
- },
- ],
- "type": "A String", # Type of recommendation list (for offer-based recommendations, one of: all, purchaseToPurchase, visitToVisit, visitToPurchase, relatedItems; for category-based recommendations, one of: all, categoryMostVisited, categoryBestSeller).
- },
- ],
- "debug": { # Google internal.
- "recommendedItemsRequest": "A String", # Google internal.
- "searchRequest": "A String", # Google internal.
- "rdcResponse": "A String", # Google internal.
- "facetsRequest": "A String", # Google internal.
- "searchResponse": "A String", # Google internal.
- "elapsedMillis": "A String", # Google internal.
- "recommendedItemsResponse": "A String", # Google internal.
- "facetsResponse": "A String", # Google internal.
- "backendTimes": [ # Google internal
- {
- "serverMillis": "A String", # Google internal
- "hostName": "A String", # Google internal
- "name": "A String", # Google internal
- "elapsedMillis": "A String", # Google internal
- },
- ],
- },
- "id": "A String", # Id of product.
- "categories": [ # List of categories for product.
- {
- "url": "A String", # URL of category.
- "shortName": "A String", # Short name of category.
- "parents": [ # Ids of the parents of the category.
- "A String",
- ],
- "id": "A String", # Id of category.
- },
- ],
- },
- ],
- "facets": [ # List of facets.
- {
- "count": 42, # Number of products matching the query that have a value for the facet's property or attribute.
- "displayName": "A String", # Display name of facet.
- "name": "A String", # Name of the facet's attribute (omitted for property facets).
- "buckets": [ # List of Buckets within facet.
- {
- "count": 42, # Number of products matching the query that have a value for the facet's property or attribute that matches the bucket.
- "minExclusive": True or False, # Whether the lower bound of the bucket is exclusive (omitted for value buckets or if the range has no lower bound).
- "min": "", # Lower bound of the bucket (omitted for value buckets or if the range has no lower bound).
- "max": "", # Upper bound of the bucket (omitted for value buckets or if the range has no upper bound).
- "value": "", # Value of the bucket (omitted for range buckets).
- "maxExclusive": True or False, # Whether the upper bound of the bucket is exclusive (omitted for value buckets or if the range has no upper bound).
- },
- ],
- "property": "A String", # Property of facet (omitted for attribute facets).
- "type": "A String", # Type of facet's attribute (omitted for property facets, one of: text, bool, int, float).
- "unit": "A String", # Unit of the facet's property or attribute (omitted if the facet's property or attribute has no unit).
- },
- ],
- "extras": { # List of extras.
- "facetRules": [
- {
- "name": "A String",
- },
- ],
- "rankingRules": [ # Names of boost (ranking) rules applicable to this search.
- {
- "name": "A String",
- },
- ],
- },
- "totalItems": 42, # Total number of search results.
- "selfLink": "A String", # Self link of feed.
- }
-
Instance Methods
-
- webResource()
-
-Returns the webResource Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/siteVerification_v1.webResource.html b/docs/dyn/siteVerification_v1.webResource.html
deleted file mode 100644
index 7149825..0000000
--- a/docs/dyn/siteVerification_v1.webResource.html
+++ /dev/null
@@ -1,289 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(id)
-Relinquish ownership of a website or domain.
-
- get(id)
-Get the most current data for a website or domain.
-
- getToken(body)
-Get a verification token for placing on a website or domain.
-
- insert(verificationMethod, body)
-Attempt verification of a website or domain.
-
- list()
-Get the list of your verified websites and domains.
-
- patch(id, body)
-Modify the list of owners for your website or domain. This method supports patch semantics.
-
- update(id, body)
-Modify the list of owners for your website or domain.
-Method Details
-
-
delete(id)
-
Relinquish ownership of a website or domain.
-
-Args:
- id: string, The id of a verified site or domain. (required)
-
-
-
get(id)
-
Get the most current data for a website or domain.
-
-Args:
- id: string, The id of a verified site or domain. (required)
-
-Returns:
- An object of the form:
-
- {
- "owners": [ # The email addresses of all verified owners.
- "A String",
- ],
- "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
- "site": { # The address and type of a site that is verified or will be verified.
- "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
- "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
- },
- }
-
-
getToken(body)
-
Get a verification token for placing on a website or domain.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "verificationMethod": "A String", # The verification method that will be used to verify this site. For sites, 'FILE' or 'META' methods may be used. For domains, only 'DNS' may be used.
- "site": { # The site for which a verification token will be generated.
- "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
- "type": "A String", # The type of resource to be verified. Can be SITE or INET_DOMAIN (domain name).
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "token": "A String", # The verification token. The token must be placed appropriately in order for verification to succeed.
- "method": "A String", # The verification method to use in conjunction with this token. For FILE, the token should be placed in the top-level directory of the site, stored inside a file of the same name. For META, the token should be placed in the HEAD tag of the default page that is loaded for the site. For DNS, the token should be placed in a TXT record of the domain.
- }
-
-
insert(verificationMethod, body)
-
Attempt verification of a website or domain.
-
-Args:
- verificationMethod: string, The method to use for verifying a site or domain. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "owners": [ # The email addresses of all verified owners.
- "A String",
- ],
- "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
- "site": { # The address and type of a site that is verified or will be verified.
- "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
- "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "owners": [ # The email addresses of all verified owners.
- "A String",
- ],
- "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
- "site": { # The address and type of a site that is verified or will be verified.
- "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
- "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
- },
- }
-
-
list()
-
Get the list of your verified websites and domains.
-
-Args:
-
-Returns:
- An object of the form:
-
- {
- "items": [ # The list of sites that are owned by the authenticated user.
- {
- "owners": [ # The email addresses of all verified owners.
- "A String",
- ],
- "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
- "site": { # The address and type of a site that is verified or will be verified.
- "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
- "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
- },
- },
- ],
- }
-
-
patch(id, body)
-
Modify the list of owners for your website or domain. This method supports patch semantics.
-
-Args:
- id: string, The id of a verified site or domain. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "owners": [ # The email addresses of all verified owners.
- "A String",
- ],
- "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
- "site": { # The address and type of a site that is verified or will be verified.
- "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
- "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "owners": [ # The email addresses of all verified owners.
- "A String",
- ],
- "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
- "site": { # The address and type of a site that is verified or will be verified.
- "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
- "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
- },
- }
-
-
update(id, body)
-
Modify the list of owners for your website or domain.
-
-Args:
- id: string, The id of a verified site or domain. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "owners": [ # The email addresses of all verified owners.
- "A String",
- ],
- "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
- "site": { # The address and type of a site that is verified or will be verified.
- "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
- "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
- },
- }
-
-
-Returns:
- An object of the form:
-
- {
- "owners": [ # The email addresses of all verified owners.
- "A String",
- ],
- "id": "A String", # The string used to identify this site. This value should be used in the "id" portion of the REST URL for the Get, Update, and Delete operations.
- "site": { # The address and type of a site that is verified or will be verified.
- "identifier": "A String", # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
- "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).
- },
- }
-
Instance Methods
-
- get(project, instance, backupConfiguration, dueTime)
-Retrieves a resource containing information about a backup run.
-
- list(project, instance, backupConfiguration, maxResults=None, pageToken=None)
-Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the enqueued time.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, instance, backupConfiguration, dueTime)
-
Retrieves a resource containing information about a backup run.
-
-Args:
- project: string, Project ID of the project that contains the instance. You can find this on the project summary page of the Google APIs Console. (required)
- instance: string, Database instance ID. This does not include the project ID. (required)
- backupConfiguration: string, Identifier for the backup configuration. This gets generated automatically when a backup configuration is created. (required)
- dueTime: string, The time when this run is due to start in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. (required)
-
-Returns:
- An object of the form:
-
- { # A database instance backup run resource.
- "status": "A String", # The status of this run.
- "kind": "sql#backupRun", # This is always sql#backupRun.
- "backupConfiguration": "A String", # Backup Configuration identifier.
- "instance": "A String", # Name of the database instance.
- "startTime": "A String", # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
- "kind": "sql#operationError", # This is always sql#operationError.
- "code": "A String", # Identifies the specific error that occurred.
- },
- "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "dueTime": "A String", # The due time of this run in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- }
-
-
list(project, instance, backupConfiguration, maxResults=None, pageToken=None)
-
Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the enqueued time.
-
-Args:
- project: string, Project ID of the project that contains the instance. You can find this on the project summary page of the Google APIs Console. (required)
- instance: string, Database instance ID. This does not include the project ID. (required)
- backupConfiguration: string, Identifier for the backup configuration. This gets generated automatically when a backup configuration is created. (required)
- maxResults: integer, Maximum number of backup runs per response.
- pageToken: string, A previously-returned page token representing part of the larger set of results to view.
-
-Returns:
- An object of the form:
-
- { # Backup run list results.
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "items": [ # A list of backup runs in reverse chronological order of the enqueued time.
- { # A database instance backup run resource.
- "status": "A String", # The status of this run.
- "kind": "sql#backupRun", # This is always sql#backupRun.
- "backupConfiguration": "A String", # Backup Configuration identifier.
- "instance": "A String", # Name of the database instance.
- "startTime": "A String", # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
- "kind": "sql#operationError", # This is always sql#operationError.
- "code": "A String", # Identifies the specific error that occurred.
- },
- "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "dueTime": "A String", # The due time of this run in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- },
- ],
- "kind": "sql#backupRunsList", # This is always sql#backupRunsList.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- backupRuns()
-
-Returns the backupRuns Resource.
-
-
- instances()
-
-Returns the instances Resource.
-
-
- operations()
-
-Returns the operations Resource.
-
-
- tiers()
-
-Returns the tiers Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/sqladmin_v1beta1.instances.html b/docs/dyn/sqladmin_v1beta1.instances.html
deleted file mode 100644
index f99ea80..0000000
--- a/docs/dyn/sqladmin_v1beta1.instances.html
+++ /dev/null
@@ -1,521 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(project, instance)
-Deletes a database instance.
-
- export(project, instance, body)
-Exports data from a database instance to a Google Cloud Storage bucket as a MySQL dump file.
-
- get(project, instance)
-Retrieves a resource containing information about a database instance.
-
- import_(project, instance, body)
-Imports data into a database instance from a MySQL dump file in Google Cloud Storage.
-
- insert(project, body)
-Creates a new database instance.
-
- list(project, pageToken=None, maxResults=None)
-Lists instances under a given project in the alphabetical order of the instance name.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(project, instance, body)
-Updates settings of a database instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.. This method supports patch semantics.
-
- restart(project, instance)
-Restarts a database instance.
-
- restoreBackup(project, instance, backupConfiguration, dueTime)
-Restores a backup of a database instance.
-
- update(project, instance, body)
-Updates settings of a database instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.
-Method Details
-
-
delete(project, instance)
-
Deletes a database instance.
-
-Args:
- project: string, Project ID of the project that contains the instance to be deleted. You can find this on the project summary page of the Google APIs Console. (required)
- instance: string, Database instance ID. This does not include the project ID. (required)
-
-Returns:
- An object of the form:
-
- { # Database instance delete response.
- "kind": "sql#instancesDelete", # This is always sql#instancesDelete.
- "operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
- }
-
-
export(project, instance, body)
-
Exports data from a database instance to a Google Cloud Storage bucket as a MySQL dump file.
-
-Args:
- project: string, Project ID of the project that contains the instance to be exported. You can find this on the project summary page of the Google APIs Console. (required)
- instance: string, Database instance ID. This does not include the project ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Database instance export request.
- "exportContext": { # Database instance export context. # Contains details about the export operation.
- "table": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
- "A String",
- ],
- "kind": "sql#exportContext", # This is always sql#exportContext.
- "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored, or where it was already stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If the filename ends with .gz, the contents are compressed.
- "database": [ # Databases (for example, guestbook) from which the export is made. If unspecified, all databases are exported.
- "A String",
- ],
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Database instance export response.
- "kind": "sql#instancesExport", # This is always sql#instancesExport.
- "operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
- }
-
-
get(project, instance)
-
Retrieves a resource containing information about a database instance.
-
-Args:
- project: string, Project ID of the project that contains the instance. You can find this on the project summary page of the Google APIs Console. (required)
- instance: string, Database instance ID. This does not include the project ID. (required)
-
-Returns:
- An object of the form:
-
- { # A database instance resource.
- "project": "A String", # The project ID of the project containing the database instance. The Google apps domain is prefixed if applicable. You can find this on the project summary page of the Google APIs Console.
- "kind": "sql#instance", # This is always sql#instance.
- "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
- "settings": { # Database instance settings. # The user settings.
- "kind": "sql#settings", # This is always sql#settings.
- "authorizedGaeApplications": [ # The AppEngine app ids that can access this instance.
- "A String",
- ],
- "activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
- # ALWAYS: The instance should always be active.
- # NEVER: The instance should never be activated.
- # ON_DEMAND: The instance is activated upon receiving requests.
- "backupConfiguration": [ # The daily backup configuration for the instance.
- { # Database instance backup configuration.
- "kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
- "enabled": True or False, # Whether this configuration is enabled.
- "id": "A String", # Identifier for this configuration. This gets generated automatically when a backup configuration is created.
- "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
- },
- ],
- "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
- "replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
- "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
- },
- "region": "A String", # The geographical region. Can be us-east1 or europe-west1. Defaults to us-east1. The region can not be changed after instance creation.
- "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
- "instance": "A String", # Name of the database instance. This does not include the project ID.
- "state": "A String", # The current serving state of the database instance. This can be one of the following.
- # RUNNABLE: The instance is running, or is ready to run when accessed.
- # SUSPENDED: The instance is not available, for example due to problems with billing.
- # PENDING_CREATE: The instance is being created.
- # MAINTENANCE: The instance is down for maintenance.
- # UNKNOWN_STATE: The state of the instance is unknown.
- "etag": "A String", # Etag for this resource - a version number for the settings object in this resource. This field has no effect when passed as a request parameter. Instead, the contents of this field should be passed in an 'If-Match' http header for use in optimistic locking.
- "databaseVersion": "A String", # The database engine type and version, for example MYSQL_5_5 for MySQL 5.5.
- }
-
-
import_(project, instance, body)
-
Imports data into a database instance from a MySQL dump file in Google Cloud Storage.
-
-Args:
- project: string, Project ID of the project that contains the instance. You can find this on the project summary page of the Google APIs Console. (required)
- instance: string, Database instance ID. This does not include the project ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Database instance import request.
- "importContext": { # Database instance import context. # Contains details about the import operation.
- "kind": "sql#importContext", # This is always sql#importContext.
- "uri": [ # A path to the MySQL dump file in Google Cloud Storage from which the import is made. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported.
- "A String",
- ],
- "database": "A String", # The database (for example, guestbook) to which the import is made. If not set, it is assumed that the database is specified in the file to be imported.
- },
- }
-
-
-Returns:
- An object of the form:
-
- { # Database instance import response.
- "kind": "sql#instancesImport", # This is always sql#instancesImport.
- "operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
- }
-
-
insert(project, body)
-
Creates a new database instance.
-
-Args:
- project: string, Project ID of the project to which the newly created database instances should belong. You can find this on the project summary page of the Google APIs Console. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A database instance resource.
- "project": "A String", # The project ID of the project containing the database instance. The Google apps domain is prefixed if applicable. You can find this on the project summary page of the Google APIs Console.
- "kind": "sql#instance", # This is always sql#instance.
- "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
- "settings": { # Database instance settings. # The user settings.
- "kind": "sql#settings", # This is always sql#settings.
- "authorizedGaeApplications": [ # The AppEngine app ids that can access this instance.
- "A String",
- ],
- "activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
- # ALWAYS: The instance should always be active.
- # NEVER: The instance should never be activated.
- # ON_DEMAND: The instance is activated upon receiving requests.
- "backupConfiguration": [ # The daily backup configuration for the instance.
- { # Database instance backup configuration.
- "kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
- "enabled": True or False, # Whether this configuration is enabled.
- "id": "A String", # Identifier for this configuration. This gets generated automatically when a backup configuration is created.
- "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
- },
- ],
- "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
- "replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
- "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
- },
- "region": "A String", # The geographical region. Can be us-east1 or europe-west1. Defaults to us-east1. The region can not be changed after instance creation.
- "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
- "instance": "A String", # Name of the database instance. This does not include the project ID.
- "state": "A String", # The current serving state of the database instance. This can be one of the following.
- # RUNNABLE: The instance is running, or is ready to run when accessed.
- # SUSPENDED: The instance is not available, for example due to problems with billing.
- # PENDING_CREATE: The instance is being created.
- # MAINTENANCE: The instance is down for maintenance.
- # UNKNOWN_STATE: The state of the instance is unknown.
- "etag": "A String", # Etag for this resource - a version number for the settings object in this resource. This field has no effect when passed as a request parameter. Instead, the contents of this field should be passed in an 'If-Match' http header for use in optimistic locking.
- "databaseVersion": "A String", # The database engine type and version, for example MYSQL_5_5 for MySQL 5.5.
- }
-
-
-Returns:
- An object of the form:
-
- { # Database instance insert response.
- "kind": "sql#instancesInsert", # This is always sql#instancesInsert.
- "operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
- }
-
-
list(project, pageToken=None, maxResults=None)
-
Lists instances under a given project in the alphabetical order of the instance name.
-
-Args:
- project: string, Project ID of the project for which to list database instances. You can find this on the project summary page of the Google APIs Console. (required)
- pageToken: string, A previously-returned page token representing part of the larger set of results to view.
- maxResults: integer, The maximum number of results to return per response.
-
-Returns:
- An object of the form:
-
- { # Database instances list response.
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "items": [ # List of database instance resources.
- { # A database instance resource.
- "project": "A String", # The project ID of the project containing the database instance. The Google apps domain is prefixed if applicable. You can find this on the project summary page of the Google APIs Console.
- "kind": "sql#instance", # This is always sql#instance.
- "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
- "settings": { # Database instance settings. # The user settings.
- "kind": "sql#settings", # This is always sql#settings.
- "authorizedGaeApplications": [ # The AppEngine app ids that can access this instance.
- "A String",
- ],
- "activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
- # ALWAYS: The instance should always be active.
- # NEVER: The instance should never be activated.
- # ON_DEMAND: The instance is activated upon receiving requests.
- "backupConfiguration": [ # The daily backup configuration for the instance.
- { # Database instance backup configuration.
- "kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
- "enabled": True or False, # Whether this configuration is enabled.
- "id": "A String", # Identifier for this configuration. This gets generated automatically when a backup configuration is created.
- "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
- },
- ],
- "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
- "replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
- "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
- },
- "region": "A String", # The geographical region. Can be us-east1 or europe-west1. Defaults to us-east1. The region can not be changed after instance creation.
- "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
- "instance": "A String", # Name of the database instance. This does not include the project ID.
- "state": "A String", # The current serving state of the database instance. This can be one of the following.
- # RUNNABLE: The instance is running, or is ready to run when accessed.
- # SUSPENDED: The instance is not available, for example due to problems with billing.
- # PENDING_CREATE: The instance is being created.
- # MAINTENANCE: The instance is down for maintenance.
- # UNKNOWN_STATE: The state of the instance is unknown.
- "etag": "A String", # Etag for this resource - a version number for the settings object in this resource. This field has no effect when passed as a request parameter. Instead, the contents of this field should be passed in an 'If-Match' http header for use in optimistic locking.
- "databaseVersion": "A String", # The database engine type and version, for example MYSQL_5_5 for MySQL 5.5.
- },
- ],
- "kind": "sql#instancesList", # This is always sql#instancesList.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(project, instance, body)
-
Updates settings of a database instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.. This method supports patch semantics.
-
-Args:
- project: string, Project ID of the project that contains the instance. You can find this on the project summary page of the Google APIs Console. (required)
- instance: string, Database instance ID. This does not include the project ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A database instance resource.
- "project": "A String", # The project ID of the project containing the database instance. The Google apps domain is prefixed if applicable. You can find this on the project summary page of the Google APIs Console.
- "kind": "sql#instance", # This is always sql#instance.
- "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
- "settings": { # Database instance settings. # The user settings.
- "kind": "sql#settings", # This is always sql#settings.
- "authorizedGaeApplications": [ # The AppEngine app ids that can access this instance.
- "A String",
- ],
- "activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
- # ALWAYS: The instance should always be active.
- # NEVER: The instance should never be activated.
- # ON_DEMAND: The instance is activated upon receiving requests.
- "backupConfiguration": [ # The daily backup configuration for the instance.
- { # Database instance backup configuration.
- "kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
- "enabled": True or False, # Whether this configuration is enabled.
- "id": "A String", # Identifier for this configuration. This gets generated automatically when a backup configuration is created.
- "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
- },
- ],
- "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
- "replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
- "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
- },
- "region": "A String", # The geographical region. Can be us-east1 or europe-west1. Defaults to us-east1. The region can not be changed after instance creation.
- "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
- "instance": "A String", # Name of the database instance. This does not include the project ID.
- "state": "A String", # The current serving state of the database instance. This can be one of the following.
- # RUNNABLE: The instance is running, or is ready to run when accessed.
- # SUSPENDED: The instance is not available, for example due to problems with billing.
- # PENDING_CREATE: The instance is being created.
- # MAINTENANCE: The instance is down for maintenance.
- # UNKNOWN_STATE: The state of the instance is unknown.
- "etag": "A String", # Etag for this resource - a version number for the settings object in this resource. This field has no effect when passed as a request parameter. Instead, the contents of this field should be passed in an 'If-Match' http header for use in optimistic locking.
- "databaseVersion": "A String", # The database engine type and version, for example MYSQL_5_5 for MySQL 5.5.
- }
-
-
-Returns:
- An object of the form:
-
- { # Database instance update response.
- "kind": "sql#instancesUpdate", # This is always sql#instancesUpdate.
- "operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve information about the operation.
- }
-
-
restart(project, instance)
-
Restarts a database instance.
-
-Args:
- project: string, Project ID of the project that contains the instance to be restarted. You can find this on the project summary page of the Google APIs Console. (required)
- instance: string, Database instance ID. This does not include the project ID. (required)
-
-Returns:
- An object of the form:
-
- { # Database instance restart response.
- "kind": "sql#instancesRestart", # This is always sql#instancesRestart.
- "operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
- }
-
-
restoreBackup(project, instance, backupConfiguration, dueTime)
-
Restores a backup of a database instance.
-
-Args:
- project: string, Project ID of the project that contains the instance. You can find this on the project summary page of the Google APIs Console. (required)
- instance: string, Database instance ID. This does not include the project ID. (required)
- backupConfiguration: string, The identifier of the backup configuration. This gets generated automatically when a backup configuration is created. (required)
- dueTime: string, The time when this run is due to start in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. (required)
-
-Returns:
- An object of the form:
-
- { # Database instance restore backup response.
- "kind": "sql#instancesRestoreBackup", # This is always sql#instancesRestoreBackup.
- "operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
- }
-
-
update(project, instance, body)
-
Updates settings of a database instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.
-
-Args:
- project: string, Project ID of the project that contains the instance. You can find this on the project summary page of the Google APIs Console. (required)
- instance: string, Database instance ID. This does not include the project ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A database instance resource.
- "project": "A String", # The project ID of the project containing the database instance. The Google apps domain is prefixed if applicable. You can find this on the project summary page of the Google APIs Console.
- "kind": "sql#instance", # This is always sql#instance.
- "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
- "settings": { # Database instance settings. # The user settings.
- "kind": "sql#settings", # This is always sql#settings.
- "authorizedGaeApplications": [ # The AppEngine app ids that can access this instance.
- "A String",
- ],
- "activationPolicy": "A String", # The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following.
- # ALWAYS: The instance should always be active.
- # NEVER: The instance should never be activated.
- # ON_DEMAND: The instance is activated upon receiving requests.
- "backupConfiguration": [ # The daily backup configuration for the instance.
- { # Database instance backup configuration.
- "kind": "sql#backupConfiguration", # This is always sql#backupConfiguration.
- "enabled": True or False, # Whether this configuration is enabled.
- "id": "A String", # Identifier for this configuration. This gets generated automatically when a backup configuration is created.
- "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
- },
- ],
- "pricingPlan": "A String", # The pricing plan for this instance. This can be either PER_USE or PACKAGE.
- "replicationType": "A String", # The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.
- "tier": "A String", # The tier of service for this instance, for example D1, D2. For more information, see pricing.
- },
- "region": "A String", # The geographical region. Can be us-east1 or europe-west1. Defaults to us-east1. The region can not be changed after instance creation.
- "currentDiskSize": "A String", # The current disk usage of the instance in bytes.
- "instance": "A String", # Name of the database instance. This does not include the project ID.
- "state": "A String", # The current serving state of the database instance. This can be one of the following.
- # RUNNABLE: The instance is running, or is ready to run when accessed.
- # SUSPENDED: The instance is not available, for example due to problems with billing.
- # PENDING_CREATE: The instance is being created.
- # MAINTENANCE: The instance is down for maintenance.
- # UNKNOWN_STATE: The state of the instance is unknown.
- "etag": "A String", # Etag for this resource - a version number for the settings object in this resource. This field has no effect when passed as a request parameter. Instead, the contents of this field should be passed in an 'If-Match' http header for use in optimistic locking.
- "databaseVersion": "A String", # The database engine type and version, for example MYSQL_5_5 for MySQL 5.5.
- }
-
-
-Returns:
- An object of the form:
-
- { # Database instance update response.
- "kind": "sql#instancesUpdate", # This is always sql#instancesUpdate.
- "operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve information about the operation.
- }
-
Instance Methods
-
- get(project, instance, operation)
-Retrieves an instance operation that has been performed on an instance.
-
- list(project, instance, maxResults=None, pageToken=None)
-Lists all instance operations that have been performed on the given database instance in the reverse chronological order of the start time.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
get(project, instance, operation)
-
Retrieves an instance operation that has been performed on an instance.
-
-Args:
- project: string, Project ID of the project that contains the instance. You can find this on the project summary page of the Google APIs Console. (required)
- instance: string, Database instance ID. This does not include the project ID. (required)
- operation: string, Instance operation ID. (required)
-
-Returns:
- An object of the form:
-
- { # An Operations resource contains information about database instance operations such as create, delete, and restart. Operations resources are created in response to operations that were initiated; you never create them directly.
- "importContext": { # Database instance import context. # The context for import operation, if applicable.
- "kind": "sql#importContext", # This is always sql#importContext.
- "uri": [ # A path to the MySQL dump file in Google Cloud Storage from which the import is made. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported.
- "A String",
- ],
- "database": "A String", # The database (for example, guestbook) to which the import is made. If not set, it is assumed that the database is specified in the file to be imported.
- },
- "kind": "sql#instanceOperation", # This is always sql#instanceOperation.
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "table": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
- "A String",
- ],
- "kind": "sql#exportContext", # This is always sql#exportContext.
- "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored, or where it was already stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If the filename ends with .gz, the contents are compressed.
- "database": [ # Databases (for example, guestbook) from which the export is made. If unspecified, all databases are exported.
- "A String",
- ],
- },
- "instance": "A String", # Name of the database instance.
- "state": "A String", # The state of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
- "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
- "error": [ # The error(s) encountered by this operation. Only set if the operation results in an error.
- { # Database instance operation error.
- "kind": "sql#operationError", # This is always sql#operationError.
- "code": "A String", # Identifies the specific error that occurred.
- },
- ],
- "operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "enqueuedTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "userEmailAddress": "A String", # The email address of the user who initiated this operation.
- }
-
-
list(project, instance, maxResults=None, pageToken=None)
-
Lists all instance operations that have been performed on the given database instance in the reverse chronological order of the start time.
-
-Args:
- project: string, Project ID of the project that contains the instance. You can find this on the project summary page of the Google APIs Console. (required)
- instance: string, Database instance ID. This does not include the project ID. (required)
- maxResults: integer, Maximum number of operations per response.
- pageToken: string, A previously-returned page token representing part of the larger set of results to view.
-
-Returns:
- An object of the form:
-
- { # Database instance list operations response.
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "items": [ # List of operation resources.
- { # An Operations resource contains information about database instance operations such as create, delete, and restart. Operations resources are created in response to operations that were initiated; you never create them directly.
- "importContext": { # Database instance import context. # The context for import operation, if applicable.
- "kind": "sql#importContext", # This is always sql#importContext.
- "uri": [ # A path to the MySQL dump file in Google Cloud Storage from which the import is made. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported.
- "A String",
- ],
- "database": "A String", # The database (for example, guestbook) to which the import is made. If not set, it is assumed that the database is specified in the file to be imported.
- },
- "kind": "sql#instanceOperation", # This is always sql#instanceOperation.
- "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "table": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
- "A String",
- ],
- "kind": "sql#exportContext", # This is always sql#exportContext.
- "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored, or where it was already stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If the filename ends with .gz, the contents are compressed.
- "database": [ # Databases (for example, guestbook) from which the export is made. If unspecified, all databases are exported.
- "A String",
- ],
- },
- "instance": "A String", # Name of the database instance.
- "state": "A String", # The state of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
- "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
- "error": [ # The error(s) encountered by this operation. Only set if the operation results in an error.
- { # Database instance operation error.
- "kind": "sql#operationError", # This is always sql#operationError.
- "code": "A String", # Identifies the specific error that occurred.
- },
- ],
- "operation": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
- "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "enqueuedTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
- "userEmailAddress": "A String", # The email address of the user who initiated this operation.
- },
- ],
- "kind": "sql#operationsList", # This is always sql#operationsList.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- list()
-Lists all available service tiers for Google Cloud SQL, for example D1, D2. For related information, see Pricing.
-Method Details
-
-
list()
-
Lists all available service tiers for Google Cloud SQL, for example D1, D2. For related information, see Pricing.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # Tiers list response.
- "items": [ # List of tiers.
- { # A Google Cloud SQL service tier resource.
- "DiskQuota": "A String", # The maximum disk size of this tier in bytes.
- "tier": "A String", # An identifier for the service tier, for example D1, D2 etc. For related information, see Pricing.
- "kind": "sql#tier", # This is always sql#tier.
- "RAM": "A String", # The maximum RAM usage of this tier in bytes.
- "region": [ # The applicable regions for this tier. Can be us-east1 and europe-west1.
- "A String",
- ],
- },
- ],
- "kind": "sql#tiersList", # This is always sql#tiersList.
- }
-
Instance Methods
-
- delete(bucket, entity)
-Deletes the ACL entry for the specified entity on the specified bucket.
-
- get(bucket, entity)
-Returns the ACL entry for the specified entity on the specified bucket.
-
- insert(bucket, body)
-Creates a new ACL entry on the specified bucket.
-
- list(bucket)
-Retrieves ACL entries on the specified bucket.
-
- patch(bucket, entity, body)
-Updates an ACL entry on the specified bucket. This method supports patch semantics.
-
- update(bucket, entity, body)
-Updates an ACL entry on the specified bucket.
-Method Details
-
-
delete(bucket, entity)
-
Deletes the ACL entry for the specified entity on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
-
-
-
get(bucket, entity)
-
Returns the ACL entry for the specified entity on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
insert(bucket, body)
-
Creates a new ACL entry on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
list(bucket)
-
Retrieves ACL entries on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
-
-Returns:
- An object of the form:
-
- { # An access-control list.
- "items": [ # The list of items.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "kind": "storage#bucketAccessControls", # The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls.
- }
-
-
patch(bucket, entity, body)
-
Updates an ACL entry on the specified bucket. This method supports patch semantics.
-
-Args:
- bucket: string, Name of a bucket. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
update(bucket, entity, body)
-
Updates an ACL entry on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
Instance Methods
-
- delete(bucket)
-Deletes an empty bucket.
-
- get(bucket, projection=None)
-Returns metadata for the specified bucket.
-
- insert(body, projection=None)
-Creates a new bucket.
-
- list(projectId, projection=None, pageToken=None, max_results=None)
-Retrieves a list of buckets for a given project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(bucket, body, projection=None)
-Updates a bucket. This method supports patch semantics.
-
- update(bucket, body, projection=None)
-Updates a bucket.
-Method Details
-
-
delete(bucket)
-
Deletes an empty bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
-
-
-
get(bucket, projection=None)
-
Returns metadata for the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- projection: string, Set of properties to return. Defaults to no_acl.
- Allowed values
- full - Include all properties.
- no_acl - Omit acl and defaultObjectAcl properties.
-
-Returns:
- An object of the form:
-
- { # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "projectId": "A String", # The project the bucket belongs to.
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "id": "A String", # The name of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- }
-
-
insert(body, projection=None)
-
Creates a new bucket.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "projectId": "A String", # The project the bucket belongs to.
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "id": "A String", # The name of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- }
-
- projection: string, Set of properties to return. Defaults to no_acl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
- Allowed values
- full - Include all properties.
- no_acl - Omit acl and defaultObjectAcl properties.
-
-Returns:
- An object of the form:
-
- { # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "projectId": "A String", # The project the bucket belongs to.
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "id": "A String", # The name of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- }
-
-
list(projectId, projection=None, pageToken=None, max_results=None)
-
Retrieves a list of buckets for a given project.
-
-Args:
- projectId: string, A valid API project identifier. (required)
- projection: string, Set of properties to return. Defaults to no_acl.
- Allowed values
- full - Include all properties.
- no_acl - Omit acl and defaultObjectAcl properties.
- pageToken: string, A previously-returned page token representing part of the larger set of results to view.
- max_results: integer, Maximum number of buckets to return.
-
-Returns:
- An object of the form:
-
- { # A list of buckets.
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "items": [ # The list of items.
- { # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "projectId": "A String", # The project the bucket belongs to.
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "id": "A String", # The name of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- },
- ],
- "kind": "storage#buckets", # The kind of item this is. For lists of buckets, this is always storage#buckets.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(bucket, body, projection=None)
-
Updates a bucket. This method supports patch semantics.
-
-Args:
- bucket: string, Name of a bucket. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "projectId": "A String", # The project the bucket belongs to.
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "id": "A String", # The name of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- }
-
- projection: string, Set of properties to return. Defaults to full.
- Allowed values
- full - Include all properties.
- no_acl - Omit acl and defaultObjectAcl properties.
-
-Returns:
- An object of the form:
-
- { # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "projectId": "A String", # The project the bucket belongs to.
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "id": "A String", # The name of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- }
-
-
update(bucket, body, projection=None)
-
Updates a bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "projectId": "A String", # The project the bucket belongs to.
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "id": "A String", # The name of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- }
-
- projection: string, Set of properties to return. Defaults to full.
- Allowed values
- full - Include all properties.
- no_acl - Omit acl and defaultObjectAcl properties.
-
-Returns:
- An object of the form:
-
- { # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "projectId": "A String", # The project the bucket belongs to.
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage in this location. Can be US or EU. Defaults to US.
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "id": "A String", # The name of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- }
-
Instance Methods
-
- bucketAccessControls()
-
-Returns the bucketAccessControls Resource.
-
-
- buckets()
-
-Returns the buckets Resource.
-
-
- objectAccessControls()
-
-Returns the objectAccessControls Resource.
-
-
- objects()
-
-Returns the objects Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/storage_v1beta1.objectAccessControls.html b/docs/dyn/storage_v1beta1.objectAccessControls.html
deleted file mode 100644
index 89e7624..0000000
--- a/docs/dyn/storage_v1beta1.objectAccessControls.html
+++ /dev/null
@@ -1,336 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(bucket, object, entity)
-Deletes the ACL entry for the specified entity on the specified object.
-
- get(bucket, object, entity)
-Returns the ACL entry for the specified entity on the specified object.
-
- insert(bucket, object, body)
-Creates a new ACL entry on the specified object.
-
- list(bucket, object)
-Retrieves ACL entries on the specified object.
-
- patch(bucket, object, entity, body)
-Updates an ACL entry on the specified object. This method supports patch semantics.
-
- update(bucket, object, entity, body)
-Updates an ACL entry on the specified object.
-Method Details
-
-
delete(bucket, object, entity)
-
Deletes the ACL entry for the specified entity on the specified object.
-
-Args:
- bucket: string, Name of a bucket. (required)
- object: string, Name of the object. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
-
-
-
get(bucket, object, entity)
-
Returns the ACL entry for the specified entity on the specified object.
-
-Args:
- bucket: string, Name of a bucket. (required)
- object: string, Name of the object. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
insert(bucket, object, body)
-
Creates a new ACL entry on the specified object.
-
-Args:
- bucket: string, Name of a bucket. (required)
- object: string, Name of the object. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
-}
-
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
list(bucket, object)
-
Retrieves ACL entries on the specified object.
-
-Args:
- bucket: string, Name of a bucket. (required)
- object: string, Name of the object. (required)
-
-Returns:
- An object of the form:
-
- { # An access-control list.
- "items": [ # The list of items.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.
- }
-
-
patch(bucket, object, entity, body)
-
Updates an ACL entry on the specified object. This method supports patch semantics.
-
-Args:
- bucket: string, Name of a bucket. (required)
- object: string, Name of the object. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
-}
-
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
update(bucket, object, entity, body)
-
Updates an ACL entry on the specified object.
-
-Args:
- bucket: string, Name of a bucket. (required)
- object: string, Name of the object. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
-}
-
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
Instance Methods
-
- delete(bucket, object)
-Deletes data blobs and associated metadata.
-
- get(bucket, object, projection=None)
-Retrieves objects or their associated metadata.
-
- get_media(bucket, object, projection=None)
-Retrieves objects or their associated metadata.
-
- insert(bucket, body=None, media_body=None, name=None, projection=None)
-Stores new data blobs and associated metadata.
-
- insert_media(bucket, body=None, media_body=None, name=None, projection=None)
-Stores new data blobs and associated metadata.
-
- list(bucket, projection=None, pageToken=None, delimiter=None, prefix=None, max_results=None)
-Retrieves a list of objects matching the criteria.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(bucket, object, body, projection=None)
-Updates a data blob's associated metadata. This method supports patch semantics.
-
- update(bucket, object, body, projection=None)
-Updates a data blob's associated metadata.
-
- update_media(bucket, object, body, projection=None)
-Updates a data blob's associated metadata.
-Method Details
-
-
delete(bucket, object)
-
Deletes data blobs and associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which the object resides. (required)
- object: string, Name of the object. (required)
-
-
-
get(bucket, object, projection=None)
-
Retrieves objects or their associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which the object resides. (required)
- object: string, Name of the object. (required)
- projection: string, Set of properties to return. Defaults to no_acl.
- Allowed values
- full - Include all properties.
- no_acl - Omit the acl property.
-
-Returns:
- An object of the form:
-
- { # An object.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "contentLanguage": "A String", # Content-Language of the object data.
- "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
- "contentType": "A String", # Content-Type of the object data.
- "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
- "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
- "length": "A String", # Content-Length of the data in bytes.
- "link": "A String", # Media download link.
- "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
- "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
- },
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "selfLink": "A String", # The link to this object.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- }
-
-
get_media(bucket, object, projection=None)
-
Retrieves objects or their associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which the object resides. (required)
- object: string, Name of the object. (required)
- projection: string, Set of properties to return. Defaults to no_acl.
- Allowed values
- full - Include all properties.
- no_acl - Omit the acl property.
-
-Returns:
- The media object as a string.
-
-
-
-
insert(bucket, body=None, media_body=None, name=None, projection=None)
-
Stores new data blobs and associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # An object.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "contentLanguage": "A String", # Content-Language of the object data.
- "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
- "contentType": "A String", # Content-Type of the object data.
- "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
- "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
- "length": "A String", # Content-Length of the data in bytes.
- "link": "A String", # Media download link.
- "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
- "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
- },
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "selfLink": "A String", # The link to this object.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- }
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- name: string, Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.
- projection: string, Set of properties to return. Defaults to no_acl, unless the object resource specifies the acl property, when it defaults to full.
- Allowed values
- full - Include all properties.
- no_acl - Omit the acl property.
-
-Returns:
- An object of the form:
-
- { # An object.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "contentLanguage": "A String", # Content-Language of the object data.
- "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
- "contentType": "A String", # Content-Type of the object data.
- "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
- "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
- "length": "A String", # Content-Length of the data in bytes.
- "link": "A String", # Media download link.
- "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
- "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
- },
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "selfLink": "A String", # The link to this object.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- }
-
-
insert_media(bucket, body=None, media_body=None, name=None, projection=None)
-
Stores new data blobs and associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # An object.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "contentLanguage": "A String", # Content-Language of the object data.
- "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
- "contentType": "A String", # Content-Type of the object data.
- "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
- "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
- "length": "A String", # Content-Length of the data in bytes.
- "link": "A String", # Media download link.
- "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
- "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
- },
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "selfLink": "A String", # The link to this object.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- }
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- name: string, Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.
- projection: string, Set of properties to return. Defaults to no_acl, unless the object resource specifies the acl property, when it defaults to full.
- Allowed values
- full - Include all properties.
- no_acl - Omit the acl property.
-
-Returns:
- The media object as a string.
-
-
-
-
list(bucket, projection=None, pageToken=None, delimiter=None, prefix=None, max_results=None)
-
Retrieves a list of objects matching the criteria.
-
-Args:
- bucket: string, Name of the bucket in which to look for objects. (required)
- projection: string, Set of properties to return. Defaults to no_acl.
- Allowed values
- full - Include all properties.
- no_acl - Omit the acl property.
- pageToken: string, A previously-returned page token representing part of the larger set of results to view.
- delimiter: string, Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
- prefix: string, Filter results to objects whose names begin with this prefix.
- max_results: integer, Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested.
-
-Returns:
- An object of the form:
-
- { # A list of objects.
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "items": [ # The list of items.
- { # An object.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "contentLanguage": "A String", # Content-Language of the object data.
- "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
- "contentType": "A String", # Content-Type of the object data.
- "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
- "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
- "length": "A String", # Content-Length of the data in bytes.
- "link": "A String", # Media download link.
- "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
- "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
- },
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "selfLink": "A String", # The link to this object.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- },
- ],
- "kind": "storage#objects", # The kind of item this is. For lists of objects, this is always storage#objects.
- "prefixes": [ # The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter.
- "A String",
- ],
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(bucket, object, body, projection=None)
-
Updates a data blob's associated metadata. This method supports patch semantics.
-
-Args:
- bucket: string, Name of the bucket in which the object resides. (required)
- object: string, Name of the object. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An object.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "contentLanguage": "A String", # Content-Language of the object data.
- "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
- "contentType": "A String", # Content-Type of the object data.
- "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
- "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
- "length": "A String", # Content-Length of the data in bytes.
- "link": "A String", # Media download link.
- "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
- "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
- },
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "selfLink": "A String", # The link to this object.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- }
-
- projection: string, Set of properties to return. Defaults to full.
- Allowed values
- full - Include all properties.
- no_acl - Omit the acl property.
-
-Returns:
- An object of the form:
-
- { # An object.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "contentLanguage": "A String", # Content-Language of the object data.
- "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
- "contentType": "A String", # Content-Type of the object data.
- "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
- "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
- "length": "A String", # Content-Length of the data in bytes.
- "link": "A String", # Media download link.
- "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
- "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
- },
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "selfLink": "A String", # The link to this object.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- }
-
-
update(bucket, object, body, projection=None)
-
Updates a data blob's associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which the object resides. (required)
- object: string, Name of the object. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An object.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "contentLanguage": "A String", # Content-Language of the object data.
- "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
- "contentType": "A String", # Content-Type of the object data.
- "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
- "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
- "length": "A String", # Content-Length of the data in bytes.
- "link": "A String", # Media download link.
- "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
- "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
- },
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "selfLink": "A String", # The link to this object.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- }
-
- projection: string, Set of properties to return. Defaults to full.
- Allowed values
- full - Include all properties.
- no_acl - Omit the acl property.
-
-Returns:
- An object of the form:
-
- { # An object.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "contentLanguage": "A String", # Content-Language of the object data.
- "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
- "contentType": "A String", # Content-Type of the object data.
- "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
- "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
- "length": "A String", # Content-Length of the data in bytes.
- "link": "A String", # Media download link.
- "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
- "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
- },
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "selfLink": "A String", # The link to this object.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- }
-
-
update_media(bucket, object, body, projection=None)
-
Updates a data blob's associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which the object resides. (required)
- object: string, Name of the object. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An object.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "contentLanguage": "A String", # Content-Language of the object data.
- "media": { # Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part.
- "contentType": "A String", # Content-Type of the object data.
- "timeCreated": "A String", # Creation time of the data in RFC 3339 format.
- "algorithm": "MD5", # Hash algorithm used. Currently only MD5 is supported. Required if a hash is provided.
- "length": "A String", # Content-Length of the data in bytes.
- "link": "A String", # Media download link.
- "hash": "A String", # Hash of the data. Required if a hash algorithm is provided.
- "data": "A String", # URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted.
- },
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "selfLink": "A String", # The link to this object.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "id": "A String", # The ID of the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "entityId": "A String", # The ID for the entity, if any.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- }
-
- projection: string, Set of properties to return. Defaults to full.
- Allowed values
- full - Include all properties.
- no_acl - Omit the acl property.
-
-Returns:
- The media object as a string.
-
-
-
Instance Methods
-
- delete(bucket, entity)
-Permanently deletes the ACL entry for the specified entity on the specified bucket.
-
- get(bucket, entity)
-Returns the ACL entry for the specified entity on the specified bucket.
-
- insert(bucket, body)
-Creates a new ACL entry on the specified bucket.
-
- list(bucket)
-Retrieves ACL entries on the specified bucket.
-
- patch(bucket, entity, body)
-Updates an ACL entry on the specified bucket. This method supports patch semantics.
-
- update(bucket, entity, body)
-Updates an ACL entry on the specified bucket.
-Method Details
-
-
delete(bucket, entity)
-
Permanently deletes the ACL entry for the specified entity on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
-
-
-
get(bucket, entity)
-
Returns the ACL entry for the specified entity on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
insert(bucket, body)
-
Creates a new ACL entry on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
list(bucket)
-
Retrieves ACL entries on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
-
-Returns:
- An object of the form:
-
- { # An access-control list.
- "items": [ # The list of items.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "kind": "storage#bucketAccessControls", # The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls.
- }
-
-
patch(bucket, entity, body)
-
Updates an ACL entry on the specified bucket. This method supports patch semantics.
-
-Args:
- bucket: string, Name of a bucket. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
update(bucket, entity, body)
-
Updates an ACL entry on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
Instance Methods
-
- delete(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)
-Permanently deletes an empty bucket.
-
- get(bucket, projection=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)
-Returns metadata for the specified bucket.
-
- insert(project, body, projection=None)
-Creates a new bucket.
-
- list(project, projection=None, pageToken=None, maxResults=None)
-Retrieves a list of buckets for a given project.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(bucket, body, projection=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)
-Updates a bucket. This method supports patch semantics.
-
- update(bucket, body, projection=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)
-Updates a bucket.
-Method Details
-
-
delete(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)
-
Permanently deletes an empty bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- ifMetagenerationMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
- ifMetagenerationNotMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
-
-
-
get(bucket, projection=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)
-
Returns metadata for the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- projection: string, Set of properties to return. Defaults to noAcl.
- Allowed values
- full - Include all properties.
- noAcl - Omit acl and defaultObjectAcl properties.
- ifMetagenerationMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
- ifMetagenerationNotMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
-
-Returns:
- An object of the form:
-
- { # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
- "logObjectPrefix": "A String", # A prefix for log object names.
- "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed.
- },
- "name": "A String", # The name of the bucket.
- "metageneration": "A String", # The metadata generation of this bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "versioning": { # The bucket's versioning configuration.
- "enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
- },
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "etag": "A String", # HTTP 1.1 Entity tag for the bucket.
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list.
- "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration.
- {
- "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- "A String",
- ],
- "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- "A String",
- ],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
- "A String",
- ],
- "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- },
- ],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information.
- "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
- {
- "action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
- },
- "condition": { # The condition(s) under which the action will be taken.
- "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
- "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
- "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC.
- },
- },
- ],
- },
- "id": "A String", # The ID of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
- }
-
-
insert(project, body, projection=None)
-
Creates a new bucket.
-
-Args:
- project: string, A valid API project identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
- "logObjectPrefix": "A String", # A prefix for log object names.
- "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed.
- },
- "name": "A String", # The name of the bucket.
- "metageneration": "A String", # The metadata generation of this bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "versioning": { # The bucket's versioning configuration.
- "enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
- },
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "etag": "A String", # HTTP 1.1 Entity tag for the bucket.
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list.
- "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration.
- {
- "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- "A String",
- ],
- "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- "A String",
- ],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
- "A String",
- ],
- "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- },
- ],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information.
- "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
- {
- "action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
- },
- "condition": { # The condition(s) under which the action will be taken.
- "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
- "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
- "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC.
- },
- },
- ],
- },
- "id": "A String", # The ID of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
- }
-
- projection: string, Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
- Allowed values
- full - Include all properties.
- noAcl - Omit acl and defaultObjectAcl properties.
-
-Returns:
- An object of the form:
-
- { # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
- "logObjectPrefix": "A String", # A prefix for log object names.
- "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed.
- },
- "name": "A String", # The name of the bucket.
- "metageneration": "A String", # The metadata generation of this bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "versioning": { # The bucket's versioning configuration.
- "enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
- },
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "etag": "A String", # HTTP 1.1 Entity tag for the bucket.
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list.
- "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration.
- {
- "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- "A String",
- ],
- "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- "A String",
- ],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
- "A String",
- ],
- "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- },
- ],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information.
- "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
- {
- "action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
- },
- "condition": { # The condition(s) under which the action will be taken.
- "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
- "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
- "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC.
- },
- },
- ],
- },
- "id": "A String", # The ID of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
- }
-
-
list(project, projection=None, pageToken=None, maxResults=None)
-
Retrieves a list of buckets for a given project.
-
-Args:
- project: string, A valid API project identifier. (required)
- projection: string, Set of properties to return. Defaults to noAcl.
- Allowed values
- full - Include all properties.
- noAcl - Omit acl and defaultObjectAcl properties.
- pageToken: string, A previously-returned page token representing part of the larger set of results to view.
- maxResults: integer, Maximum number of buckets to return.
-
-Returns:
- An object of the form:
-
- { # A list of buckets.
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "items": [ # The list of items.
- { # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
- "logObjectPrefix": "A String", # A prefix for log object names.
- "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed.
- },
- "name": "A String", # The name of the bucket.
- "metageneration": "A String", # The metadata generation of this bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "versioning": { # The bucket's versioning configuration.
- "enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
- },
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "etag": "A String", # HTTP 1.1 Entity tag for the bucket.
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list.
- "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration.
- {
- "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- "A String",
- ],
- "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- "A String",
- ],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
- "A String",
- ],
- "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- },
- ],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information.
- "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
- {
- "action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
- },
- "condition": { # The condition(s) under which the action will be taken.
- "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
- "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
- "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC.
- },
- },
- ],
- },
- "id": "A String", # The ID of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
- },
- ],
- "kind": "storage#buckets", # The kind of item this is. For lists of buckets, this is always storage#buckets.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(bucket, body, projection=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)
-
Updates a bucket. This method supports patch semantics.
-
-Args:
- bucket: string, Name of a bucket. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
- "logObjectPrefix": "A String", # A prefix for log object names.
- "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed.
- },
- "name": "A String", # The name of the bucket.
- "metageneration": "A String", # The metadata generation of this bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "versioning": { # The bucket's versioning configuration.
- "enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
- },
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "etag": "A String", # HTTP 1.1 Entity tag for the bucket.
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list.
- "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration.
- {
- "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- "A String",
- ],
- "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- "A String",
- ],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
- "A String",
- ],
- "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- },
- ],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information.
- "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
- {
- "action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
- },
- "condition": { # The condition(s) under which the action will be taken.
- "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
- "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
- "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC.
- },
- },
- ],
- },
- "id": "A String", # The ID of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
- }
-
- projection: string, Set of properties to return. Defaults to full.
- Allowed values
- full - Include all properties.
- noAcl - Omit acl and defaultObjectAcl properties.
- ifMetagenerationMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
- ifMetagenerationNotMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
-
-Returns:
- An object of the form:
-
- { # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
- "logObjectPrefix": "A String", # A prefix for log object names.
- "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed.
- },
- "name": "A String", # The name of the bucket.
- "metageneration": "A String", # The metadata generation of this bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "versioning": { # The bucket's versioning configuration.
- "enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
- },
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "etag": "A String", # HTTP 1.1 Entity tag for the bucket.
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list.
- "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration.
- {
- "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- "A String",
- ],
- "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- "A String",
- ],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
- "A String",
- ],
- "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- },
- ],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information.
- "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
- {
- "action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
- },
- "condition": { # The condition(s) under which the action will be taken.
- "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
- "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
- "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC.
- },
- },
- ],
- },
- "id": "A String", # The ID of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
- }
-
-
update(bucket, body, projection=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)
-
Updates a bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
- "logObjectPrefix": "A String", # A prefix for log object names.
- "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed.
- },
- "name": "A String", # The name of the bucket.
- "metageneration": "A String", # The metadata generation of this bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "versioning": { # The bucket's versioning configuration.
- "enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
- },
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "etag": "A String", # HTTP 1.1 Entity tag for the bucket.
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list.
- "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration.
- {
- "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- "A String",
- ],
- "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- "A String",
- ],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
- "A String",
- ],
- "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- },
- ],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information.
- "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
- {
- "action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
- },
- "condition": { # The condition(s) under which the action will be taken.
- "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
- "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
- "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC.
- },
- },
- ],
- },
- "id": "A String", # The ID of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
- }
-
- projection: string, Set of properties to return. Defaults to full.
- Allowed values
- full - Include all properties.
- noAcl - Omit acl and defaultObjectAcl properties.
- ifMetagenerationMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
- ifMetagenerationNotMatch: string, Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
-
-Returns:
- An object of the form:
-
- { # A bucket.
- "website": { # The bucket's website configuration.
- "notFoundPage": "A String", # The custom object to return when a requested resource is not found.
- "mainPageSuffix": "A String", # Behaves as the bucket's directory index where missing objects are treated as potential directories.
- },
- "kind": "storage#bucket", # The kind of item this is. For buckets, this is always storage#bucket.
- "logging": { # The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
- "logObjectPrefix": "A String", # A prefix for log object names.
- "logBucket": "A String", # The destination bucket where the current bucket's logs should be placed.
- },
- "name": "A String", # The name of the bucket.
- "metageneration": "A String", # The metadata generation of this bucket.
- "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format.
- "versioning": { # The bucket's versioning configuration.
- "enabled": True or False, # While set to true, versioning is fully enabled for this bucket.
- },
- "acl": [ # Access controls on the bucket.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER, WRITER, or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "defaultObjectAcl": [ # Default access controls to apply to new objects when no ACL is provided.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "etag": "A String", # HTTP 1.1 Entity tag for the bucket.
- "location": "A String", # The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Typical values are US and EU. Defaults to US. See the developer's guide for the authoritative list.
- "cors": [ # The bucket's Cross-Origin Resource Sharing (CORS) configuration.
- {
- "origin": [ # The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
- "A String",
- ],
- "responseHeader": [ # The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
- "A String",
- ],
- "method": [ # The list of HTTP methods on which to include CORS response headers, e.g. GET, OPTIONS, POST. Note, "*" is permitted in the list of methods, and means "any method".
- "A String",
- ],
- "maxAgeSeconds": 42, # The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
- },
- ],
- "owner": { # The owner of the bucket. This will always be the project team's owner group.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form group-groupId.
- },
- "lifecycle": { # The bucket's lifecycle configuration. See object lifecycle management for more information.
- "rule": [ # A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
- {
- "action": { # The action to take.
- "type": "A String", # Type of the action, e.g. Delete.
- },
- "condition": { # The condition(s) under which the action will be taken.
- "isLive": True or False, # Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
- "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
- "age": 42, # Age of an object (in days). This condition is satisfied when an object reaches the specified age.
- "createdBefore": "A String", # A date in RFC 3339 format with only the date part, e.g. "2013-01-15". This condition is satisfied when an object is created before midnight of the specified date in UTC.
- },
- },
- ],
- },
- "id": "A String", # The ID of the bucket.
- "selfLink": "A String", # The URI of this bucket.
- "storageClass": "A String", # The bucket's storage class. This defines how objects in the bucket will be stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.
- }
-
Instance Methods
-
- stop(body)
-A description of how to use this function
-Method Details
-
-
stop(body)
-
A description of how to use this function
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
-
-
Instance Methods
-
- delete(bucket, entity)
-Permanently deletes the default object ACL entry for the specified entity on the specified bucket.
-
- get(bucket, entity)
-Returns the default object ACL entry for the specified entity on the specified bucket.
-
- insert(bucket, body)
-Creates a new default object ACL entry on the specified bucket.
-
- list(bucket)
-Retrieves default object ACL entries on the specified bucket.
-
- patch(bucket, entity, body)
-Updates a default object ACL entry on the specified bucket. This method supports patch semantics.
-
- update(bucket, entity, body)
-Updates a default object ACL entry on the specified bucket.
-Method Details
-
-
delete(bucket, entity)
-
Permanently deletes the default object ACL entry for the specified entity on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
-
-
-
get(bucket, entity)
-
Returns the default object ACL entry for the specified entity on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
insert(bucket, body)
-
Creates a new default object ACL entry on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
-}
-
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
list(bucket)
-
Retrieves default object ACL entries on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
-
-Returns:
- An object of the form:
-
- { # An access-control list.
- "items": [ # The list of items.
- "",
- ],
- "kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.
- }
-
-
patch(bucket, entity, body)
-
Updates a default object ACL entry on the specified bucket. This method supports patch semantics.
-
-Args:
- bucket: string, Name of a bucket. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
-}
-
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
update(bucket, entity, body)
-
Updates a default object ACL entry on the specified bucket.
-
-Args:
- bucket: string, Name of a bucket. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
-}
-
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
Instance Methods
-
- bucketAccessControls()
-
-Returns the bucketAccessControls Resource.
-
-
- buckets()
-
-Returns the buckets Resource.
-
-
- channels()
-
-Returns the channels Resource.
-
-
- defaultObjectAccessControls()
-
-Returns the defaultObjectAccessControls Resource.
-
-
- objectAccessControls()
-
-Returns the objectAccessControls Resource.
-
-
- objects()
-
-Returns the objects Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/storage_v1beta2.objectAccessControls.html b/docs/dyn/storage_v1beta2.objectAccessControls.html
deleted file mode 100644
index c756438..0000000
--- a/docs/dyn/storage_v1beta2.objectAccessControls.html
+++ /dev/null
@@ -1,339 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(bucket, object, entity, generation=None)
-Permanently deletes the ACL entry for the specified entity on the specified object.
-
- get(bucket, object, entity, generation=None)
-Returns the ACL entry for the specified entity on the specified object.
-
- insert(bucket, object, body, generation=None)
-Creates a new ACL entry on the specified object.
-
- list(bucket, object, generation=None)
-Retrieves ACL entries on the specified object.
-
- patch(bucket, object, entity, body, generation=None)
-Updates an ACL entry on the specified object. This method supports patch semantics.
-
- update(bucket, object, entity, body, generation=None)
-Updates an ACL entry on the specified object.
-Method Details
-
-
delete(bucket, object, entity, generation=None)
-
Permanently deletes the ACL entry for the specified entity on the specified object.
-
-Args:
- bucket: string, Name of a bucket. (required)
- object: string, Name of the object. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
- generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
-
-
-
get(bucket, object, entity, generation=None)
-
Returns the ACL entry for the specified entity on the specified object.
-
-Args:
- bucket: string, Name of a bucket. (required)
- object: string, Name of the object. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
- generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
insert(bucket, object, body, generation=None)
-
Creates a new ACL entry on the specified object.
-
-Args:
- bucket: string, Name of a bucket. (required)
- object: string, Name of the object. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
-}
-
- generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
list(bucket, object, generation=None)
-
Retrieves ACL entries on the specified object.
-
-Args:
- bucket: string, Name of a bucket. (required)
- object: string, Name of the object. (required)
- generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
-
-Returns:
- An object of the form:
-
- { # An access-control list.
- "items": [ # The list of items.
- "",
- ],
- "kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.
- }
-
-
patch(bucket, object, entity, body, generation=None)
-
Updates an ACL entry on the specified object. This method supports patch semantics.
-
-Args:
- bucket: string, Name of a bucket. (required)
- object: string, Name of the object. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
-}
-
- generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
-
update(bucket, object, entity, body, generation=None)
-
Updates an ACL entry on the specified object.
-
-Args:
- bucket: string, Name of a bucket. (required)
- object: string, Name of the object. (required)
- entity: string, The entity holding the permission. Can be user-userId, group-groupId, allUsers, or allAuthenticatedUsers. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
-}
-
- generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
-
-Returns:
- An object of the form:
-
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- }
-
Instance Methods
-
- compose(destinationBucket, destinationObject, body, ifMetagenerationMatch=None, ifGenerationMatch=None)
-Concatenates a list of existing objects into a new object in the same bucket.
-
- compose_media(destinationBucket, destinationObject, body, ifMetagenerationMatch=None, ifGenerationMatch=None)
-Concatenates a list of existing objects into a new object in the same bucket.
-
- copy(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationNotMatch=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationMatch=None)
-Copies an object to a destination in the same location. Optionally overrides metadata.
-
- copy_media(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationNotMatch=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationMatch=None)
-Copies an object to a destination in the same location. Optionally overrides metadata.
-
- delete(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None)
-Deletes data blobs and associated metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.
-
- get(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)
-Retrieves objects or their associated metadata.
-
- get_media(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)
-Retrieves objects or their associated metadata.
-
- insert(bucket, body=None, media_body=None, projection=None, ifMetagenerationMatch=None, name=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, ifGenerationNotMatch=None)
-Stores new data blobs and associated metadata.
-
- insert_media(bucket, body=None, media_body=None, projection=None, ifMetagenerationMatch=None, name=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, ifGenerationNotMatch=None)
-Stores new data blobs and associated metadata.
-
- list(bucket, projection=None, versions=None, delimiter=None, maxResults=None, pageToken=None, prefix=None)
-Retrieves a list of objects matching the criteria.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(bucket, object, body, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)
-Updates a data blob's associated metadata. This method supports patch semantics.
-
- update(bucket, object, body, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)
-Updates a data blob's associated metadata.
-
- update_media(bucket, object, body, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)
-Updates a data blob's associated metadata.
-
- watchAll(bucket, body, projection=None, versions=None, delimiter=None, maxResults=None, pageToken=None, prefix=None)
-Watch for changes on all objects in a bucket.
-Method Details
-
-
compose(destinationBucket, destinationObject, body, ifMetagenerationMatch=None, ifGenerationMatch=None)
-
Concatenates a list of existing objects into a new object in the same bucket.
-
-Args:
- destinationBucket: string, Name of the bucket in which to store the new object. (required)
- destinationObject: string, Name of the new object. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Compose request.
- "kind": "storage#composeRequest", # The kind of item this is.
- "destination": { # An object. # Properties of the resulting object
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- },
- "sourceObjects": [ # The list of source objects that will be concatenated into a single object.
- {
- "generation": "A String", # The generation of this object to use as the source.
- "name": "A String", # The source object's name. The source object's bucket is implicitly the destination bucket.
- "objectPreconditions": {
- "ifGenerationMatch": "A String", # Only perform the composition if the generation of the source object that would be used matches this value. If this value and a generation are both specified, they must be the same value or the call will fail.
- },
- },
- ],
- }
-
- ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
- ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
-
-Returns:
- An object of the form:
-
- { # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
-
compose_media(destinationBucket, destinationObject, body, ifMetagenerationMatch=None, ifGenerationMatch=None)
-
Concatenates a list of existing objects into a new object in the same bucket.
-
-Args:
- destinationBucket: string, Name of the bucket in which to store the new object. (required)
- destinationObject: string, Name of the new object. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A Compose request.
- "kind": "storage#composeRequest", # The kind of item this is.
- "destination": { # An object. # Properties of the resulting object
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- },
- "sourceObjects": [ # The list of source objects that will be concatenated into a single object.
- {
- "generation": "A String", # The generation of this object to use as the source.
- "name": "A String", # The source object's name. The source object's bucket is implicitly the destination bucket.
- "objectPreconditions": {
- "ifGenerationMatch": "A String", # Only perform the composition if the generation of the source object that would be used matches this value. If this value and a generation are both specified, they must be the same value or the call will fail.
- },
- },
- ],
- }
-
- ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
- ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
-
-Returns:
- The media object as a string.
-
-
-
-
copy(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationNotMatch=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationMatch=None)
-
Copies an object to a destination in the same location. Optionally overrides metadata.
-
-Args:
- sourceBucket: string, Name of the bucket in which to find the source object. (required)
- sourceObject: string, Name of the source object. (required)
- destinationBucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required)
- destinationObject: string, Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
- projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
- Allowed values
- full - Include all properties.
- noAcl - Omit the acl property.
- sourceGeneration: string, If present, selects a specific revision of the source object (as opposed to the latest version, the default).
- ifSourceGenerationNotMatch: string, Makes the operation conditional on whether the source object's generation does not match the given value.
- ifSourceMetagenerationNotMatch: string, Makes the operation conditional on whether the source object's current metageneration does not match the given value.
- ifGenerationMatch: string, Makes the operation conditional on whether the destination object's current generation matches the given value.
- ifGenerationNotMatch: string, Makes the operation conditional on whether the destination object's current generation does not match the given value.
- ifMetagenerationNotMatch: string, Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
- ifSourceGenerationMatch: string, Makes the operation conditional on whether the source object's generation matches the given value.
- ifSourceMetagenerationMatch: string, Makes the operation conditional on whether the source object's current metageneration matches the given value.
- ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's current metageneration matches the given value.
-
-Returns:
- An object of the form:
-
- { # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
-
copy_media(sourceBucket, sourceObject, destinationBucket, destinationObject, body, projection=None, sourceGeneration=None, ifSourceGenerationNotMatch=None, ifSourceMetagenerationNotMatch=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationNotMatch=None, ifSourceGenerationMatch=None, ifSourceMetagenerationMatch=None, ifMetagenerationMatch=None)
-
Copies an object to a destination in the same location. Optionally overrides metadata.
-
-Args:
- sourceBucket: string, Name of the bucket in which to find the source object. (required)
- sourceObject: string, Name of the source object. (required)
- destinationBucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required)
- destinationObject: string, Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
- projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
- Allowed values
- full - Include all properties.
- noAcl - Omit the acl property.
- sourceGeneration: string, If present, selects a specific revision of the source object (as opposed to the latest version, the default).
- ifSourceGenerationNotMatch: string, Makes the operation conditional on whether the source object's generation does not match the given value.
- ifSourceMetagenerationNotMatch: string, Makes the operation conditional on whether the source object's current metageneration does not match the given value.
- ifGenerationMatch: string, Makes the operation conditional on whether the destination object's current generation matches the given value.
- ifGenerationNotMatch: string, Makes the operation conditional on whether the destination object's current generation does not match the given value.
- ifMetagenerationNotMatch: string, Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
- ifSourceGenerationMatch: string, Makes the operation conditional on whether the source object's generation matches the given value.
- ifSourceMetagenerationMatch: string, Makes the operation conditional on whether the source object's current metageneration matches the given value.
- ifMetagenerationMatch: string, Makes the operation conditional on whether the destination object's current metageneration matches the given value.
-
-Returns:
- The media object as a string.
-
-
-
-
delete(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None)
-
Deletes data blobs and associated metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.
-
-Args:
- bucket: string, Name of the bucket in which the object resides. (required)
- object: string, Name of the object. (required)
- ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value.
- generation: string, If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).
- ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
- ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
- ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value.
-
-
-
get(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)
-
Retrieves objects or their associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which the object resides. (required)
- object: string, Name of the object. (required)
- ifGenerationNotMatch: string, Makes the operation conditional on whether the object's generation does not match the given value.
- generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
- ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
- ifGenerationMatch: string, Makes the operation conditional on whether the object's generation matches the given value.
- ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value.
- projection: string, Set of properties to return. Defaults to noAcl.
- Allowed values
- full - Include all properties.
- noAcl - Omit the acl property.
-
-Returns:
- An object of the form:
-
- { # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
-
get_media(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)
-
Retrieves objects or their associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which the object resides. (required)
- object: string, Name of the object. (required)
- ifGenerationNotMatch: string, Makes the operation conditional on whether the object's generation does not match the given value.
- generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
- ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
- ifGenerationMatch: string, Makes the operation conditional on whether the object's generation matches the given value.
- ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value.
- projection: string, Set of properties to return. Defaults to noAcl.
- Allowed values
- full - Include all properties.
- noAcl - Omit the acl property.
-
-Returns:
- The media object as a string.
-
-
-
-
insert(bucket, body=None, media_body=None, projection=None, ifMetagenerationMatch=None, name=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, ifGenerationNotMatch=None)
-
Stores new data blobs and associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
- Allowed values
- full - Include all properties.
- noAcl - Omit the acl property.
- ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
- name: string, Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.
- ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
- ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value.
- ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value.
-
-Returns:
- An object of the form:
-
- { # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
-
insert_media(bucket, body=None, media_body=None, projection=None, ifMetagenerationMatch=None, name=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, ifGenerationNotMatch=None)
-
Stores new data blobs and associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
- Allowed values
- full - Include all properties.
- noAcl - Omit the acl property.
- ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
- name: string, Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.
- ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
- ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value.
- ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value.
-
-Returns:
- The media object as a string.
-
-
-
-
list(bucket, projection=None, versions=None, delimiter=None, maxResults=None, pageToken=None, prefix=None)
-
Retrieves a list of objects matching the criteria.
-
-Args:
- bucket: string, Name of the bucket in which to look for objects. (required)
- projection: string, Set of properties to return. Defaults to noAcl.
- Allowed values
- full - Include all properties.
- noAcl - Omit the acl property.
- versions: boolean, If true, lists all versions of a file as distinct results.
- delimiter: string, Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
- maxResults: integer, Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested.
- pageToken: string, A previously-returned page token representing part of the larger set of results to view.
- prefix: string, Filter results to objects whose names begin with this prefix.
-
-Returns:
- An object of the form:
-
- { # A list of objects.
- "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
- "items": [ # The list of items.
- { # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- },
- ],
- "kind": "storage#objects", # The kind of item this is. For lists of objects, this is always storage#objects.
- "prefixes": [ # The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter.
- "A String",
- ],
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(bucket, object, body, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)
-
Updates a data blob's associated metadata. This method supports patch semantics.
-
-Args:
- bucket: string, Name of the bucket in which the object resides. (required)
- object: string, Name of the object. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
- ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value.
- generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
- ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
- ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
- ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value.
- projection: string, Set of properties to return. Defaults to full.
- Allowed values
- full - Include all properties.
- noAcl - Omit the acl property.
-
-Returns:
- An object of the form:
-
- { # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
-
update(bucket, object, body, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)
-
Updates a data blob's associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which the object resides. (required)
- object: string, Name of the object. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
- ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value.
- generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
- ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
- ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
- ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value.
- projection: string, Set of properties to return. Defaults to full.
- Allowed values
- full - Include all properties.
- noAcl - Omit the acl property.
-
-Returns:
- An object of the form:
-
- { # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
-
update_media(bucket, object, body, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)
-
Updates a data blob's associated metadata.
-
-Args:
- bucket: string, Name of the bucket in which the object resides. (required)
- object: string, Name of the object. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An object.
- "generation": "A String", # The content generation of this object. Used for object versioning.
- "componentCount": 42, # Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
- "mediaLink": "A String", # Media download link.
- "owner": { # The owner of the object. This will always be the uploader of the object.
- "entityId": "A String", # The ID for the entity.
- "entity": "A String", # The entity, in the form user-userId.
- },
- "cacheControl": "A String", # Cache-Control directive for the object data.
- "acl": [ # Access controls on the object.
- { # An access-control entry.
- "domain": "A String", # The domain associated with the entity, if any.
- "generation": "A String", # The content generation of the object.
- "object": "A String", # The name of the object.
- "bucket": "A String", # The name of the bucket.
- "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- "entity": "A String", # The entity holding the permission, in one of the following forms:
- # - user-userId
- # - user-email
- # - group-groupId
- # - group-email
- # - allUsers
- # - allAuthenticatedUsers
- "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
- "role": "A String", # The access permission for the entity. Can be READER or OWNER.
- "id": "A String", # The ID of the access-control entry.
- "entityId": "A String", # The ID for the entity, if any.
- "email": "A String", # The email address associated with the entity, if any.
- "selfLink": "A String", # The link to this access-control entry.
- },
- ],
- "id": "A String", # The ID of the object.
- "size": "A String", # Content-Length of the data in bytes.
- "timeDeleted": "A String", # Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- "md5Hash": "A String", # MD5 hash of the data; encoded using base64.
- "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
- "etag": "A String", # HTTP 1.1 Entity tag for the object.
- "metadata": { # User-provided metadata, in key/value pairs.
- "a_key": "A String", # An individual metadata entry.
- },
- "updated": "A String", # Modification time of the object metadata in RFC 3339 format.
- "contentType": "A String", # Content-Type of the object data.
- "contentLanguage": "A String", # Content-Language of the object data.
- "metageneration": "A String", # The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
- "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object.
- "name": "A String", # The name of this object. Required if not specified by URL parameter.
- "bucket": "A String", # The bucket containing this object.
- "contentEncoding": "A String", # Content-Encoding of the object data.
- "contentDisposition": "A String", # Content-Disposition of the object data.
- "selfLink": "A String", # The link to this object.
- }
-
- ifGenerationNotMatch: string, Makes the operation conditional on whether the object's current generation does not match the given value.
- generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
- ifMetagenerationMatch: string, Makes the operation conditional on whether the object's current metageneration matches the given value.
- ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value.
- ifMetagenerationNotMatch: string, Makes the operation conditional on whether the object's current metageneration does not match the given value.
- projection: string, Set of properties to return. Defaults to full.
- Allowed values
- full - Include all properties.
- noAcl - Omit the acl property.
-
-Returns:
- The media object as a string.
-
-
-
-
watchAll(bucket, body, projection=None, versions=None, delimiter=None, maxResults=None, pageToken=None, prefix=None)
-
Watch for changes on all objects in a bucket.
-
-Args:
- bucket: string, Name of the bucket in which to look for objects. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
- projection: string, Set of properties to return. Defaults to noAcl.
- Allowed values
- full - Include all properties.
- noAcl - Omit the acl property.
- versions: boolean, If true, lists all versions of a file as distinct results.
- delimiter: string, Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
- maxResults: integer, Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested.
- pageToken: string, A previously-returned page token representing part of the larger set of results to view.
- prefix: string, Filter results to objects whose names begin with this prefix.
-
-Returns:
- An object of the form:
-
- {
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
Instance Methods
-
- taskqueues()
-
-Returns the taskqueues Resource.
-
-
- tasks()
-
-Returns the tasks Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/taskqueue_v1beta2.taskqueues.html b/docs/dyn/taskqueue_v1beta2.taskqueues.html
deleted file mode 100644
index 3b78252..0000000
--- a/docs/dyn/taskqueue_v1beta2.taskqueues.html
+++ /dev/null
@@ -1,117 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(project, taskqueue, getStats=None)
-Get detailed information about a TaskQueue.
-Method Details
-
-
get(project, taskqueue, getStats=None)
-
Get detailed information about a TaskQueue.
-
-Args:
- project: string, The project under which the queue lies. (required)
- taskqueue: string, The id of the taskqueue to get the properties of. (required)
- getStats: boolean, Whether to get stats. Optional.
-
-Returns:
- An object of the form:
-
- {
- "kind": "taskqueues#taskqueue", # The kind of REST object returned, in this case taskqueue.
- "stats": { # Statistics for the TaskQueue object in question.
- "oldestTask": "A String", # The timestamp (in seconds since the epoch) of the oldest unfinished task.
- "leasedLastMinute": "A String", # Number of tasks leased in the last minute.
- "totalTasks": 42, # Number of tasks in the queue.
- "leasedLastHour": "A String", # Number of tasks leased in the last hour.
- },
- "id": "A String", # Name of the taskqueue.
- "maxLeases": 42, # The number of times we should lease out tasks before giving up on them. If unset we lease them out forever until a worker deletes the task.
- "acl": { # ACLs that are applicable to this TaskQueue object.
- "consumerEmails": [ # Email addresses of users who can "consume" tasks from the TaskQueue. This means they can Dequeue and Delete tasks from the queue.
- "A String",
- ],
- "producerEmails": [ # Email addresses of users who can "produce" tasks into the TaskQueue. This means they can Insert tasks into the queue.
- "A String",
- ],
- "adminEmails": [ # Email addresses of users who are "admins" of the TaskQueue. This means they can control the queue, eg set ACLs for the queue.
- "A String",
- ],
- },
- }
-
Instance Methods
-
- delete(project, taskqueue, task)
-Delete a task from a TaskQueue.
-
- get(project, taskqueue, task)
-Get a particular task from a TaskQueue.
-
- insert(project, taskqueue, body)
-Insert a new task in a TaskQueue
-
- lease(project, taskqueue, numTasks, leaseSecs, groupByTag=None, tag=None)
-Lease 1 or more tasks from a TaskQueue.
-
- list(project, taskqueue)
-List Tasks in a TaskQueue
-
- patch(project, taskqueue, task, newLeaseSeconds, body)
-Update tasks that are leased out of a TaskQueue. This method supports patch semantics.
-
- update(project, taskqueue, task, newLeaseSeconds, body)
-Update tasks that are leased out of a TaskQueue.
-Method Details
-
-
delete(project, taskqueue, task)
-
Delete a task from a TaskQueue.
-
-Args:
- project: string, The project under which the queue lies. (required)
- taskqueue: string, The taskqueue to delete a task from. (required)
- task: string, The id of the task to delete. (required)
-
-
-
get(project, taskqueue, task)
-
Get a particular task from a TaskQueue.
-
-Args:
- project: string, The project under which the queue lies. (required)
- taskqueue: string, The taskqueue in which the task belongs. (required)
- task: string, The task to get properties of. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
- "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
- "id": "A String", # Name of the task.
- "retry_count": 42, # The number of leases applied to this 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(project, taskqueue, body)
-
Insert a new task in a TaskQueue
-
-Args:
- project: string, The project under which the queue lies (required)
- taskqueue: string, The taskqueue to insert the task into (required)
- 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.
- "retry_count": 42, # The number of leases applied to this 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.
- }
-
-
-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.
- "retry_count": 42, # The number of leases applied to this 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(project, taskqueue, numTasks, leaseSecs, groupByTag=None, tag=None)
-
Lease 1 or more tasks from a TaskQueue.
-
-Args:
- project: string, The project under which the queue lies. (required)
- taskqueue: string, The taskqueue to lease a task from. (required)
- numTasks: integer, The number of tasks to lease. (required)
- leaseSecs: integer, The lease in seconds. (required)
- groupByTag: boolean, When true, all returned tasks will have the same tag
- 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
-
-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.
- "retry_count": 42, # The number of leases applied to this 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(project, taskqueue)
-
List Tasks in a TaskQueue
-
-Args:
- project: string, The project under which the queue lies. (required)
- taskqueue: string, The id of the taskqueue to list tasks from. (required)
-
-Returns:
- An object of the form:
-
- {
- "items": [ # The actual list of tasks currently active in the TaskQueue.
- {
- "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
- "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
- "id": "A String", # Name of the task.
- "retry_count": 42, # The number of leases applied to this 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(project, taskqueue, task, newLeaseSeconds, body)
-
Update tasks that are leased out of a TaskQueue. This method supports patch semantics.
-
-Args:
- project: string, The project under which the queue lies. (required)
- taskqueue: string, A parameter (required)
- task: string, A parameter (required)
- newLeaseSeconds: integer, The new lease in seconds. (required)
- 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.
- "retry_count": 42, # The number of leases applied to this 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.
- }
-
-
-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.
- "retry_count": 42, # The number of leases applied to this 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(project, taskqueue, task, newLeaseSeconds, body)
-
Update tasks that are leased out of a TaskQueue.
-
-Args:
- project: string, The project under which the queue lies. (required)
- taskqueue: string, A parameter (required)
- task: string, A parameter (required)
- newLeaseSeconds: integer, The new lease in seconds. (required)
- 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.
- "retry_count": 42, # The number of leases applied to this 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.
- }
-
-
-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.
- "retry_count": 42, # The number of leases applied to this 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.
- }
-
Instance Methods
-
- tasklists()
-
-Returns the tasklists Resource.
-
-
- tasks()
-
-Returns the tasks Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/tasks_v1.tasklists.html b/docs/dyn/tasks_v1.tasklists.html
deleted file mode 100644
index 3e70ee3..0000000
--- a/docs/dyn/tasks_v1.tasklists.html
+++ /dev/null
@@ -1,265 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(tasklist)
-Deletes the authenticated user's specified task list.
-
- get(tasklist)
-Returns the authenticated user's specified task list.
-
- insert(body)
-Creates a new task list and adds it to the authenticated user's task lists.
-
- list(pageToken=None, maxResults=None)
-Returns all the authenticated user's task lists.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- patch(tasklist, body)
-Updates the authenticated user's specified task list. This method supports patch semantics.
-
- update(tasklist, body)
-Updates the authenticated user's specified task list.
-Method Details
-
-
delete(tasklist)
-
Deletes the authenticated user's specified task list.
-
-Args:
- tasklist: string, Task list identifier. (required)
-
-
-
get(tasklist)
-
Returns the authenticated user's specified task list.
-
-Args:
- tasklist: string, Task list identifier. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
- "etag": "A String", # ETag of the resource.
- "id": "A String", # Task list identifier.
- "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- }
-
-
insert(body)
-
Creates a new task list and adds it to the authenticated user's task lists.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
- "etag": "A String", # ETag of the resource.
- "id": "A String", # Task list identifier.
- "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
- "etag": "A String", # ETag of the resource.
- "id": "A String", # Task list identifier.
- "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- }
-
-
list(pageToken=None, maxResults=None)
-
Returns all the authenticated user's task lists.
-
-Args:
- pageToken: string, Token specifying the result page to return. Optional.
- maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Token that can be used to request the next page of this result.
- "items": [ # Collection of task lists.
- {
- "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
- "etag": "A String", # ETag of the resource.
- "id": "A String", # Task list identifier.
- "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- },
- ],
- "kind": "tasks#taskLists", # Type of the resource. This is always "tasks#taskLists".
- "etag": "A String", # ETag of the resource.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
patch(tasklist, body)
-
Updates the authenticated user's specified task list. This method supports patch semantics.
-
-Args:
- tasklist: string, Task list identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
- "etag": "A String", # ETag of the resource.
- "id": "A String", # Task list identifier.
- "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
- "etag": "A String", # ETag of the resource.
- "id": "A String", # Task list identifier.
- "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- }
-
-
update(tasklist, body)
-
Updates the authenticated user's specified task list.
-
-Args:
- tasklist: string, Task list identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
- "etag": "A String", # ETag of the resource.
- "id": "A String", # Task list identifier.
- "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList".
- "title": "A String", # Title of the task list.
- "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp).
- "etag": "A String", # ETag of the resource.
- "id": "A String", # Task list identifier.
- "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list.
- }
-
Instance Methods
-
- clear(tasklist)
-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.
-
- delete(tasklist, task)
-Deletes the specified task from the task list.
-
- get(tasklist, task)
-Returns the specified task.
-
- insert(tasklist, body, parent=None, previous=None)
-Creates a new task on the specified task list.
-
- list(tasklist, showCompleted=None, dueMin=None, dueMax=None, pageToken=None, updatedMin=None, showDeleted=None, completedMax=None, maxResults=None, completedMin=None, showHidden=None)
-Returns all tasks in the specified task list.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- move(tasklist, task, parent=None, previous=None)
-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.
-
- patch(tasklist, task, body)
-Updates the specified task. This method supports patch semantics.
-
- update(tasklist, task, body)
-Updates the specified task.
-Method Details
-
-
clear(tasklist)
-
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)
-
-
-
delete(tasklist, task)
-
Deletes the specified task from the task list.
-
-Args:
- tasklist: string, Task list identifier. (required)
- task: string, Task identifier. (required)
-
-
-
get(tasklist, task)
-
Returns the specified task.
-
-Args:
- tasklist: string, Task list identifier. (required)
- task: string, Task identifier. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the task. This is either "needsAction" or "completed".
- "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
- "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
- "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between and .
- },
- ],
- "title": "A String", # Title of the task.
- "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
- "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
- "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
- "etag": "A String", # ETag of the resource.
- "notes": "A String", # Notes describing the task. Optional.
- "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
- "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
- "id": "A String", # Task identifier.
- "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
- }
-
-
insert(tasklist, body, parent=None, previous=None)
-
Creates a new task on the specified task list.
-
-Args:
- tasklist: string, Task list identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # Status of the task. This is either "needsAction" or "completed".
- "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
- "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
- "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between and .
- },
- ],
- "title": "A String", # Title of the task.
- "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
- "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
- "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
- "etag": "A String", # ETag of the resource.
- "notes": "A String", # Notes describing the task. Optional.
- "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
- "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
- "id": "A String", # Task identifier.
- "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
- }
-
- parent: string, Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional.
- previous: string, Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the task. This is either "needsAction" or "completed".
- "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
- "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
- "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between and .
- },
- ],
- "title": "A String", # Title of the task.
- "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
- "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
- "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
- "etag": "A String", # ETag of the resource.
- "notes": "A String", # Notes describing the task. Optional.
- "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
- "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
- "id": "A String", # Task identifier.
- "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
- }
-
-
list(tasklist, showCompleted=None, dueMin=None, dueMax=None, pageToken=None, updatedMin=None, showDeleted=None, completedMax=None, maxResults=None, completedMin=None, showHidden=None)
-
Returns all tasks in the specified task list.
-
-Args:
- tasklist: string, Task list identifier. (required)
- 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.
- 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.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Token used to access the next page of this result.
- "items": [ # Collection of tasks.
- {
- "status": "A String", # Status of the task. This is either "needsAction" or "completed".
- "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
- "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
- "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between and .
- },
- ],
- "title": "A String", # Title of the task.
- "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
- "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
- "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
- "etag": "A String", # ETag of the resource.
- "notes": "A String", # Notes describing the task. Optional.
- "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
- "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
- "id": "A String", # Task identifier.
- "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
- },
- ],
- "kind": "tasks#tasks", # Type of the resource. This is always "tasks#tasks".
- "etag": "A String", # ETag of the resource.
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
move(tasklist, task, parent=None, previous=None)
-
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:
- tasklist: string, Task list identifier. (required)
- task: string, Task identifier. (required)
- parent: string, New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional.
- previous: string, New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the task. This is either "needsAction" or "completed".
- "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
- "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
- "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between and .
- },
- ],
- "title": "A String", # Title of the task.
- "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
- "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
- "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
- "etag": "A String", # ETag of the resource.
- "notes": "A String", # Notes describing the task. Optional.
- "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
- "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
- "id": "A String", # Task identifier.
- "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
- }
-
-
patch(tasklist, task, body)
-
Updates the specified task. This method supports patch semantics.
-
-Args:
- tasklist: string, Task list identifier. (required)
- task: string, Task identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # Status of the task. This is either "needsAction" or "completed".
- "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
- "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
- "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between and .
- },
- ],
- "title": "A String", # Title of the task.
- "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
- "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
- "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
- "etag": "A String", # ETag of the resource.
- "notes": "A String", # Notes describing the task. Optional.
- "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
- "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
- "id": "A String", # Task identifier.
- "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the task. This is either "needsAction" or "completed".
- "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
- "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
- "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between and .
- },
- ],
- "title": "A String", # Title of the task.
- "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
- "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
- "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
- "etag": "A String", # ETag of the resource.
- "notes": "A String", # Notes describing the task. Optional.
- "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
- "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
- "id": "A String", # Task identifier.
- "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
- }
-
-
update(tasklist, task, body)
-
Updates the specified task.
-
-Args:
- tasklist: string, Task list identifier. (required)
- task: string, Task identifier. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # Status of the task. This is either "needsAction" or "completed".
- "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
- "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
- "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between and .
- },
- ],
- "title": "A String", # Title of the task.
- "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
- "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
- "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
- "etag": "A String", # ETag of the resource.
- "notes": "A String", # Notes describing the task. Optional.
- "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
- "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
- "id": "A String", # Task identifier.
- "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the task. This is either "needsAction" or "completed".
- "kind": "tasks#task", # Type of the resource. This is always "tasks#task".
- "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
- "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.
- "links": [ # Collection of links. This collection is read-only.
- {
- "type": "A String", # Type of the link, e.g. "email".
- "link": "A String", # The URL.
- "description": "A String", # The description. In HTML speak: Everything between and .
- },
- ],
- "title": "A String", # Title of the task.
- "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.
- "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.
- "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional.
- "etag": "A String", # ETag of the resource.
- "notes": "A String", # Notes describing the task. Optional.
- "position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.
- "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.
- "id": "A String", # Task identifier.
- "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
- }
-
Instance Methods
-
- list(q)
-Detect the language of text.
-Method Details
-
-
list(q)
-
Detect the language of text.
-
-Args:
- q: string, The text to detect (required) (repeated)
-
-Returns:
- An object of the form:
-
- {
- "detections": [ # A detections contains detection results of several text
- [ # An array of languages which we detect for the given text The most likely language list first.
- {
- "isReliable": True or False, # A boolean to indicate is the language detection result reliable.
- "confidence": 3.14, # The confidence of the detection resul of this language.
- "language": "A String", # The language we detect
- },
- ],
- ],
- }
-
Instance Methods
-
- detections()
-
-Returns the detections Resource.
-
-
- languages()
-
-Returns the languages Resource.
-
-
- translations()
-
-Returns the translations Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/translate_v2.languages.html b/docs/dyn/translate_v2.languages.html
deleted file mode 100644
index 9bb4afd..0000000
--- a/docs/dyn/translate_v2.languages.html
+++ /dev/null
@@ -1,101 +0,0 @@
-
-
-
-
-Instance Methods
-
- list(target=None)
-List the source/target languages supported by the API
-Method Details
-
-
list(target=None)
-
List the source/target languages supported by the API
-
-Args:
- target: string, the language and collation in which the localized results should be returned
-
-Returns:
- An object of the form:
-
- {
- "languages": [ # List of source/target languages supported by the translation API. If target parameter is unspecified, the list is sorted by the ASCII code point order of the language code. If target parameter is specified, the list is sorted by the collation order of the language name in the target language.
- {
- "name": "A String", # The localized name of the language if target parameter is given.
- "language": "A String", # The language code.
- },
- ],
- }
-
Instance Methods
-
- list(q, target, format=None, cid=None, source=None)
-Returns text translations from one language to another.
-Method Details
-
-
list(q, target, format=None, cid=None, source=None)
-
Returns text translations from one language to another.
-
-Args:
- q: string, The text to translate (required) (repeated)
- target: string, The target language into which the text should be translated (required)
- 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
- cid: string, The customization id for translate (repeated)
- source: string, The source language of the text
-
-Returns:
- An object of the form:
-
- {
- "translations": [ # Translations contains list of translation results of given text
- {
- "detectedSourceLanguage": "A String", # Detected source language if source parameter is unspecified.
- "translatedText": "A String", # The translation.
- },
- ],
- }
-
Instance Methods
-
- url()
-
-Returns the url Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/urlshortener_v1.url.html b/docs/dyn/urlshortener_v1.url.html
deleted file mode 100644
index bb004fc..0000000
--- a/docs/dyn/urlshortener_v1.url.html
+++ /dev/null
@@ -1,739 +0,0 @@
-
-
-
-
-Instance Methods
-
- get(shortUrl, projection=None)
-Expands a short URL or gets creation time and analytics.
-
- insert(body)
-Creates a new short URL.
-
- list(start_token=None, projection=None)
-Retrieves a list of URLs shortened by a user.
-Method Details
-
-
get(shortUrl, projection=None)
-
Expands a short URL or gets creation time and analytics.
-
-Args:
- shortUrl: string, The short URL, including the protocol. (required)
- 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.
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for example.
- "kind": "urlshortener#url", # The fixed string "urlshortener#url".
- "created": "A String", # Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00".
- "analytics": { # A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable.
- "week": { # Click analytics over the last week.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "allTime": { # Click analytics over all time.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "twoHours": { # Click analytics over the last two hours.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "day": { # Click analytics over the last day.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "month": { # Click analytics over the last month.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- },
- "longUrl": "A String", # Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED".
- "id": "A String", # Short URL, e.g. "http://goo.gl/l6MS".
- }
-
-
insert(body)
-
Creates a new short URL.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "status": "A String", # Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for example.
- "kind": "urlshortener#url", # The fixed string "urlshortener#url".
- "created": "A String", # Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00".
- "analytics": { # A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable.
- "week": { # Click analytics over the last week.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "allTime": { # Click analytics over all time.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "twoHours": { # Click analytics over the last two hours.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "day": { # Click analytics over the last day.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "month": { # Click analytics over the last month.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- },
- "longUrl": "A String", # Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED".
- "id": "A String", # Short URL, e.g. "http://goo.gl/l6MS".
- }
-
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for example.
- "kind": "urlshortener#url", # The fixed string "urlshortener#url".
- "created": "A String", # Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00".
- "analytics": { # A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable.
- "week": { # Click analytics over the last week.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "allTime": { # Click analytics over all time.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "twoHours": { # Click analytics over the last two hours.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "day": { # Click analytics over the last day.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "month": { # Click analytics over the last month.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- },
- "longUrl": "A String", # Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED".
- "id": "A String", # Short URL, e.g. "http://goo.gl/l6MS".
- }
-
-
list(start_token=None, projection=None)
-
Retrieves a list of URLs shortened by a user.
-
-Args:
- start_token: string, Token for requesting successive pages of results.
- projection: string, Additional information to return.
- Allowed values
- ANALYTICS_CLICKS - Returns short URL click counts.
- FULL - Returns short URL click counts.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # A token to provide to get the next page of results.
- "items": [ # A list of URL resources.
- {
- "status": "A String", # Status of the target URL. Possible values: "OK", "MALWARE", "PHISHING", or "REMOVED". A URL might be marked "REMOVED" if it was flagged as spam, for example.
- "kind": "urlshortener#url", # The fixed string "urlshortener#url".
- "created": "A String", # Time the short URL was created; ISO 8601 representation using the yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g. "2010-10-14T19:01:24.944+00:00".
- "analytics": { # A summary of the click analytics for the short and long URL. Might not be present if not requested or currently unavailable.
- "week": { # Click analytics over the last week.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "allTime": { # Click analytics over all time.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "twoHours": { # Click analytics over the last two hours.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "day": { # Click analytics over the last day.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- "month": { # Click analytics over the last month.
- "shortUrlClicks": "A String", # Number of clicks on this short URL.
- "countries": [ # Top countries (expressed as country codes), e.g. "US" or "DE"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "platforms": [ # Top platforms or OSes, e.g. "Windows"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "browsers": [ # Top browsers, e.g. "Chrome"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "referrers": [ # Top referring hosts, e.g. "www.google.com"; sorted by (descending) click counts. Only present if this data is available.
- {
- "count": "A String", # Number of clicks for this top entry, e.g. for this particular country or browser.
- "id": "A String", # Label assigned to this top entry, e.g. "US" or "Chrome".
- },
- ],
- "longUrlClicks": "A String", # Number of clicks on all goo.gl short URLs pointing to this long URL.
- },
- },
- "longUrl": "A String", # Long URL, e.g. "http://www.google.com/". Might not be present if the status is "REMOVED".
- "id": "A String", # Short URL, e.g. "http://goo.gl/l6MS".
- },
- ],
- "kind": "urlshortener#urlHistory", # The fixed string "urlshortener#urlHistory".
- "itemsPerPage": 42, # Number of items returned with each full "page" of results. Note that the last page could have fewer items than the "itemsPerPage" value.
- "totalItems": 42, # Total number of short URLs associated with this user (may be approximate).
- }
-
Instance Methods
-
- stop(body)
-A description of how to use this function
-Method Details
-
-
stop(body)
-
A description of how to use this function
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
-
-
Instance Methods
-
- channels()
-
-Returns the channels Resource.
-
-
- items()
-
-Returns the items Resource.
-
-
- sessions()
-
-Returns the sessions Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/v1dev_v1dev.items.html b/docs/dyn/v1dev_v1dev.items.html
deleted file mode 100644
index f6c6908..0000000
--- a/docs/dyn/v1dev_v1dev.items.html
+++ /dev/null
@@ -1,333 +0,0 @@
-
-
-
-
-Instance Methods
-
- delete(sessionId, itemId)
-Deletes an item.
-
- get(sessionId, itemId)
-Gets one item by ID.
-
- insert(sessionId, body)
-Inserts a new item into this session.
-
- list(sessionId)
-Retrieves a list of items in a session.
-
- patch(sessionId, itemId, body)
-Updates an existing item. This method supports patch semantics.
-
- update(sessionId, itemId, body)
-Updates an existing item.
-
- watch(sessionId, body)
-Subscribe to changes to any item in a session.
-
- watchToOneItem(sessionId, itemId, body)
-Subscribe to changes to one item in a session.
-Method Details
-
-
delete(sessionId, itemId)
-
Deletes an item.
-
-Args:
- sessionId: string, The session ID. (required)
- itemId: string, The item ID. (required)
-
-
-
get(sessionId, itemId)
-
Gets one item by ID.
-
-Args:
- sessionId: string, The session ID. (required)
- itemId: string, The item ID. (required)
-
-Returns:
- An object of the form:
-
- {
- "blobOfData": "A String", # A blob of data stored in the item.
- "sizeInBytes": 42, # The size (in bytes) of the blob of data.
- "kind": "wax#waxDataItem", # The kind of object this is.
- "id": "A String", # The item ID.
- "name": "A String", # The name of the item.
- }
-
-
insert(sessionId, body)
-
Inserts a new item into this session.
-
-Args:
- sessionId: string, The session ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "blobOfData": "A String", # A blob of data stored in the item.
- "sizeInBytes": 42, # The size (in bytes) of the blob of data.
- "kind": "wax#waxDataItem", # The kind of object this is.
- "id": "A String", # The item ID.
- "name": "A String", # The name of the item.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "blobOfData": "A String", # A blob of data stored in the item.
- "sizeInBytes": 42, # The size (in bytes) of the blob of data.
- "kind": "wax#waxDataItem", # The kind of object this is.
- "id": "A String", # The item ID.
- "name": "A String", # The name of the item.
- }
-
-
list(sessionId)
-
Retrieves a list of items in a session.
-
-Args:
- sessionId: string, The session ID. (required)
-
-Returns:
- An object of the form:
-
- {
- "items": [ # The list of Wax items.
- {
- "blobOfData": "A String", # A blob of data stored in the item.
- "sizeInBytes": 42, # The size (in bytes) of the blob of data.
- "kind": "wax#waxDataItem", # The kind of object this is.
- "id": "A String", # The item ID.
- "name": "A String", # The name of the item.
- },
- ],
- "kind": "wax#waxList", # The kind of object this is.
- }
-
-
patch(sessionId, itemId, body)
-
Updates an existing item. This method supports patch semantics.
-
-Args:
- sessionId: string, The session ID. (required)
- itemId: string, The item ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "blobOfData": "A String", # A blob of data stored in the item.
- "sizeInBytes": 42, # The size (in bytes) of the blob of data.
- "kind": "wax#waxDataItem", # The kind of object this is.
- "id": "A String", # The item ID.
- "name": "A String", # The name of the item.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "blobOfData": "A String", # A blob of data stored in the item.
- "sizeInBytes": 42, # The size (in bytes) of the blob of data.
- "kind": "wax#waxDataItem", # The kind of object this is.
- "id": "A String", # The item ID.
- "name": "A String", # The name of the item.
- }
-
-
update(sessionId, itemId, body)
-
Updates an existing item.
-
-Args:
- sessionId: string, The session ID. (required)
- itemId: string, The item ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "blobOfData": "A String", # A blob of data stored in the item.
- "sizeInBytes": 42, # The size (in bytes) of the blob of data.
- "kind": "wax#waxDataItem", # The kind of object this is.
- "id": "A String", # The item ID.
- "name": "A String", # The name of the item.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "blobOfData": "A String", # A blob of data stored in the item.
- "sizeInBytes": 42, # The size (in bytes) of the blob of data.
- "kind": "wax#waxDataItem", # The kind of object this is.
- "id": "A String", # The item ID.
- "name": "A String", # The name of the item.
- }
-
-
watch(sessionId, body)
-
Subscribe to changes to any item in a session.
-
-Args:
- sessionId: string, The session ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
-
-Returns:
- An object of the form:
-
- {
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
-
watchToOneItem(sessionId, itemId, body)
-
Subscribe to changes to one item in a session.
-
-Args:
- sessionId: string, The session ID. (required)
- itemId: string, The item ID. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
-
-Returns:
- An object of the form:
-
- {
- "resourceUri": "A String", # The canonicalized ID of the watched resource.
- "kind": "api#channel", # A channel watching an API resource
- "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
- "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
- "params": { # Additional parameters controlling delivery channel behavior
- "a_key": "A String", # Declares a new parameter by name.
- },
- "expiration": "A String", # The expiration instant for this channel if it is defined.
- "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
- "type": "A String", # The type of delivery mechanism used by this channel
- "id": "A String", # A UUID for the channel
- }
-
Instance Methods
-
- create(body)
-Creates a new session. New sessions are initialized with two pre-defined items. Just like wax.sessions.newsession, but matches other implementations of Wax in Endpoints.
-
- newSession(body, sessionName=None)
-Creates a new session. New sessions are initialized with two pre-defined items.
-
- removeSession(body, sessionId=None)
-Removes a session. Clients that create sessions with long or infinite durations should call this method to clean up after themselves.
-Method Details
-
-
create(body)
-
Creates a new session. New sessions are initialized with two pre-defined items. Just like wax.sessions.newsession, but matches other implementations of Wax in Endpoints.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "sessionName": "A String", # Usually a short, human-readable name that describes a session. This name will appear as part of the session ID, which is generated by the API when the session is created.
- "durationInMillis": "A String", # Session duration in milliseconds.
- }
-
-
-Returns:
- An object of the form:
-
- {
- "newSessionId": "A String", # The session ID.
- "kind": "wax#waxNewSession", # The kind of object this is.
- }
-
-
newSession(body, sessionName=None)
-
Creates a new session. New sessions are initialized with two pre-defined items.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "newSessionParams": { # Parameters used when requesting a new session.
- "kind": "wax#waxNewSessionParams", # The kind of object this is.
- "durationInMillis": "A String", # Session duration in milliseconds.
- },
- "sessionName": "A String", # Usually a short, human-readable name that describes a session. This name will appear as part of the session ID, which is generated by the API when the session is created.
- }
-
- sessionName: string, Human-readable name that describes a session. This name will be part of the session ID.
-
-Returns:
- An object of the form:
-
- {
- "newSessionId": "A String", # The session ID.
- "kind": "wax#waxNewSession", # The kind of object this is.
- }
-
-
removeSession(body, sessionId=None)
-
Removes a session. Clients that create sessions with long or infinite durations should call this method to clean up after themselves.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "sessionId": "A String", # The ID corresponding to the session to be removed.
- }
-
- sessionId: string, The session ID.
-
-Returns:
- An object of the form:
-
- {
- "kind": "wax#waxRemoveSession", # The kind of object this is.
- "removedSessionId": "A String", # The ID corresponding to the session that was removed.
- }
-
Instance Methods
-
- webfonts()
-
-Returns the webfonts Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/webfonts_v1.webfonts.html b/docs/dyn/webfonts_v1.webfonts.html
deleted file mode 100644
index a4abc9e..0000000
--- a/docs/dyn/webfonts_v1.webfonts.html
+++ /dev/null
@@ -1,119 +0,0 @@
-
-
-
-
-Instance Methods
-
- list(sort=None)
-Retrieves the list of fonts currently served by the Google Fonts Developer API
-Method Details
-
-
list(sort=None)
-
Retrieves the list of fonts currently served by the Google Fonts Developer API
-
-Args:
- sort: string, Enables sorting of the list
- Allowed values
- alpha - Sort alphabetically
- date - Sort by date added
- popularity - Sort by popularity
- style - Sort by number of styles
- trending - Sort by trending
-
-Returns:
- An object of the form:
-
- {
- "items": [ # The list of fonts currently served by the Google Fonts API.
- {
- "files": { # The font files (with all supported scripts) for each one of the available variants, as a key : value map.
- "a_key": "A String", # The font file URL (value) for an specific variant (key).
- },
- "kind": "webfonts#webfont", # This kind represents a webfont object in the webfonts service.
- "family": "A String", # The name of the font.
- "subsets": [ # The scripts supported by the font.
- "A String",
- ],
- "lastModified": "A String", # The date (format "yyyy-MM-dd") the font was modified for the last time.
- "version": "A String", # The font version.
- "variants": [ # The available variants for the font.
- "A String",
- ],
- },
- ],
- "kind": "webfonts#webfontList", # This kind represents a list of webfont objects in the webfonts service.
- }
-
Instance Methods
-
- reports()
-
-Returns the reports Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/youtubeAnalytics_v1.reports.html b/docs/dyn/youtubeAnalytics_v1.reports.html
deleted file mode 100644
index d389b5b..0000000
--- a/docs/dyn/youtubeAnalytics_v1.reports.html
+++ /dev/null
@@ -1,118 +0,0 @@
-
-
-
-
-Instance Methods
-
- query(ids=None, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)
-Retrieve your YouTube Analytics reports.
-Method Details
-
-
query(ids=None, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)
-
Retrieve your YouTube Analytics reports.
-
-Args:
- ids: string, Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data.
-- To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID.
-- To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner. (required)
- start_date: string, The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. (required)
- end_date: string, The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format. (required)
- metrics: string, A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics. (required)
- sort: string, A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '-' prefix causes descending sort order.
- dimensions: string, A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions.
- filters: string, A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts the result set to include data for the given video in Italy.
- max_results: integer, The maximum number of rows to include in the response.
- start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).
-
-Returns:
- An object of the form:
-
- { # Contains a single result table. The table is returned as an array of rows that contain the values for the cells of the table. Depending on the metric or dimension, the cell can contain a string (video ID, country code) or a number (number of views or number of likes).
- "kind": "youtubeAnalytics#resultTable", # This value specifies the type of data included in the API response. For the query method, the kind property value will be youtubeAnalytics#resultTable.
- "rows": [ # The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the columnHeaders field. If no data is available for the given query, the rows element will be omitted from the response. The response for a query with the day dimension will not contain rows for the most recent days.
- [
- "",
- ],
- ],
- "columnHeaders": [ # This value specifies information about the data returned in the rows fields. Each item in the columnHeaders list identifies a field returned in the rows value, which contains a list of comma-delimited data. The columnHeaders list will begin with the dimensions specified in the API request, which will be followed by the metrics specified in the API request. The order of both dimensions and metrics will match the ordering in the API request. For example, if the API request contains the parameters dimensions=ageGroup,gender&metrics=viewerPercentage, the API response will return columns in this order: ageGroup,gender,viewerPercentage.
- {
- "dataType": "A String", # The type of the data in the column (STRING, INTEGER, FLOAT, etc.).
- "columnType": "A String", # The type of the column (DIMENSION or METRIC).
- "name": "A String", # The name of the dimension or metric.
- },
- ],
- }
-
Instance Methods
-
- insert(part=None, body)
-Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.)
-
- list(part=None, pageToken=None, publishedBefore=None, channelId=None, mine=None, maxResults=None, regionCode=None, home=None, publishedAfter=None)
-Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-Method Details
-
-
insert(part=None, body)
-
Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.)
-
-Args:
- part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
-
-The part names that you can include in the parameter value are snippet and contentDetails. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An activity resource contains information about an action that a particular channel, or user, has taken on YouTube.The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.
- "snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. # The snippet object contains basic details about the activity, including the activity's type and group ID.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the resource that is primarily associated with the activity. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- "title": "A String", # The title of the resource primarily associated with the activity.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated with the activity.
- "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "channelTitle": "A String", # Channel title for the channel responsible for this activity
- "type": "A String", # The type of activity that the resource describes.
- "groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value.
- "description": "A String", # The description of the resource primarily associated with the activity.
- },
- "contentDetails": { # Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc. # The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video.
- "comment": { # Information about a resource that received a comment. # The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with the comment.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "playlistItem": { # Information about a new playlist item. # The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information about the resource that was added to the playlist.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "playlistId": "A String", # The value that YouTube uses to uniquely identify the playlist.
- "playlistItemId": "A String", # ID of the item within the playlist.
- },
- "like": { # Information about a resource that received a positive (like) rating. # The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the rated resource.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "promotedItem": { # Details about a resource which is being promoted. # The promotedItem object contains details about a resource which is being promoted. This property is only present if the snippet.type is promotedItem.
- "ctaType": "A String", # The type of call-to-action, a message to the user indicating action that can be taken.
- "adTag": "A String", # The URL the client should fetch to request a promoted item.
- "destinationUrl": "A String", # The URL the client should direct the user to, if the user chooses to visit the advertiser's website.
- "creativeViewUrl": "A String", # The URL the client should ping to indicate that the user was shown this promoted item.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the promoted video.
- "descriptionText": "A String", # The text description to accompany the promoted item.
- "clickTrackingUrl": "A String", # The URL the client should ping to indicate that the user clicked through on this promoted item.
- },
- "social": { # Details about a social network post. # The social object contains details about a social network post. This property is only present if the snippet.type is social.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object encapsulates information that identifies the resource associated with a social network post.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "imageUrl": "A String", # An image of the post's author.
- "type": "A String", # The name of the social network.
- "referenceUrl": "A String", # The URL of the social network post.
- "author": "A String", # The author of the social network post.
- },
- "favorite": { # Information about a video that was marked as a favorite video. # The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was marked as a favorite.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "upload": { # Information about the uploaded video. # The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the uploaded video.
- },
- "recommendation": { # Information that identifies the recommended resource. # The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the recommended resource.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "reason": "A String", # The reason that the resource is recommended to the user.
- "seedResourceId": { # A resource id is a generic reference that points to another YouTube resource. # The seedResourceId object contains information about the resource that caused the recommendation.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "subscription": { # Information about a channel that a user subscribed to. # The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that the user subscribed to.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "bulletin": { # Details about a channel bulletin post. # The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with a bulletin post.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "channelItem": { # Details about a resource which was added to a channel. # The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was added to the channel.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- },
- "kind": "youtube#activity", # The kind, fixed to "youtube#activity".
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the activity.
- }
-
-
-Returns:
- An object of the form:
-
- { # An activity resource contains information about an action that a particular channel, or user, has taken on YouTube.The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.
- "snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. # The snippet object contains basic details about the activity, including the activity's type and group ID.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the resource that is primarily associated with the activity. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- "title": "A String", # The title of the resource primarily associated with the activity.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated with the activity.
- "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "channelTitle": "A String", # Channel title for the channel responsible for this activity
- "type": "A String", # The type of activity that the resource describes.
- "groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value.
- "description": "A String", # The description of the resource primarily associated with the activity.
- },
- "contentDetails": { # Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc. # The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video.
- "comment": { # Information about a resource that received a comment. # The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with the comment.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "playlistItem": { # Information about a new playlist item. # The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information about the resource that was added to the playlist.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "playlistId": "A String", # The value that YouTube uses to uniquely identify the playlist.
- "playlistItemId": "A String", # ID of the item within the playlist.
- },
- "like": { # Information about a resource that received a positive (like) rating. # The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the rated resource.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "promotedItem": { # Details about a resource which is being promoted. # The promotedItem object contains details about a resource which is being promoted. This property is only present if the snippet.type is promotedItem.
- "ctaType": "A String", # The type of call-to-action, a message to the user indicating action that can be taken.
- "adTag": "A String", # The URL the client should fetch to request a promoted item.
- "destinationUrl": "A String", # The URL the client should direct the user to, if the user chooses to visit the advertiser's website.
- "creativeViewUrl": "A String", # The URL the client should ping to indicate that the user was shown this promoted item.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the promoted video.
- "descriptionText": "A String", # The text description to accompany the promoted item.
- "clickTrackingUrl": "A String", # The URL the client should ping to indicate that the user clicked through on this promoted item.
- },
- "social": { # Details about a social network post. # The social object contains details about a social network post. This property is only present if the snippet.type is social.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object encapsulates information that identifies the resource associated with a social network post.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "imageUrl": "A String", # An image of the post's author.
- "type": "A String", # The name of the social network.
- "referenceUrl": "A String", # The URL of the social network post.
- "author": "A String", # The author of the social network post.
- },
- "favorite": { # Information about a video that was marked as a favorite video. # The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was marked as a favorite.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "upload": { # Information about the uploaded video. # The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the uploaded video.
- },
- "recommendation": { # Information that identifies the recommended resource. # The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the recommended resource.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "reason": "A String", # The reason that the resource is recommended to the user.
- "seedResourceId": { # A resource id is a generic reference that points to another YouTube resource. # The seedResourceId object contains information about the resource that caused the recommendation.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "subscription": { # Information about a channel that a user subscribed to. # The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that the user subscribed to.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "bulletin": { # Details about a channel bulletin post. # The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with a bulletin post.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "channelItem": { # Details about a resource which was added to a channel. # The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was added to the channel.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- },
- "kind": "youtube#activity", # The kind, fixed to "youtube#activity".
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the activity.
- }
-
-
list(part=None, pageToken=None, publishedBefore=None, channelId=None, mine=None, maxResults=None, regionCode=None, home=None, publishedAfter=None)
-
Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user.
-
-Args:
- part: string, The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails.
-
-If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties. (required)
- pageToken: string, USE_DESCRIPTION --- channels:list:pageToken
- publishedBefore: string, The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- channelId: string, The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.
- mine: boolean, Set this parameter's value to true to retrieve a feed of the authenticated user's activities.
- maxResults: integer, USE_DESCRIPTION --- channels:list:maxResults
- regionCode: string, The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.
- home: boolean, Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user.
- publishedAfter: string, The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
-
-Returns:
- An object of the form:
-
- { # A paginated list of activities returned as a response to youtube.activities.list calls.
- "eventId": "A String", # Serialized EventId of the request which produced this response.
- "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
- "kind": "youtube#activityListResponse", # The type of the API response. For this operation, the value will be youtube#activityListResponse.
- "visitorId": "A String", # The visitorId identifies the visitor.
- "items": [ # A list of activities, or events, that match the request criteria.
- { # An activity resource contains information about an action that a particular channel, or user, has taken on YouTube.The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.
- "snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. # The snippet object contains basic details about the activity, including the activity's type and group ID.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the resource that is primarily associated with the activity. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- "title": "A String", # The title of the resource primarily associated with the activity.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated with the activity.
- "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "channelTitle": "A String", # Channel title for the channel responsible for this activity
- "type": "A String", # The type of activity that the resource describes.
- "groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value.
- "description": "A String", # The description of the resource primarily associated with the activity.
- },
- "contentDetails": { # Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc. # The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video.
- "comment": { # Information about a resource that received a comment. # The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with the comment.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "playlistItem": { # Information about a new playlist item. # The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information about the resource that was added to the playlist.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "playlistId": "A String", # The value that YouTube uses to uniquely identify the playlist.
- "playlistItemId": "A String", # ID of the item within the playlist.
- },
- "like": { # Information about a resource that received a positive (like) rating. # The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the rated resource.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "promotedItem": { # Details about a resource which is being promoted. # The promotedItem object contains details about a resource which is being promoted. This property is only present if the snippet.type is promotedItem.
- "ctaType": "A String", # The type of call-to-action, a message to the user indicating action that can be taken.
- "adTag": "A String", # The URL the client should fetch to request a promoted item.
- "destinationUrl": "A String", # The URL the client should direct the user to, if the user chooses to visit the advertiser's website.
- "creativeViewUrl": "A String", # The URL the client should ping to indicate that the user was shown this promoted item.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the promoted video.
- "descriptionText": "A String", # The text description to accompany the promoted item.
- "clickTrackingUrl": "A String", # The URL the client should ping to indicate that the user clicked through on this promoted item.
- },
- "social": { # Details about a social network post. # The social object contains details about a social network post. This property is only present if the snippet.type is social.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object encapsulates information that identifies the resource associated with a social network post.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "imageUrl": "A String", # An image of the post's author.
- "type": "A String", # The name of the social network.
- "referenceUrl": "A String", # The URL of the social network post.
- "author": "A String", # The author of the social network post.
- },
- "favorite": { # Information about a video that was marked as a favorite video. # The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was marked as a favorite.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "upload": { # Information about the uploaded video. # The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the uploaded video.
- },
- "recommendation": { # Information that identifies the recommended resource. # The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the recommended resource.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "reason": "A String", # The reason that the resource is recommended to the user.
- "seedResourceId": { # A resource id is a generic reference that points to another YouTube resource. # The seedResourceId object contains information about the resource that caused the recommendation.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "subscription": { # Information about a channel that a user subscribed to. # The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that the user subscribed to.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "bulletin": { # Details about a channel bulletin post. # The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with a bulletin post.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- "channelItem": { # Details about a resource which was added to a channel. # The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was added to the channel.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- },
- },
- "kind": "youtube#activity", # The kind, fixed to "youtube#activity".
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the activity.
- },
- ],
- "etag": "A String", # The ETag of the response.
- "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
- "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the result set.
- "totalResults": 42, # The total number of results in the result set.
- "resultsPerPage": 42, # The number of results included in the API response.
- },
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
Instance Methods
-
- insert(body=None, media_body=None, onBehalfOfContentOwner=None)
-Uploads a channel banner to YouTube.
-Method Details
-
-
insert(body=None, media_body=None, onBehalfOfContentOwner=None)
-
Uploads a channel banner to YouTube.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{ # A channel banner returned as the response to a channel_banner.insert call.
- "url": "A String", # The URL of this banner image.
- "kind": "youtube#channelBannerResource", # The kind, fixed to "youtube#channelBannerResource".
- "etag": "A String", # Etag of this resource.
- }
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
-
-Returns:
- An object of the form:
-
- { # A channel banner returned as the response to a channel_banner.insert call.
- "url": "A String", # The URL of this banner image.
- "kind": "youtube#channelBannerResource", # The kind, fixed to "youtube#channelBannerResource".
- "etag": "A String", # Etag of this resource.
- }
-
Instance Methods
-
- list(part=None, managedByMe=None, onBehalfOfContentOwner=None, forUsername=None, pageToken=None, categoryId=None, maxResults=None, mine=None, mySubscribers=None, id=None)
-Returns a collection of zero or more channel resources that match the request criteria.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- update(part=None, body, onBehalfOfContentOwner=None)
-Updates a channel's metadata.
-Method Details
-
-
list(part=None, managedByMe=None, onBehalfOfContentOwner=None, forUsername=None, pageToken=None, categoryId=None, maxResults=None, mine=None, mySubscribers=None, id=None)
-
Returns a collection of zero or more channel resources that match the request criteria.
-
-Args:
- part: string, The part parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, statistics, topicDetails, and invideoPromotion.
-
-If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties. (required)
- managedByMe: boolean, Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.
- onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.
- forUsername: string, The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username.
- pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
- categoryId: string, The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category.
- maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
- mine: boolean, Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.
- mySubscribers: boolean, Set this parameter's value to true to retrieve a list of channels that subscribed to the authenticated user's channel.
- id: string, The id parameter specifies a comma-separated list of the YouTube channel ID(s) for the resource(s) that are being retrieved. In a channel resource, the id property specifies the channel's YouTube channel ID.
-
-Returns:
- An object of the form:
-
- { # A paginated list of channels returned as the response to a youtube.channels.list call.
- "eventId": "A String", # Serialized EventId of the request which produced this response.
- "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
- "kind": "youtube#channelListResponse", # The type of the API response. For this operation, the value will be youtube#channelListResponse.
- "visitorId": "A String", # The visitorId identifies the visitor.
- "items": [ # A list of channels that match the request criteria.
- { # A channel resource contains information about a YouTube channel.
- "status": { # JSON template for the status part of a channel. # The status object encapsulates information about the privacy status of the channel.
- "privacyStatus": "A String", # Privacy status of the channel.
- "isLinked": True or False, # If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity.
- },
- "invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id. # The invideoPromotion object encapsulates information about promotion campaign associated with the channel.
- "defaultTiming": { # Describes a temporal position of a visual widget inside a video. # The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item.
- "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
- "type": "A String", # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
- "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
- },
- "items": [ # List of promoted items in decreasing priority.
- { # Describes a single promoted item.
- "timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.
- "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
- "type": "A String", # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
- "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
- },
- "customMessage": "A String", # A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.
- "id": { # Describes a single promoted item id. It is a union of various possible types. # Identifies the promoted item.
- "websiteUrl": "A String", # If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website.
- "type": "A String", # Describes the type of the promoted item.
- "videoId": "A String", # If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video.
- },
- },
- ],
- "position": { # Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one. # The spatial position within the video where the promoted item will be displayed.
- "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear.
- "type": "A String", # Defines the position type.
- },
- },
- "kind": "youtube#channel", # The kind, fixed to "youtube#channel".
- "statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.
- "commentCount": "A String", # The number of comments for the channel.
- "subscriberCount": "A String", # The number of subscribers that the channel has.
- "videoCount": "A String", # The number of videos uploaded to the channel.
- "viewCount": "A String", # The number of times the channel has been viewed.
- },
- "topicDetails": { # Freebase topic information related to the channel. # The topicDetails object encapsulates information about Freebase topics associated with the channel.
- "topicIds": [ # A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.
- "A String",
- ],
- },
- "contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.
- "relatedPlaylists": {
- "watchLater": "A String", # The ID of the playlist that contains the channel"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
- "watchHistory": "A String", # The ID of the playlist that contains the channel"s watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
- "likes": "A String", # The ID of the playlist that contains the channel"s liked videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
- "favorites": "A String", # The ID of the playlist that contains the channel"s favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
- "uploads": "A String", # The ID of the playlist that contains the channel"s uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos.
- },
- "googlePlusUserId": "A String", # The googlePlusUserId object identifies the Google+ profile ID associated with this channel.
- },
- "brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.
- "image": { # Branding properties for images associated with the channel. # Branding properties for branding images.
- "largeBrandedBannerImageUrl": { # Represent a property available in different languages. # The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).
- "backgroundImageUrl": { # Represent a property available in different languages. # The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "largeBrandedBannerImageImapScript": { # Represent a property available in different languages. # The image map script for the large banner image.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).
- "smallBrandedBannerImageImapScript": { # Represent a property available in different languages. # The image map script for the small banner image.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "smallBrandedBannerImageUrl": { # Represent a property available in different languages. # The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).
- "bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).
- "trackingImageUrl": "A String", # The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.
- "bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).
- "bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).
- "bannerExternalUrl": "A String", # This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs.
- "bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).
- "bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).
- "bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).
- "watchIconImageUrl": "A String", # The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels.
- "bannerTvImageUrl": "A String", # Banner image. TV size (2120x1192).
- "bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).
- },
- "watch": { # Branding properties for the watch. # Branding properties for the watch page.
- "textColor": "A String", # The background color for the video watch page's branded area.
- "featuredPlaylistId": "A String", # An ID that uniquely identifies a playlist that displays next to the video player.
- "backgroundColor": "A String", # The text color for the video watch page's branded area.
- },
- "channel": { # Branding properties for the channel view. # Branding properties for the channel view.
- "description": "A String", # Specifies the channel description.
- "title": "A String", # Specifies the channel title.
- "moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
- "showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
- "featuredChannelsTitle": "A String", # Title for the featured channels tab.
- "unsubscribedTrailer": "A String", # The trailer of the channel, for users that are not subscribers.
- "keywords": "A String", # Lists keywords associated with the channel, comma-separated.
- "profileColor": "A String", # A prominent color that can be rendered on this channel page.
- "defaultTab": "A String", # Which content tab users should see when viewing the channel.
- "featuredChannelsUrls": [ # The list of featured channels.
- "A String",
- ],
- "trackingAnalyticsAccountId": "A String", # The ID for a Google Analytics account to track and measure traffic to the channels.
- "showRelatedChannels": True or False, # Whether related channels should be proposed.
- },
- "hints": [ # Additional experimental branding properties.
- { # A pair Property / Value.
- "property": "A String", # A property.
- "value": "A String", # The property's value.
- },
- ],
- },
- "conversionPings": { # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.
- "pings": [ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
- { # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
- "conversionUrl": "A String", # The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.
- "context": "A String", # Defines the context of the ping.
- },
- ],
- },
- "snippet": { # Basic details about a channel, including title, description and thumbnails. # The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.
- "title": "A String", # The channel's title.
- "description": "A String", # The description of the channel.
- "publishedAt": "A String", # The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the channel.
- },
- ],
- "etag": "A String", # The ETag for the response.
- "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
- "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the result set.
- "totalResults": 42, # The total number of results in the result set.
- "resultsPerPage": 42, # The number of results included in the API response.
- },
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
update(part=None, body, onBehalfOfContentOwner=None)
-
Updates a channel's metadata.
-
-Args:
- part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
-
-The part names that you can include in the parameter value are id and invideoPromotion.
-
-Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A channel resource contains information about a YouTube channel.
- "status": { # JSON template for the status part of a channel. # The status object encapsulates information about the privacy status of the channel.
- "privacyStatus": "A String", # Privacy status of the channel.
- "isLinked": True or False, # If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity.
- },
- "invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id. # The invideoPromotion object encapsulates information about promotion campaign associated with the channel.
- "defaultTiming": { # Describes a temporal position of a visual widget inside a video. # The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item.
- "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
- "type": "A String", # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
- "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
- },
- "items": [ # List of promoted items in decreasing priority.
- { # Describes a single promoted item.
- "timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.
- "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
- "type": "A String", # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
- "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
- },
- "customMessage": "A String", # A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.
- "id": { # Describes a single promoted item id. It is a union of various possible types. # Identifies the promoted item.
- "websiteUrl": "A String", # If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website.
- "type": "A String", # Describes the type of the promoted item.
- "videoId": "A String", # If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video.
- },
- },
- ],
- "position": { # Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one. # The spatial position within the video where the promoted item will be displayed.
- "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear.
- "type": "A String", # Defines the position type.
- },
- },
- "kind": "youtube#channel", # The kind, fixed to "youtube#channel".
- "statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.
- "commentCount": "A String", # The number of comments for the channel.
- "subscriberCount": "A String", # The number of subscribers that the channel has.
- "videoCount": "A String", # The number of videos uploaded to the channel.
- "viewCount": "A String", # The number of times the channel has been viewed.
- },
- "topicDetails": { # Freebase topic information related to the channel. # The topicDetails object encapsulates information about Freebase topics associated with the channel.
- "topicIds": [ # A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.
- "A String",
- ],
- },
- "contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.
- "relatedPlaylists": {
- "watchLater": "A String", # The ID of the playlist that contains the channel"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
- "watchHistory": "A String", # The ID of the playlist that contains the channel"s watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
- "likes": "A String", # The ID of the playlist that contains the channel"s liked videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
- "favorites": "A String", # The ID of the playlist that contains the channel"s favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
- "uploads": "A String", # The ID of the playlist that contains the channel"s uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos.
- },
- "googlePlusUserId": "A String", # The googlePlusUserId object identifies the Google+ profile ID associated with this channel.
- },
- "brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.
- "image": { # Branding properties for images associated with the channel. # Branding properties for branding images.
- "largeBrandedBannerImageUrl": { # Represent a property available in different languages. # The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).
- "backgroundImageUrl": { # Represent a property available in different languages. # The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "largeBrandedBannerImageImapScript": { # Represent a property available in different languages. # The image map script for the large banner image.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).
- "smallBrandedBannerImageImapScript": { # Represent a property available in different languages. # The image map script for the small banner image.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "smallBrandedBannerImageUrl": { # Represent a property available in different languages. # The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).
- "bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).
- "trackingImageUrl": "A String", # The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.
- "bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).
- "bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).
- "bannerExternalUrl": "A String", # This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs.
- "bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).
- "bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).
- "bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).
- "watchIconImageUrl": "A String", # The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels.
- "bannerTvImageUrl": "A String", # Banner image. TV size (2120x1192).
- "bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).
- },
- "watch": { # Branding properties for the watch. # Branding properties for the watch page.
- "textColor": "A String", # The background color for the video watch page's branded area.
- "featuredPlaylistId": "A String", # An ID that uniquely identifies a playlist that displays next to the video player.
- "backgroundColor": "A String", # The text color for the video watch page's branded area.
- },
- "channel": { # Branding properties for the channel view. # Branding properties for the channel view.
- "description": "A String", # Specifies the channel description.
- "title": "A String", # Specifies the channel title.
- "moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
- "showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
- "featuredChannelsTitle": "A String", # Title for the featured channels tab.
- "unsubscribedTrailer": "A String", # The trailer of the channel, for users that are not subscribers.
- "keywords": "A String", # Lists keywords associated with the channel, comma-separated.
- "profileColor": "A String", # A prominent color that can be rendered on this channel page.
- "defaultTab": "A String", # Which content tab users should see when viewing the channel.
- "featuredChannelsUrls": [ # The list of featured channels.
- "A String",
- ],
- "trackingAnalyticsAccountId": "A String", # The ID for a Google Analytics account to track and measure traffic to the channels.
- "showRelatedChannels": True or False, # Whether related channels should be proposed.
- },
- "hints": [ # Additional experimental branding properties.
- { # A pair Property / Value.
- "property": "A String", # A property.
- "value": "A String", # The property's value.
- },
- ],
- },
- "conversionPings": { # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.
- "pings": [ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
- { # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
- "conversionUrl": "A String", # The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.
- "context": "A String", # Defines the context of the ping.
- },
- ],
- },
- "snippet": { # Basic details about a channel, including title, description and thumbnails. # The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.
- "title": "A String", # The channel's title.
- "description": "A String", # The description of the channel.
- "publishedAt": "A String", # The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the channel.
-}
-
- onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.
-
-Returns:
- An object of the form:
-
- { # A channel resource contains information about a YouTube channel.
- "status": { # JSON template for the status part of a channel. # The status object encapsulates information about the privacy status of the channel.
- "privacyStatus": "A String", # Privacy status of the channel.
- "isLinked": True or False, # If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity.
- },
- "invideoPromotion": { # Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id. # The invideoPromotion object encapsulates information about promotion campaign associated with the channel.
- "defaultTiming": { # Describes a temporal position of a visual widget inside a video. # The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item.
- "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
- "type": "A String", # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
- "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
- },
- "items": [ # List of promoted items in decreasing priority.
- { # Describes a single promoted item.
- "timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.
- "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
- "type": "A String", # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
- "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
- },
- "customMessage": "A String", # A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.
- "id": { # Describes a single promoted item id. It is a union of various possible types. # Identifies the promoted item.
- "websiteUrl": "A String", # If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website.
- "type": "A String", # Describes the type of the promoted item.
- "videoId": "A String", # If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video.
- },
- },
- ],
- "position": { # Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one. # The spatial position within the video where the promoted item will be displayed.
- "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear.
- "type": "A String", # Defines the position type.
- },
- },
- "kind": "youtube#channel", # The kind, fixed to "youtube#channel".
- "statistics": { # Statistics about a channel: number of subscribers, number of videos in the channel, etc. # The statistics object encapsulates statistics for the channel.
- "commentCount": "A String", # The number of comments for the channel.
- "subscriberCount": "A String", # The number of subscribers that the channel has.
- "videoCount": "A String", # The number of videos uploaded to the channel.
- "viewCount": "A String", # The number of times the channel has been viewed.
- },
- "topicDetails": { # Freebase topic information related to the channel. # The topicDetails object encapsulates information about Freebase topics associated with the channel.
- "topicIds": [ # A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.
- "A String",
- ],
- },
- "contentDetails": { # Details about the content of a channel. # The contentDetails object encapsulates information about the channel's content.
- "relatedPlaylists": {
- "watchLater": "A String", # The ID of the playlist that contains the channel"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
- "watchHistory": "A String", # The ID of the playlist that contains the channel"s watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
- "likes": "A String", # The ID of the playlist that contains the channel"s liked videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
- "favorites": "A String", # The ID of the playlist that contains the channel"s favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.
- "uploads": "A String", # The ID of the playlist that contains the channel"s uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos.
- },
- "googlePlusUserId": "A String", # The googlePlusUserId object identifies the Google+ profile ID associated with this channel.
- },
- "brandingSettings": { # Branding properties of a YouTube channel. # The brandingSettings object encapsulates information about the branding of the channel.
- "image": { # Branding properties for images associated with the channel. # Branding properties for branding images.
- "largeBrandedBannerImageUrl": { # Represent a property available in different languages. # The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "bannerImageUrl": "A String", # Banner image. Desktop size (1060x175).
- "backgroundImageUrl": { # Represent a property available in different languages. # The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "largeBrandedBannerImageImapScript": { # Represent a property available in different languages. # The image map script for the large banner image.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "bannerMobileImageUrl": "A String", # Banner image. Mobile size (640x175).
- "smallBrandedBannerImageImapScript": { # Represent a property available in different languages. # The image map script for the small banner image.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "smallBrandedBannerImageUrl": { # Represent a property available in different languages. # The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page.
- "default": "A String", # Default value for the localized property.
- "localized": [ # The localized values.
- { # A localized string.
- "value": "A String", # Value of the property.
- "language": "A String", # Language associated to this value.
- },
- ],
- },
- "bannerTabletHdImageUrl": "A String", # Banner image. Tablet size high resolution (2276x377).
- "bannerTabletLowImageUrl": "A String", # Banner image. Tablet size low resolution (1138x188).
- "trackingImageUrl": "A String", # The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.
- "bannerMobileMediumHdImageUrl": "A String", # Banner image. Mobile size medium/high resolution (960x263).
- "bannerMobileHdImageUrl": "A String", # Banner image. Mobile size high resolution (1280x360).
- "bannerExternalUrl": "A String", # This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs.
- "bannerTabletImageUrl": "A String", # Banner image. Tablet size (1707x283).
- "bannerMobileExtraHdImageUrl": "A String", # Banner image. Mobile size high resolution (1440x395).
- "bannerMobileLowImageUrl": "A String", # Banner image. Mobile size low resolution (320x88).
- "watchIconImageUrl": "A String", # The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels.
- "bannerTvImageUrl": "A String", # Banner image. TV size (2120x1192).
- "bannerTabletExtraHdImageUrl": "A String", # Banner image. Tablet size extra high resolution (2560x424).
- },
- "watch": { # Branding properties for the watch. # Branding properties for the watch page.
- "textColor": "A String", # The background color for the video watch page's branded area.
- "featuredPlaylistId": "A String", # An ID that uniquely identifies a playlist that displays next to the video player.
- "backgroundColor": "A String", # The text color for the video watch page's branded area.
- },
- "channel": { # Branding properties for the channel view. # Branding properties for the channel view.
- "description": "A String", # Specifies the channel description.
- "title": "A String", # Specifies the channel title.
- "moderateComments": True or False, # Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.
- "showBrowseView": True or False, # Whether the tab to browse the videos should be displayed.
- "featuredChannelsTitle": "A String", # Title for the featured channels tab.
- "unsubscribedTrailer": "A String", # The trailer of the channel, for users that are not subscribers.
- "keywords": "A String", # Lists keywords associated with the channel, comma-separated.
- "profileColor": "A String", # A prominent color that can be rendered on this channel page.
- "defaultTab": "A String", # Which content tab users should see when viewing the channel.
- "featuredChannelsUrls": [ # The list of featured channels.
- "A String",
- ],
- "trackingAnalyticsAccountId": "A String", # The ID for a Google Analytics account to track and measure traffic to the channels.
- "showRelatedChannels": True or False, # Whether related channels should be proposed.
- },
- "hints": [ # Additional experimental branding properties.
- { # A pair Property / Value.
- "property": "A String", # A property.
- "value": "A String", # The property's value.
- },
- ],
- },
- "conversionPings": { # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel. # The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.
- "pings": [ # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
- { # Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
- "conversionUrl": "A String", # The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.
- "context": "A String", # Defines the context of the ping.
- },
- ],
- },
- "snippet": { # Basic details about a channel, including title, description and thumbnails. # The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.
- "title": "A String", # The channel's title.
- "description": "A String", # The description of the channel.
- "publishedAt": "A String", # The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the channel.
- }
-
Instance Methods
-
- list(part=None, regionCode=None, hl=None, id=None)
-Returns a list of categories that can be associated with YouTube channels.
-Method Details
-
-
list(part=None, regionCode=None, hl=None, id=None)
-
Returns a list of categories that can be associated with YouTube channels.
-
-Args:
- part: string, The part parameter specifies a comma-separated list of one or more guideCategory resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet.
-
-If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a guideCategory resource, the snippet property contains other properties, such as the category's title. If you set part=snippet, the API response will also contain all of those nested properties. (required)
- regionCode: string, The regionCode parameter instructs the API to return the list of guide categories available in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.
- hl: string, The hl parameter specifies the language that will be used for text values in the API response.
- id: string, The id parameter specifies a comma-separated list of the YouTube channel category ID(s) for the resource(s) that are being retrieved. In a guideCategory resource, the id property specifies the YouTube channel category ID.
-
-Returns:
- An object of the form:
-
- { # A paginated list of guide categories returned as the response to a youtube.guideCategories.list call.
- "eventId": "A String", # Serialized EventId of the request which produced this response.
- "items": [ # A list of categories that can be associated with YouTube channels. In this map, the category ID is the map key, and its value is the corresponding guideCategory resource.
- { # A guideCategory resource identifies a category that YouTube algorithmically assigns based on a channel's content or other indicators, such as the channel's popularity. The list is similar to video categories, with the difference being that a video's uploader can assign a video category but only YouTube can assign a channel category.
- "snippet": { # Basic details about a guide category. # The snippet object contains basic details about the category, such as its title.
- "channelId": "UCBR8-60-B28hp2BmDPdntcQ",
- "title": "A String", # Description of the guide category.
- },
- "kind": "youtube#guideCategory", # The kind, fixed to "youtube#guideCategory".
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the guide category.
- },
- ],
- "kind": "youtube#guideCategoryListResponse", # The type of the API response. For this operation, the value will be youtube#guideCategoryListResponse.
- "etag": "A String", # The ETag of the response.
- "visitorId": "A String", # The visitorId identifies the visitor.
- }
-
Instance Methods
-
- activities()
-
-Returns the activities Resource.
-
-
- channelBanners()
-
-Returns the channelBanners Resource.
-
-
- channels()
-
-Returns the channels Resource.
-
-
- guideCategories()
-
-Returns the guideCategories Resource.
-
-
- liveBroadcasts()
-
-Returns the liveBroadcasts Resource.
-
-
- liveStreams()
-
-Returns the liveStreams Resource.
-
-
- playlistItems()
-
-Returns the playlistItems Resource.
-
-
- playlists()
-
-Returns the playlists Resource.
-
-
- search()
-
-Returns the search Resource.
-
-
- subscriptions()
-
-Returns the subscriptions Resource.
-
-
- thumbnails()
-
-Returns the thumbnails Resource.
-
-
- videoCategories()
-
-Returns the videoCategories Resource.
-
-
- videos()
-
-Returns the videos Resource.
-
-
\ No newline at end of file
diff --git a/docs/dyn/youtube_v3.liveBroadcasts.html b/docs/dyn/youtube_v3.liveBroadcasts.html
deleted file mode 100644
index 143e8a0..0000000
--- a/docs/dyn/youtube_v3.liveBroadcasts.html
+++ /dev/null
@@ -1,836 +0,0 @@
-
-
-
-
-Instance Methods
-
- bind(id, part, onBehalfOfContentOwner=None, streamId=None)
-Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream.
-
- control(id, part, onBehalfOfContentOwner=None, displaySlate=None, offsetTimeMs=None)
-Control the slate of the broadacast.
-
- delete(id, onBehalfOfContentOwner=None)
-Deletes a broadcast.
-
- insert(part=None, body, onBehalfOfContentOwner=None)
-Creates a broadcast.
-
- list(part, broadcastStatus=None, pageToken=None, mine=None, maxResults=None, id=None)
-Returns a list of YouTube broadcasts that match the API request parameters.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- transition(broadcastStatus, id, part, onBehalfOfContentOwner=None)
-Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream.
-
- update(part=None, body, onBehalfOfContentOwner=None)
-Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.
-Method Details
-
-
bind(id, part, onBehalfOfContentOwner=None, streamId=None)
-
Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream.
-
-Args:
- id: string, The id parameter specifies the unique ID of the broadcast that is being bound to a video stream. (required)
- part: string, The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. (required)
- onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
- streamId: string, The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream.
-
-Returns:
- An object of the form:
-
- { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
- "status": { # The status object contains information about the event's status.
- "recordingStatus": "A String", # The broadcast's recording status.
- "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
- "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
- },
- "kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
- "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
- "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
- "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
- "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
- "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
- "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
- #
- #
- #
- # Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
- "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true.
- #
- #
- #
- # Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
- "monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
- "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
- "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
- "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints.
- #
- # You need to set this value to true if you intend to have a broadcast delay for your event.
- #
- # Note: This property cannot be updated once the broadcast is in the testing or live state.
- },
- },
- "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
- "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
- "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
- "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
- }
-
-
control(id, part, onBehalfOfContentOwner=None, displaySlate=None, offsetTimeMs=None)
-
Control the slate of the broadacast.
-
-Args:
- id: string, The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted. (required)
- part: string, The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. (required)
- onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
- displaySlate: boolean, The displaySlate parameter specifies whether to enable or disable the slate.
- offsetTimeMs: string, The offsetTimeMs parameter specifies a point in time in the video when the specified action (e.g. display a slate) is executed. The property value identifies a positive time offset, in milliseconds, from the beginning of the monitor stream. Though measured in milliseconds, the value is actually an approximation, and YouTube will act as closely as possible to that time. If not specified, it indicates that the action should be performed as soon as possible. If your broadcast stream is not delayed, then it should not be specified. However, if your broadcast stream is delayed, then the parameter can specify the time when the operation should be executed. See the Getting started guide for more details. Note: The offset is measured from the time that the testing phase began.
-
-Returns:
- An object of the form:
-
- { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
- "status": { # The status object contains information about the event's status.
- "recordingStatus": "A String", # The broadcast's recording status.
- "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
- "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
- },
- "kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
- "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
- "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
- "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
- "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
- "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
- "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
- #
- #
- #
- # Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
- "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true.
- #
- #
- #
- # Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
- "monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
- "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
- "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
- "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints.
- #
- # You need to set this value to true if you intend to have a broadcast delay for your event.
- #
- # Note: This property cannot be updated once the broadcast is in the testing or live state.
- },
- },
- "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
- "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
- "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
- "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
- }
-
-
delete(id, onBehalfOfContentOwner=None)
-
Deletes a broadcast.
-
-Args:
- id: string, The id parameter specifies the YouTube live broadcast ID for the resource that is being deleted. (required)
- onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
-
-
-
insert(part=None, body, onBehalfOfContentOwner=None)
-
Creates a broadcast.
-
-Args:
- part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
-
-The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
- "status": { # The status object contains information about the event's status.
- "recordingStatus": "A String", # The broadcast's recording status.
- "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
- "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
- },
- "kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
- "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
- "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
- "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
- "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
- "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
- "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
- #
- #
- #
- # Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
- "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true.
- #
- #
- #
- # Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
- "monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
- "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
- "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
- "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints.
- #
- # You need to set this value to true if you intend to have a broadcast delay for your event.
- #
- # Note: This property cannot be updated once the broadcast is in the testing or live state.
- },
- },
- "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
- "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
- "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
- "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
-}
-
- onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
-
-Returns:
- An object of the form:
-
- { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
- "status": { # The status object contains information about the event's status.
- "recordingStatus": "A String", # The broadcast's recording status.
- "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
- "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
- },
- "kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
- "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
- "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
- "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
- "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
- "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
- "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
- #
- #
- #
- # Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
- "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true.
- #
- #
- #
- # Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
- "monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
- "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
- "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
- "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints.
- #
- # You need to set this value to true if you intend to have a broadcast delay for your event.
- #
- # Note: This property cannot be updated once the broadcast is in the testing or live state.
- },
- },
- "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
- "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
- "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
- "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
- }
-
-
list(part, broadcastStatus=None, pageToken=None, mine=None, maxResults=None, id=None)
-
Returns a list of YouTube broadcasts that match the API request parameters.
-
-Args:
- part: string, The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. (required)
- broadcastStatus: string, The broadcastStatus parameter filters the API response to only include broadcasts with the specified status.
- Allowed values
- active - Return current live broadcasts.
- all - Return all broadcasts.
- completed - Return broadcasts that have already ended.
- upcoming - Return broadcasts that have not yet started.
- pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
- mine: boolean, The mine parameter can be used to instruct the API to only return broadcasts owned by the authenticated user. Set the parameter value to true to only retrieve your own broadcasts.
- maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are 0 to 50, inclusive. The default value is 5.
- id: string, The id parameter specifies a comma-separated list of YouTube broadcast IDs that identify the broadcasts being retrieved. In a liveBroadcast resource, the id property specifies the broadcast's ID.
-
-Returns:
- An object of the form:
-
- { # JSON template for list of broadcasts.
- "eventId": "A String", # Serialized EventId of the request which produced this response.
- "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
- "kind": "youtube#liveBroadcastList", # The type of the API response. For this operation, the value will be youtube#liveBroadcastList.
- "visitorId": "A String", # The visitorId identifies the visitor.
- "items": [ # A list of broadcasts that match the request criteria.
- { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
- "status": { # The status object contains information about the event's status.
- "recordingStatus": "A String", # The broadcast's recording status.
- "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
- "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
- },
- "kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
- "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
- "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
- "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
- "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
- "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
- "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
- #
- #
- #
- # Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
- "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true.
- #
- #
- #
- # Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
- "monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
- "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
- "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
- "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints.
- #
- # You need to set this value to true if you intend to have a broadcast delay for your event.
- #
- # Note: This property cannot be updated once the broadcast is in the testing or live state.
- },
- },
- "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
- "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
- "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
- "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
- },
- ],
- "etag": "A String", # The ETag of the response.
- "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
- "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the result set.
- "totalResults": 42, # The total number of results in the result set.
- "resultsPerPage": 42, # The number of results included in the API response.
- },
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
transition(broadcastStatus, id, part, onBehalfOfContentOwner=None)
-
Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream.
-
-Args:
- broadcastStatus: string, The broadcastStatus parameter identifies the state to which the broadcast is changing. (required)
- Allowed values
- complete - The broadcast is over. YouTube stops transmitting video.
- live - The broadcast is visible to its audience. YouTube transmits video to the broadcast's monitor stream and its broadcast stream.
- testing - Start testing the broadcast. YouTube transmits video to the broadcast's monitor stream. Note that you can only transition a broadcast to the testing state if its contentDetails.monitorStream.enableMonitorStream property is set to true.
- id: string, The id parameter specifies the unique ID of the broadcast that is transitioning to another status. (required)
- part: string, The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. (required)
- onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
-
-Returns:
- An object of the form:
-
- { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
- "status": { # The status object contains information about the event's status.
- "recordingStatus": "A String", # The broadcast's recording status.
- "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
- "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
- },
- "kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
- "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
- "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
- "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
- "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
- "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
- "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
- #
- #
- #
- # Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
- "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true.
- #
- #
- #
- # Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
- "monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
- "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
- "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
- "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints.
- #
- # You need to set this value to true if you intend to have a broadcast delay for your event.
- #
- # Note: This property cannot be updated once the broadcast is in the testing or live state.
- },
- },
- "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
- "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
- "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
- "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
- }
-
-
update(part=None, body, onBehalfOfContentOwner=None)
-
Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.
-
-Args:
- part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
-
-The part properties that you can include in the parameter value are id, snippet, contentDetails, and status.
-
-Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
- "status": { # The status object contains information about the event's status.
- "recordingStatus": "A String", # The broadcast's recording status.
- "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
- "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
- },
- "kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
- "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
- "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
- "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
- "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
- "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
- "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
- #
- #
- #
- # Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
- "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true.
- #
- #
- #
- # Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
- "monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
- "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
- "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
- "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints.
- #
- # You need to set this value to true if you intend to have a broadcast delay for your event.
- #
- # Note: This property cannot be updated once the broadcast is in the testing or live state.
- },
- },
- "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
- "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
- "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
- "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
-}
-
- onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
-
-Returns:
- An object of the form:
-
- { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
- "status": { # The status object contains information about the event's status.
- "recordingStatus": "A String", # The broadcast's recording status.
- "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
- "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
- },
- "kind": "youtube#liveBroadcast", # The kind, fixed to "youtube#liveBroadcast".
- "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
- "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
- "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
- "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
- "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
- "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
- "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
- #
- #
- #
- # Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.
- "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true.
- #
- #
- #
- # Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.
- "monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.
- "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.
- "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream.
- "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints.
- #
- # You need to set this value to true if you intend to have a broadcast delay for your event.
- #
- # Note: This property cannot be updated once the broadcast is in the testing or live state.
- },
- },
- "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time.
- "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.
- "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
- "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast.
- }
-
Instance Methods
-
- delete(id)
-Deletes a video stream.
-
- insert(part=None, body)
-Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience.
-
- list(part, pageToken=None, mine=None, maxResults=None, id=None)
-Returns a list of video streams that match the API request parameters.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- update(part=None, body)
-Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings.
-Method Details
-
-
delete(id)
-
Deletes a video stream.
-
-Args:
- id: string, The id parameter specifies the YouTube live stream ID for the resource that is being deleted. (required)
-
-
-
insert(part=None, body)
-
Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience.
-
-Args:
- part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
-
-The part properties that you can include in the parameter value are id, snippet, cdn, and status. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A live stream describes a live ingestion point.
- "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
- "streamStatus": "A String",
- },
- "kind": "youtube#liveStream", # The kind, fixed to "youtube#liveStream".
- "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- },
- "cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
- "ingestionType": "A String", # The method or protocol used to transmit the video stream.
- "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.
- "backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.
- "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
- #
- # Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:
- #
- # STREAM_URL/STREAM_NAME
- },
- "format": "A String", # The format of the video stream that you are sending to Youtube.
- },
- "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
- "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
- }
-
-
-Returns:
- An object of the form:
-
- { # A live stream describes a live ingestion point.
- "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
- "streamStatus": "A String",
- },
- "kind": "youtube#liveStream", # The kind, fixed to "youtube#liveStream".
- "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- },
- "cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
- "ingestionType": "A String", # The method or protocol used to transmit the video stream.
- "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.
- "backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.
- "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
- #
- # Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:
- #
- # STREAM_URL/STREAM_NAME
- },
- "format": "A String", # The format of the video stream that you are sending to Youtube.
- },
- "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
- "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
- }
-
-
list(part, pageToken=None, mine=None, maxResults=None, id=None)
-
Returns a list of video streams that match the API request parameters.
-
-Args:
- part: string, The part parameter specifies a comma-separated list of one or more liveStream resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, cdn, and status. (required)
- pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
- mine: boolean, The mine parameter can be used to instruct the API to only return streams owned by the authenticated user. Set the parameter value to true to only retrieve your own streams.
- maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are 0 to 50, inclusive. The default value is 5.
- id: string, The id parameter specifies a comma-separated list of YouTube stream IDs that identify the streams being retrieved. In a liveStream resource, the id property specifies the stream's ID.
-
-Returns:
- An object of the form:
-
- { # List of live streams.
- "eventId": "A String", # Serialized EventId of the request which produced this response.
- "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
- "kind": "youtube#liveStreamList", # The type of the API response. For this operation, the value will be youtube#liveStreamList.
- "visitorId": "A String", # The visitorId identifies the visitor.
- "items": [ # A list of live streams that match the request criteria.
- { # A live stream describes a live ingestion point.
- "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
- "streamStatus": "A String",
- },
- "kind": "youtube#liveStream", # The kind, fixed to "youtube#liveStream".
- "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- },
- "cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
- "ingestionType": "A String", # The method or protocol used to transmit the video stream.
- "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.
- "backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.
- "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
- #
- # Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:
- #
- # STREAM_URL/STREAM_NAME
- },
- "format": "A String", # The format of the video stream that you are sending to Youtube.
- },
- "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
- "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
- },
- ],
- "etag": "A String", # The ETag of the response.
- "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
- "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the result set.
- "totalResults": 42, # The total number of results in the result set.
- "resultsPerPage": 42, # The number of results included in the API response.
- },
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
update(part=None, body)
-
Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings.
-
-Args:
- part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
-
-The part properties that you can include in the parameter value are id, snippet, cdn, and status.
-
-Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. If the request body does not specify a value for a mutable property, the existing value for that property will be removed. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A live stream describes a live ingestion point.
- "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
- "streamStatus": "A String",
- },
- "kind": "youtube#liveStream", # The kind, fixed to "youtube#liveStream".
- "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- },
- "cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
- "ingestionType": "A String", # The method or protocol used to transmit the video stream.
- "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.
- "backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.
- "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
- #
- # Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:
- #
- # STREAM_URL/STREAM_NAME
- },
- "format": "A String", # The format of the video stream that you are sending to Youtube.
- },
- "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
- "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
- }
-
-
-Returns:
- An object of the form:
-
- { # A live stream describes a live ingestion point.
- "status": { # Brief description of the live stream status. # The status object contains information about live stream's status.
- "streamStatus": "A String",
- },
- "kind": "youtube#liveStream", # The kind, fixed to "youtube#liveStream".
- "contentDetails": { # Detailed settings of a stream. # The content_details object contains information about the stream, including the closed captions ingestion URL.
- "closedCaptionsIngestionUrl": "A String", # The ingestion URL where the closed captions of this stream are sent.
- },
- "cdn": { # Brief description of the live stream cdn settings. # The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.
- "ingestionType": "A String", # The method or protocol used to transmit the video stream.
- "ingestionInfo": { # Describes information necessary for ingesting an RTMP or an HTTP stream. # The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.
- "backupIngestionAddress": "A String", # The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.
- "streamName": "A String", # The HTTP or RTMP stream name that YouTube assigns to the video stream.
- "ingestionAddress": "A String", # The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL.
- #
- # Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format:
- #
- # STREAM_URL/STREAM_NAME
- },
- "format": "A String", # The format of the video stream that you are sending to Youtube.
- },
- "snippet": { # The snippet object contains basic details about the stream, including its channel, title, and description.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.
- "description": "A String", # The stream's description. The value cannot be longer than 10000 characters.
- "publishedAt": "A String", # The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "title": "A String", # The stream's title. The value must be between 1 and 128 characters long.
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube assigns to uniquely identify the stream.
- }
-
Instance Methods
-
- delete(id)
-Deletes a playlist item.
-
- insert(part=None, body)
-Adds a resource to a playlist.
-
- list(part=None, pageToken=None, playlistId=None, videoId=None, maxResults=None, id=None)
-Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- update(part=None, body)
-Modifies a playlist item. For example, you could update the item's position in the playlist.
-Method Details
-
-
delete(id)
-
Deletes a playlist item.
-
-Args:
- id: string, The id parameter specifies the YouTube playlist item ID for the playlist item that is being deleted. In a playlistItem resource, the id property specifies the playlist item's ID. (required)
-
-
-
insert(part=None, body)
-
Adds a resource to a playlist.
-
-Args:
- part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
-
-The part names that you can include in the parameter value are snippet and contentDetails. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist.
- #
- # YouTube uses playlists to identify special collections of videos for a channel, such as:
- # - uploaded videos
- # - favorite videos
- # - positively rated (liked) videos
- # - watch history
- # - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information.
- #
- # You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel.
- "status": { # Information about the playlist item's privacy status. # The status object contains information about the playlist item's privacy status.
- "privacyStatus": "A String", # This resource's privacy status.
- },
- "kind": "youtube#playlistItem", # The kind, fixed to "youtube#playlistItem".
- "contentDetails": { # The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video.
- "note": "A String", # A user-generated note for this item.
- "startAt": "A String", # The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0.
- "endAt": "A String", # The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request.
- },
- "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist item, such as its title and position in the playlist.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the playlist that the playlist item is in.
- "description": "A String", # The item's description.
- "title": "A String", # The item's title.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the user that added the item to the playlist.
- "publishedAt": "A String", # The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "channelTitle": "A String", # Channel title for the channel that the playlist item belongs to.
- "position": 42, # The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the playlist item.
- }
-
-
-Returns:
- An object of the form:
-
- { # A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist.
- #
- # YouTube uses playlists to identify special collections of videos for a channel, such as:
- # - uploaded videos
- # - favorite videos
- # - positively rated (liked) videos
- # - watch history
- # - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information.
- #
- # You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel.
- "status": { # Information about the playlist item's privacy status. # The status object contains information about the playlist item's privacy status.
- "privacyStatus": "A String", # This resource's privacy status.
- },
- "kind": "youtube#playlistItem", # The kind, fixed to "youtube#playlistItem".
- "contentDetails": { # The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video.
- "note": "A String", # A user-generated note for this item.
- "startAt": "A String", # The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0.
- "endAt": "A String", # The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request.
- },
- "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist item, such as its title and position in the playlist.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the playlist that the playlist item is in.
- "description": "A String", # The item's description.
- "title": "A String", # The item's title.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the user that added the item to the playlist.
- "publishedAt": "A String", # The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "channelTitle": "A String", # Channel title for the channel that the playlist item belongs to.
- "position": 42, # The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the playlist item.
- }
-
-
list(part=None, pageToken=None, playlistId=None, videoId=None, maxResults=None, id=None)
-
Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs.
-
-Args:
- part: string, The part parameter specifies a comma-separated list of one or more playlistItem resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails.
-
-If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set part=snippet, the API response will contain all of those properties. (required)
- pageToken: string, USE_DESCRIPTION --- channels:list:pageToken
- playlistId: string, The playlistId parameter specifies the unique ID of the playlist for which you want to retrieve playlist items. Note that even though this is an optional parameter, every request to retrieve playlist items must specify a value for either the id parameter or the playlistId parameter.
- videoId: string, The videoId parameter specifies that the request should return only the playlist items that contain the specified video.
- maxResults: integer, USE_DESCRIPTION --- channels:list:maxResults
- id: string, The id parameter specifies a comma-separated list of one or more unique playlist item IDs.
-
-Returns:
- An object of the form:
-
- { # A paginated list of playlist items returned as the response to a youtube.playlistItems.list call.
- "eventId": "A String", # Serialized EventId of the request which produced this response.
- "nextPageToken": "A String", # A token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
- "kind": "youtube#playlistItemListResponse", # The type of the API response. For this operation, the value will be youtube#playlistItemListResponse.
- "visitorId": "A String", # The visitorId identifies the visitor.
- "items": [ # A list of playlist items that match the request criteria.
- { # A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist.
- #
- # YouTube uses playlists to identify special collections of videos for a channel, such as:
- # - uploaded videos
- # - favorite videos
- # - positively rated (liked) videos
- # - watch history
- # - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information.
- #
- # You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel.
- "status": { # Information about the playlist item's privacy status. # The status object contains information about the playlist item's privacy status.
- "privacyStatus": "A String", # This resource's privacy status.
- },
- "kind": "youtube#playlistItem", # The kind, fixed to "youtube#playlistItem".
- "contentDetails": { # The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video.
- "note": "A String", # A user-generated note for this item.
- "startAt": "A String", # The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0.
- "endAt": "A String", # The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request.
- },
- "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist item, such as its title and position in the playlist.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the playlist that the playlist item is in.
- "description": "A String", # The item's description.
- "title": "A String", # The item's title.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the user that added the item to the playlist.
- "publishedAt": "A String", # The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "channelTitle": "A String", # Channel title for the channel that the playlist item belongs to.
- "position": 42, # The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the playlist item.
- },
- ],
- "etag": "A String", # The ETag for the response.
- "prevPageToken": "A String", # A token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
- "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the result set.
- "totalResults": 42, # The total number of results in the result set.
- "resultsPerPage": 42, # The number of results included in the API response.
- },
- }
-
-
list_next(previous_request, previous_response)
-
Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-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.
-
-
-
update(part=None, body)
-
Modifies a playlist item. For example, you could update the item's position in the playlist.
-
-Args:
- part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
-
-The part names that you can include in the parameter value are snippet and contentDetails.
-
-Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist item can specify a start time and end time, which identify the times portion of the video that should play when users watch the video in the playlist. If your request is updating a playlist item that sets these values, and the request's part parameter value includes the contentDetails part, the playlist item's start and end times will be updated to whatever value the request body specifies. If the request body does not specify values, the existing start and end times will be removed and replaced with the default settings. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist.
- #
- # YouTube uses playlists to identify special collections of videos for a channel, such as:
- # - uploaded videos
- # - favorite videos
- # - positively rated (liked) videos
- # - watch history
- # - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information.
- #
- # You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel.
- "status": { # Information about the playlist item's privacy status. # The status object contains information about the playlist item's privacy status.
- "privacyStatus": "A String", # This resource's privacy status.
- },
- "kind": "youtube#playlistItem", # The kind, fixed to "youtube#playlistItem".
- "contentDetails": { # The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video.
- "note": "A String", # A user-generated note for this item.
- "startAt": "A String", # The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0.
- "endAt": "A String", # The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request.
- },
- "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist item, such as its title and position in the playlist.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the playlist that the playlist item is in.
- "description": "A String", # The item's description.
- "title": "A String", # The item's title.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the user that added the item to the playlist.
- "publishedAt": "A String", # The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "channelTitle": "A String", # Channel title for the channel that the playlist item belongs to.
- "position": 42, # The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the playlist item.
- }
-
-
-Returns:
- An object of the form:
-
- { # A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist.
- #
- # YouTube uses playlists to identify special collections of videos for a channel, such as:
- # - uploaded videos
- # - favorite videos
- # - positively rated (liked) videos
- # - watch history
- # - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information.
- #
- # You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel.
- "status": { # Information about the playlist item's privacy status. # The status object contains information about the playlist item's privacy status.
- "privacyStatus": "A String", # This resource's privacy status.
- },
- "kind": "youtube#playlistItem", # The kind, fixed to "youtube#playlistItem".
- "contentDetails": { # The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video.
- "note": "A String", # A user-generated note for this item.
- "startAt": "A String", # The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0.
- "endAt": "A String", # The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request.
- },
- "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist item, such as its title and position in the playlist.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the playlist that the playlist item is in.
- "description": "A String", # The item's description.
- "title": "A String", # The item's title.
- "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item.
- "kind": "A String", # The type of the API resource.
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
- "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
- },
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the user that added the item to the playlist.
- "publishedAt": "A String", # The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "channelTitle": "A String", # Channel title for the channel that the playlist item belongs to.
- "position": 42, # The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- },
- "etag": "A String", # Etag of this resource.
- "id": "A String", # The ID that YouTube uses to uniquely identify the playlist item.
- }
-
Instance Methods
-
- delete(id)
-Deletes a playlist.
-
- insert(part=None, body)
-Creates a playlist.
-
- list(part=None, pageToken=None, channelId=None, mine=None, maxResults=None, id=None)
-Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
-
- update(part=None, body)
-Modifies a playlist. For example, you could change a playlist's title, description, or privacy status.
-Method Details
-
-
delete(id)
-
Deletes a playlist.
-
-Args:
- id: string, The id parameter specifies the YouTube playlist ID for the playlist that is being deleted. In a playlist resource, the id property specifies the playlist's ID. (required)
-
-
-
insert(part=None, body)
-
Creates a playlist.
-
-Args:
- part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
-
-The part names that you can include in the parameter value are snippet and status. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private.
- #
- # YouTube also uses playlists to identify special collections of videos for a channel, such as:
- # - uploaded videos
- # - favorite videos
- # - positively rated (liked) videos
- # - watch history
- # - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel.
- #
- # You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.
- "status": { # The status object contains status information for the playlist.
- "privacyStatus": "A String", # The playlist's privacy status.
- },
- "kind": "youtube#playlist", # The kind, fixed to "youtube#playlist".
- "contentDetails": { # The contentDetails object contains information like video count.
- "itemCount": 42, # The number of videos in the playlist.
- },
- "snippet": { # Basic details about a playlist, including title, description and thumbnails. # The snippet object contains basic details about the playlist, such as its title and description.
- "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
- "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
- "url": "A String", # The thumbnail image's URL.
- "width": 42, # (Optional) Width of the thumbnail image.
- "height": 42, # (Optional) Height of the thumbnail image.
- },
- },
- "tags": [ # Keyword tags associated with the playlist.
- "A String",
- ],
- "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the playlist.
- "publishedAt": "A String", # The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
- "channelTitle": "A String", # The channel title of the channel that the video belongs to.
- "title": "A String", # The playlist's title.
- "description": "A String", # The playlist's description.
- },
- "player": { # The player object contains information that you would use to play the playlist in an embedded player.
- "embedHtml": "A String", # An